This documentation page contains information common for the following endpoints:

• POST authorization/direct-invoice
• POST authorization/loan
• POST authorization/invoice
• POST authorization/part-payment

Most request properties are shared across all these endpoints. These common properties are listed in the Request Common Properties section. Additional endpoint-specific properties are detailed in their respective sections.

All endpoints return the same response objects, which are documented in the Responses section.

Request Common Properties

Customer

Address

Item

Responses

The format of the response HTTP status and the response body depends on the outcome of the credit decision - see Flow Details

201 Created - Credit Approved - ID Validation Not Required

See Flow Details step 3a

Example

{
    "creditLimit": 2000.0,
    "forced": false,
    "authorizationId": "e3c7b22b65654afba1d3efee814c59c2"
}

202 Accepted - Credit Approved - ID Validation Required

See Flow Details Main Flow

Example

{
    "redirectUrl": "https://idp-bankid.avarda.com/connect/authorize?response_type=code&state=9xRGFeJgNuJ_RdP-MsbHlw&code_challenge=8WbbgCdreGpC962E6tvEtJLP4UdNao5V7WStfFsIpnM&code_challenge_method=S256&client_id=auth-api&scope=openid%20profile&redirect_uri=https%3A%2F%2Flocalhost%3A5001%2Fidcallback%2Fbankidswe&login_hint=198808183092&ui_locales=fi&authorization_id=6a23a60d-f59e-4dcc-871a-0ca7fd294590",
    "forced": false,
    "authorizationId": "6a23a60df59e4dcc871a0ca7fd294590"
}

400 Bad Request - Invalid Request Data

See Flow Details step 2a

The response is in a standard RFC 9457 (opens in a new tab) format and contains list of validation errors in plain English. Note that it is expected that the Partner validates the data on its own UI. The validation on Authorization API is provided as a safeguard of the last resort and the validation messages are intended as a hint for the developers - therefore they are not localized into the Customer language.

Example

{
    "errors": {
        "Customer.Email": [
            "Email is not a valid email address."
        ],
        "Customer.Phone": [
            "Phone is not a valid phone number."
        ]
    },
    "type": "https://tools.ietf.org/html/rfc9110#section-15.5.1",
    "title": "One or more validation errors occurred.",
    "status": 400,
    "traceId": "00-aaa3b6e163636ad193bbb9dd3f81e74e-0b08a01eae50f098-01"
}

422 Unprocessable Entity - Credit Authorization Rejected

See Flow Details step 3b

Example

{
    "errorCode": 2,
    "errorMessage": "Credit not approved please try different payment method",
    "authorizationId": "3b2309d4565446b1996dcb92fe40f332"
}

List of Errors

The ErrorMessage provides a hint as to why the credit was rejected. The ErrorCode further narrows down the reason; however, this code is only meaningful to Avarda. If you need to investigate a particular rejected authorization, pass the code to Avarda support for assistance.

500 Internal Server Error - Technical Error

See Flow Details step 3c

Example

{
    "errorCode": 101,
    "errorMessage": "Service internal error, please try later or contact the support desk",
    "authorizationId": "ddaf5c6caec841c9a1c7d60256af32eb"
}