POST /authorization/invoice

The method authorizes an monthly invoices. All customers who purchase for this partner, this period are charged on one invoice. Credit decision is based on provided parameters and if approved returns authorizationID. If Electronic ID validation is required the function will respond only with purchaseid and a flag that electronicID validation is required.

• Authenticate via oAuth2 to api oaut2/token using your ClientID/ClientSecret received from Avarda.
• Token needs to be sent as Bearer Token in the following requests.
• Post authorization request to Avarda Authorization API Invoice
• Check HTTP response:
  • 201 – Credit request approved by Avarda. Continue and fulfill order on partner side.
  • 202- Credit request requires strong auth. Redirect to Electronic ID validation.
  • 400 – Request has bad format or some of its data did not pass validation.
  • 422 – Credit request was denied.
• If HTTP Response 202 – Strong Auth is REQUIRED:
  • Check response – if http response is 202 then electronic ID validation/strong auth is required. Response contains authorizationID and redirect url.
  • Redirect user to Avarda strong auth service defined in the redirect url.
  • After electronicID validation/strong auth is successful then Avarda redirects user back to a partner URL with additional query parameters ?authorizationId={guid}&orderId={your-ref}
  • Example: https://yourreturnurl.com/?authorizationId=5a89a013d07d4bb78b07f91ee4642d39&orderId=2MX323 (opens in a new tab)
• Partner needs to check status after redirect back from Avarda to verify credit request via api /authorization/{id}. If status approved then it is ok fulfill the order.
• On delivery – post request to Order and charge customer.
• If return – post request to Return and credit customer.
• If cancel – post request to Cancel to remove credit reservation

Redirect after completed ID validation

The callback URL has a following format

https://{partner-provided-callback-url}?authorizationId={authorization-id}?orderId={orderId} – for successfully completed ID validation

https://{partner-provided-callback-url}?authorizationId={authorization-id}&orderId={orderId}&errorCode={error-code} – for failed ID validation

Partner callback URL is specified in the partner site configuration. This value can be however optionally overridden by specifying the callback URL in the credit request idValidationCallbackUrl input parameter.

Error codes are following:

50: User did not complete ID validation in time – there is a 30 minutes timeout on waiting for user to complete the validation

51: User failed ID Validation with the identity provider – this is typically when the user cancel the validation on the identity provider UI or the identity provider returns another provider specific error

52: During ID validation the user authenticated with a SSN different than the one in the original credit request

53: Newer request with the same parameters arrived, processing newer one, cancelling this one – this happens if a new credit authorization request with same parameters is received while the current one is waiting for ID validation completion

As the callback can be faked the partner should treat it merely as a notification and verify the result by calling GET authorization/{authorization-id}. This will also provide the localized description of the error in addition to the error code.

Input Parameters

Example request

{
  "customer": {
    "identificationNumber": "string",
    "userLanguageCode": 208,
    "phone": "string",
    "email": "string"
  },
  "invoicingAddress": {
    "firstName": "string",
    "lastName": "string",
    "addressLine1": "string",
    "addressLine2": "string",
    "city": "string",
    "zip": "string"
  },
  "deliveryAddress": {
    "firstName": "string",
    "lastName": "string",
    "addressLine1": "string",
    "addressLine2": "string",
    "city": "string",
    "zip": "string",
    "country": "string"
  },
  "useDifferentDeliveryAddress": true,
  "items": [
    {
      "description": "string",
      "notes": "string",
      "amount": 0,
      "taxCode": "string",
      "taxAmount": 0,
      "productGroup": "string"
    }
  ],
  "orderReference": "string",
  "posId": "string",
  "description": "string",
  "emailInvoice": true,
  "loyaltyNumber": "string"
}

Output parameters

Return Http 201 – No extra electronicID validation is required. Process is Done.

Output parameters Example

{
  "authorizationId": "d736dd5fea853b18a30fd2413ebfcab5",
  "CreditLimit": 4000
}

Return Http 202 – Extra electroniID validation is required.

Output parameters Example

{
  "authorizationId": "string",
  "redirectUrl": "string"
}

Redirect user to ID validation

Redirect user to redirectURL in the authorization response where ElectronicID validation is performed.

Callback Success

https://yourreturnurl.com/?externalId=d736dd5fea853b18a30fd2413ebfcab5&status=OK (opens in a new tab)

Merchant: calls /authorization/{id} to check status and if Completed then fulfill the order.

Callback Failed

https://yourreturnurl.com/?externalId=d736dd5fea853b18a30fd2413ebfcab5&status=Cancel (opens in a new tab)

Merchant: offer other payment method or try electronic id validation again.

Return HTTP 422 – Credit not approved Error messages

{
  "authorizationId": "string",
  "errorCode": 0,
  "errorMessage": "string"
}

Return HTTP 400 – Bad request format or data validation did not pass

{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "extensions": {},
  "errors": {
    "additionalProp1": ["string"],
    "additionalProp2": ["string"],
    "additionalProp3": ["string"]
  }
}