Problems

Problems

When performing operations against a resource in the Swedbank Pay API Platform, it will respond with a problem message that contain details of the error type if the request could not be successfully performed. Regardless of why the error occurred, the problem message will follow the same structure as specified in the Problem Details for HTTP APIs (RFC 7807) specification.

We generally use the problem message type and status code to identify the nature of the problem. The problems array contains objects with name and description that will often help narrow down the specifics of the problem, usually to the field in the request that was missing or contained invalid data.

The structure of a problem message will look like this:

Problem Example

1
2
3
4
5
6
7
8
9
10
11

{
    "type": "https://api.payex.com/psp/errordetail/<resource>/inputerror",
    "title": "There was an input error",
    "detail": "Please correct the errors and retry the request",
    "instance": "ec2a9b09-601a-42ae-8e33-a5737e1cf177",
    "status": 400,
    "problems": [{
        "name": "CreditCardParameters.Issuer",
        "description": "minimum one issuer must be enabled"
    }]
}

Common Problems

All common problem types will have a URL in the format https://api.payex.com/psp/errordetail/<error-type>. The URL is an identifier that you can hard-code and implement logic around. It is currently not not possible to dereference this URL, although that might be possible in the future.

Token Problems

We will be making a change in the error messages that are given in response in the eCommerce API if the requested Payment/One-Click/Recur/Unscheduled token does not exist or is deleted.

The following new errorType will be introduced (only for Payment Order): https://api.payex.com/psp/errordetail/paymentorders/paymenttokeninactive

In addition to the one currently in use for both Payment Instruments and Payment Order: https://api.payex.com/psp/errordetail/paymentorders/inputerror

First, a check is made to verify if the token exists or not. If it does not exist, the API returns an error of the type InputError. If, however, the token exists but is deleted, the API will return the error TokenInactive.

Examples of the error messages are presented below.

InputError

InputError for a RecurrenceToken:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15

{
   "type":"https://api.payex.com/psp/errordetail/paymentorders/inputerror",
   "title":"Error in input data",
   "status":404,
   "instance":"https://api.payex.com/psp/probleminstance/00-e53deef0eb5e47bcb5ba1739bdd9086c-
    b5512dfc02b74f07-01",
   "detail":"Input validation failed, error description in problems node!",
   "problems":
   [
      {
         "name":"RecurrenceToken",
         "description":"The given RecurrenceToken does not exist."
      }
   ]
}

TokenInactive

TokenInactive example with UnscheduledToken:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15

{
    "type": "https://api.payex.com/psp/errordetail/paymentorders/paymenttokeninactive",
    "title": "Payment token is inactive",
    "status": 422,
    "instance": "https://api.payex.com/psp/probleminstance/00-2fc18bd40743401596bf2de3b51ab16d-
     bfebd4ae81ea8423-01",
    "detail": "The given UnscheduledToken is inactive.",
    "problems":
     [
       {
           "name": "UnscheduledToken",
           "description": "The given UnscheduledToken is inactive."
        }
    ]
}

TokenInactive example with a RecurrenceToken:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15

{
    "type": "https://api.payex.com/psp/errordetail/paymentorders/paymenttokeninactive",
    "title": "Payment token is inactive",
    "status": 422,
    "instance": "https://api.payex.com/psp/probleminstance/00-2fc18bd40743401596bf2de3b51ab16d-
     bfebd4ae81ea8423-01",
    "detail": "The given RecurrenceToken is inactive.",
    "problems":
     [
       {
           "name": "UnscheduledToken",
           "description": "The given RecurrenceToken is inactive."
        }
    ]
}

If you have questions regarding the new error types, do not hesitate to contact us through the ordinary support channels.

Payment Details Problems

In order to use the new parameter EnablePaymentDetailsConsentCheckbox – which determines whether or not to show the checkbox used to save payment details – the DisableStoredPaymentDetails parameter must be set to true. Otherwise you will get a validation error.

1
2
3
4
5
6
7
8
9
10
11
12
13

{
    "type": "https://api.payex.com/psp/errordetail/paymentorders/inputerror",
    "title": "Error in input data",
    "status": 400,
    "instance": "https://api.payex.com/psp/probleminstance/00-f75cfaedb1eb467bbefd4917c67a7664-b25fb23de26682e9-01",
    "detail": "Input validation failed, error description in problems node!",
    "problems": [
        {
            "name": "PaymentOrder.EnablePaymentDetailsConsentCheckbox",
            "description": "EnablePaymentDetailsConsentCheckbox cannot be used without DisableStoredPaymentDetails."
        }
    ]
}

Card Problems

There are a few problems specific to the creditcard resource that you may want to guard against in your integrations. All credit card problem types will have the following URL structure:

https://api.payex.com/psp/errordetail/creditcard/<error-type>

Contractual Problem Types

Acquirer and 3-D Secure Problem Types

Creditcard Payments MIT - Do Not Try Again & Excessive Reattempts

In accordance with directives from Visa and Mastercard, we will be implementing 2 different types of limitations in the amount of successive reattempts of a previously failed transaction using either a recurrence- or unscheduledToken that can be done using card based payment instruments. This limitation has up until now been handled by Swedbank Pay Acquiring, but will now be handled earlier in the transaction process - enabling us to provide better and clearer response messages through the eCommerce-api.

To test these response messages, we have added new magic amounts in the test data section. The new amounts are for DAILYLIMITEXCEEDED, MONTHLYLIMITEXCEEDED, DONOTRETRY and MODIFICATIONSREQUIRED. SuspensionWarning can be tested by using the limit exceeded amounts.

One such limitation will be limiting the amount of successive reattempts of a previously failed transaction that can be done using creditcard based payment method within a specified period The limitation in question varies based on the card brand:

• MasterCard - 10 failed payment attempts allowed during a period of 24 hours.
• Visa - 15 failed payment attempts allowed during a period of 30 days.

Note that all of the attempts has to get a failed response to be added to the limit quota - if a transaction goes through successfully, the quota will reset.

The other limitation that will be implemented is in the case that Visa or Mastercard gives such a response that is flagged as “Do Not Retry” in accordance to Visa and MasterCard regulations. This response is given in the cases that they deem the transaction to never be possible to be valid - as an example, if the card no longer exists, and thus there is no point in retrying.

In these cases, the card will be blocked immediately and no further attempts are allowed.

Both of these limitations are based on the combination of the acquiring agreement that the transaction was initiated from, and the PAN of the card that was used. That is, a card might be blocked because of “Excessive Reattempts” at a particular merchant, while being allowed more reattempts at another. Please note that in the case a new card is issued in place of an old expired one, the new card usually keeps the same PAN - meaning that if the old card was blocked, the new one will be as well (until the period resets). This marks the importance of having such a logic in place that limits reattempts before the block actually takes place - this is where the new, clearer response messages will help.

When it comes to Excessive Reattempts, the new response messages will be returned if the quota for the period gets to 5 attempts remaining, as follows:

5 Attempts Remaining

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20

{
    "type": "https://api.payex.com/psp/errordetail/creditcard/suspensionwarning",
    "title": "SuspensionWarning. The card might be blocked.",
    "status": 403,
    "detail": "5 attempts left before the card is blocked.",
    "problems": [{
            "name": "ExternalResponse",
            "description": "Forbidden-AuthenticationRequired"
        }, {
            "name": "SuspensionWarning",
            "description": "5 attempts left before the card is blocked."
        }, {
            "name": "AUTHENTICATION_REQUIRED",
            "description": "Acquirer soft-decline, 3-D Secure authentication required, response-code: O5"
        }, {
            "name": "Component",
            "description": "pospay-ecommerce-financial-service"
        }
    ]
}

Should more attempts be tried, and the transaction fail, the number of remaining attempts will update accordingly. Once the card is blocked, the following responses will be given, depending on if the card in question is Visa or MasterCard:

MasterCard

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15

{
    "type": "https://api.payex.com/psp/errordetail/creditcard/dailylimitexceeded",
    "title": "Daily attempt limit is exceeded.",
    "status": 403,
    "detail": "The attempt is rejected after trying multiple times with same token.",
    "problems": [{
            "name": "REJECTED_BY_POSPAY_DAILY_LIMIT",
            "description": "Intent with intentId 85ac3576-1e69-4aef-a066-84a0e6dcfa61, agreementId 80d0244c-2b15-4719-8ab1-ed83eddfee61 was suspended after exceeding the rolling 24 hour constraint of 10 attempts"
        },
  {
            "name": "Component",
            "description": "pospay-ecommerce-financial-service"
        }
    ]
}

Visa

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15

{
    "type": "https://api.payex.com/psp/errordetail/creditcard/monthlylimitexceeded",
    "title": "Monthly attempt limit is exceeded.",
    "status": 403,
    "detail": "The attempt is rejected after trying multiple times with same token.",
    "problems": [{
            "name": "REJECTED_BY_POSPAY_MONTHLY_LIMIT",
            "description": "Intent with intentId 80456a1d-1cb1-429b-bf4e-8e1313362800, agreementId 3a47c702-7963-4915-9567-e1bce06d20dd was suspended after exceeding the rolling 30 day constraint of 15 attempts"
        },
  {
            "name": "Component",
            "description": "pospay-ecommerce-financial-service"
        }
    ]
}

The new responses for “Do Not Retry” will be as follows:

Blocked card, no further attempts allowed

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17

{
    "type": "https://api.payex.com/psp/errordetail/creditcard/acquirererrordonotretry",
    "title": "Do not retry.",
    "status": 403,
    "detail": "The attempt is rejected.",
    "problems": [{
            "name": "ExternalResponse",
            "description": "Forbidden-AcquirerErrorDoNotRetry"
        }, {
            "name": "REJECTED_BY_ACQUIRER_DO_NOT_RETRY",
            "description": "TOKEN04.ERR_FLG received in response, response-code: 05"
        }, {
            "name": "Component",
            "description": "pospay-ecommerce-financial-service"
        }
    ]
}

Furthermore, a new response is added, being returned in cases where the transaction is declined, but might be accepted after modifications:

Transaction declined, modifications required

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17

{
    "type": "https://api.payex.com/psp/errordetail/creditcard/acquirererrormodificationsrequired",
    "title": "Modifications required.",
    "status": 403,
    "detail": "The attempt is rejected. Modifications required.",
    "problems": [{
            "name": "ExternalResponse",
            "description": "Forbidden-AcquirerErrorModificationsRequired"
        }, {
            "name": "REJECTED_BY_ACQUIRER_MODIFICATIONS_REQUIRED",
            "description": "TOKEN04.ERR_FLG received in response, response-code: 05"
        }, {
            "name": "Component",
            "description": "pospay-ecommerce-financial-service"
        }
    ]
}

Invoice Problems

There are a few problems specific to the invoice resource that you may want to guard against in your integrations. All invoice error types will have the following URL structure:

https://api.payex.com/psp/errordetail/invoice/<error-type>

Swish Problems

There are a few problems specific to the swish resource that you may want to guard against in your integrations. All Swish problem types will have the following URL structure:

https://api.payex.com/psp/errordetail/<error-type>

bankidalreadyinuse

Caused By:

• The payer’s BankID is already in use

Example response bankidalreadyinuse

1
2
3
4
5
6
7
8
9
10
11

HTTP/1.1 409 Conflict
Content-Type: application/json

{
    "sessionId": "570ad610-3bd5-43d2-a270-ca1510562972",
    "type": "https://api.payex.com/psp/errordetail/bankidalreadyinuse",
    "title": "BankID Already in Use",
    "status": 409,
    "instance": "https://api.payex.com/psp/swish/payments/0cf55e0f-9931-476b-249d-08d7a3ee4e14/sales",
    "detail": "The payer's BankID is already in use."
}

bankidcancelled

Caused By:

• The payer cancelled BankID authorization.

Example response bankidcancelled

1
2
3
4
5
6
7
8
9
10
11

HTTP/1.1 409 Conflict
Content-Type: application/json

{
    "sessionId": "570ad610-3bd5-43d2-a270-ca1510562972",
    "type": "https://api.payex.com/psp/errordetail/bankidcancelled",
    "title": "BankID Authorization cancelled",
    "status": 409,
    "instance": "https://api.payex.com/psp/swish/payments/0cf55e0f-9931-476b-249d-08d7a3ee4e14/sales",
    "detail": "The payer cancelled BankID authorization."
}

bankiderror

Caused By:

• Something went wrong with the payer’s BankID authorization.

Example response bankiderror

1
2
3
4
5
6
7
8
9
10
11

HTTP/1.1 502 Bad Gateway
Content-Type: application/json

{
    "sessionId": "570ad610-3bd5-43d2-a270-ca1510562972",
    "type": "https://api.payex.com/psp/errordetail/bankiderror",
    "title": "BankID error",
    "status": 502,
    "instance": "https://api.payex.com/psp/swish/payments/0cf55e0f-9931-476b-249d-08d7a3ee4e14/sales",
    "detail": "Something went wrong with the payer's BankID authorization."
}

configerror

Caused By:

• Payee alias is missing or not correct.
• PaymentReference is invalid.
• Amount value is missing or not a valid number.
• Amount is less than agreed minimum.
• Amount value is too large.
• Invalid or missing currency.
• Wrong formatted message.
• Amount value is too large, or amount exceeds the amount of the original payment minus any previous refunds.
• Counterpart is not activated.
• Payee not enrolled.

Example response configerror

1
2
3
4
5
6
7
8
9
10
11

HTTP/1.1 403 Forbidden
Content-Type: application/json

{
    "sessionId": "570ad610-3bd5-43d2-a270-ca1510562972",
    "type": "https://api.payex.com/psp/errordetail/configerror",
    "title": "Config error",
    "status": 403,
    "instance": "https://api.payex.com/psp/swish/payments/0cf55e0f-9931-476b-249d-08d7a3ee4e14/sales",
    "detail": "Payee alias is missing or not correct."
}

inputerror

Caused By:

• MSISDN is invalid.
• Payer’s MSISDN is not enrolled at Swish.

Example response inputerror

1
2
3
4
5
6
7
8
9
10
11

HTTP/1.1 400 Bad Request
Content-Type: application/json

{
    "sessionId": "570ad610-3bd5-43d2-a270-ca1510562972",
    "type": "https://api.payex.com/psp/errordetail/inputerror",
    "title": "Input error",
    "status": 400,
    "instance": "https://api.payex.com/psp/swish/payments/0cf55e0f-9931-476b-249d-08d7a3ee4e14/sales",
    "detail": "Msisdn is invalid."
}

paymentagelimitnotmet

Caused By:

• The payer does not meet the payment’s age limit.

Example response paymentagelimitnotmet

1
2
3
4
5
6
7
8
9
10
11

HTTP/1.1 403 Forbidden
Content-Type: application/json

{
    "sessionId": "570ad610-3bd5-43d2-a270-ca1510562972",
    "type": "https://api.payex.com/psp/errordetail/paymentagelimitnotmet",
    "title": "Payment Age Limit Not Met",
    "status": 403,
    "instance": "https://api.payex.com/psp/swish/payments/0cf55e0f-9931-476b-249d-08d7a3ee4e14/sales",
    "detail": "The payer does not meet the payment's age limit."
}

socialsecuritynumbermismatch

Caused By:

• The payer’s social security number does not match with the one required by this payment.

Example response socialsecuritynumbermismatch

1
2
3
4
5
6
7
8
9
10
11

HTTP/1.1 403 Forbidden
Content-Type: application/json

{
    "sessionId": "570ad610-3bd5-43d2-a270-ca1510562972",
    "type": "https://api.payex.com/psp/errordetail/socialsecuritynumbermismatch",
    "title": "Social Security Number Mismatch",
    "status": 403,
    "instance": "https://api.payex.com/psp/swish/payments/0cf55e0f-9931-476b-249d-08d7a3ee4e14/sales",
    "detail": "The payer's social security number does not match with the one required by this payment."
}

swishalreadyinuse

Caused By:

• The payer’s Swish is already in use.

Example response swishalreadyinuse

1
2
3
4
5
6
7
8
9
10
11

HTTP/1.1 403 Forbidden
Content-Type: application/json

{
    "sessionId": "570ad610-3bd5-43d2-a270-ca1510562972",
    "type": "https://api.payex.com/psp/errordetail/swishalreadyinuse",
    "title": "Error in Swish",
    "status": 403,
    "instance": "https://api.payex.com/psp/swish/payments/0cf55e0f-9931-476b-249d-08d7a3ee4e14/sales",
    "detail": "The payer's Swish is already in use."
}

swishdeclined

Caused By:

• Original payment not found or original payment is more than than 13 months old.
• It appears that merchant’s organization number has changed since sale was made.
• The MSISDN of the original payer seems to have changed owner.
• Transaction declined. Could be that the payer has exceeded their swish limit or have insufficient founds.
• Payment request not cancellable.

Example response swishdeclined

1
2
3
4
5
6
7
8
9
10
11

HTTP/1.1 403 Forbidden
Content-Type: application/json

{
    "sessionId": "570ad610-3bd5-43d2-a270-ca1510562972",
    "type": "https://api.payex.com/psp/errordetail/swishdeclined",
    "title": "Swish Declined",
    "status": 403,
    "instance": "https://api.payex.com/psp/swish/payments/0cf55e0f-9931-476b-249d-08d7a3ee4e14/sales",
    "detail": "The MSISDN of the original payer seems to have changed owner."
}

swisherror

Caused By:

• Bank system processing error.
• Swish timed out waiting for an answer from the banks after payment was started.

Example response swisherror

1
2
3
4
5
6
7
8
9
10
11

HTTP/1.1 502 Bad Gateway
Content-Type: application/json

{
    "sessionId": "570ad610-3bd5-43d2-a270-ca1510562972",
    "type": "https://api.payex.com/psp/errordetail/swisherror",
    "title": "Error in Swish",
    "status": 502,
    "instance": "https://api.payex.com/psp/swish/payments/0cf55e0f-9931-476b-249d-08d7a3ee4e14/sales",
    "detail": "Bank system processing error."
}

swishgatewaytimeout

Caused By:

• During a create a sale call to e-com, Swish responded with 504 (Gateway Timeout).

Example response swishgatewaytimeout

1
2
3
4
5
6
7
8
9
10
11

HTTP/1.1 504 Gateway Timeout
Content-Type: application/json

{
    "sessionId": "570ad610-3bd5-43d2-a270-ca1510562972",
    "type": "https://api.payex.com/psp/errordetail/swishgatewaytimeout",
    "title": "Swish Gateway Timeout",
    "status": 504,
    "instance": "https://api.payex.com/psp/swish/payments/0cf55e0f-9931-476b-249d-08d7a3ee4e14/sales",
    "detail": "Request to Swish timed out."
}

swishtimeout

Caused By:

• Swish timed out before the payment was started.

Example response swishtimeout

1
2
3
4
5
6
7
8
9
10
11

HTTP/1.1 403 Forbidden
Content-Type: application/json

{
    "sessionId": "570ad610-3bd5-43d2-a270-ca1510562972",
    "type": "https://api.payex.com/psp/errordetail/swishtimeout",
    "title": "Swish Timed Out",
    "status": 403,
    "instance": "https://api.payex.com/psp/swish/payments/0cf55e0f-9931-476b-249d-08d7a3ee4e14/sales",
    "detail": "Swish timed out before the payment was started."
}

systemerror

Example response systemerror

1
2
3
4
5
6
7
8
9
10
11

HTTP/1.1 500 Internal Server Error
Content-Type: application/json

{
    "sessionId": "570ad610-3bd5-43d2-a270-ca1510562972",
    "type": "https://api.payex.com/psp/errordetail/systemerror",
    "title": "Error in System",
    "status": 500,
    "instance": "https://api.payex.com/psp/swish/payments/0cf55e0f-9931-476b-249d-08d7a3ee4e14/sales",
    "detail": "A system error occurred. We are working on it."
}

usercancelled

Caused By:

• The payer cancelled the payment in the Swish app.

Example response usercancelled

1
2
3
4
5
6
7
8
9
10
11

HTTP/1.1 403 Forbidden
Content-Type: application/json

{
    "sessionId": "570ad610-3bd5-43d2-a270-ca1510562972",
    "type": "https://api.payex.com/psp/errordetail/usercancelled",
    "title": "User cancelled",
    "status": 403,
    "instance": "https://api.payex.com/psp/swish/payments/0cf55e0f-9931-476b-249d-08d7a3ee4e14/sales",
    "detail": "The payer cancelled the payment in the Swish app."
}

Trustly Problems

There are a few problems specific to the trustly resource that you may want to guard against in your integrations. All Trustly problem types will have the following URL structure:

https://api.payex.com/psp/errordetail/trustly/<error-type>

Vipps Problems

There are a few problems specific to the vipps resource that you may want to guard against in your integrations. All Vipps problem types will have the following URL structure:

https://api.payex.com/psp/errordetail/vipps/<error-type>

Problem Types from Vipps (Init-call)

Problem Types from Vipps (Callback)

Problem Types from Acquirer