Errors

Common HTTP error codes returned by the Checkout APIs and their meaning.

Error responses have the same overall structure across Checkout APIs. General errors, such as ResourceNotFound are returned for all APIs. API-specific errors, are only returned for specific endpoints.

General errors

400 Bad Request -RequiredField

404 Not Found -ResourceNotFound

500 Internal Server Error -GeneralError

400 Bad Request

The following error code can appear in responses with the HTTP status code 400:

RequiredField

Returned when a value is not defined for a required field.

`code` String	`"RequiredField"`
`message` String	`"A value is required for field $field."`
`field` String	Name of the field missing the value.

404 Not Found

The following error code can appear in responses with the HTTP status code 404:

ResourceNotFound

Returned when the resource addressed by the request URL does not exist.

`code` String	`"ResourceNotFound"`
`message` String	`"The Resource with ID $resourceId was not found."`

500 Internal Server Error

The following general error code can appear in responses with the HTTP status code 500:

GeneralError

Returned when a server-side problem occurs. In some cases, the requested action may successfully complete after the error is returned. Therefore, it is recommended to verify the status of the requested resource after receiving a 500 error.

If you encounter this error, report it to the Checkout support team.

`code` String	`"General"`
`message` String	Description about any known details of the problem, for example, `"Write operations are temporarily unavailable"`.

API-specific errors

Payment Intents

400 Bad Request -MultipleActionsNotAllowed

400 Bad Request

The following error codes can appear in responses with the HTTP status code 400:

MultipleActionsNotAllowed

Returned when actions in the request body contains more than one object.

`code` String	`"MultipleActionsNotAllowed"`
`message` String	`"Actions accepts only one action at time. Array size must be 1."`

Transactions

400 Bad Request -InvalidInput -InvalidJsonInput

502 Bad Gateway -ConnectorFailed -PaymentFailure

400 Bad Request

The following error codes can appear in responses with the HTTP status code 400:

InvalidInput

Returned when input is not valid.

`code` String	`"InvalidInput"`
`message` String	Description of the invalid input error.

InvalidJsonInput

Returned when an invalid JSON input has been sent. Either the JSON is syntactically incorrect or does not conform to the expected shape, for example, it is missing a required field.

The client application should validate the input according to the constraints described in the error message before sending the request.

`code` String	`"InvalidJsonInput"`
`message` String	`"Request body does not contain valid JSON."`
`detailedErrorMessage` String	Further explanation about why the JSON is invalid.

502 Bad Gateway

The following error codes can appear in responses with the HTTP status code 502:

ConnectorFailed

Returned when the payment Connector cannot be reached.

`code` String	`"ConnectorFailed"`
`message` String	`"The connector could not be reached."`

PaymentFailure

Returned when the payment cannot be completed succesfully.

`code` String	`"PaymentFailure"`
`message` String	`"Payment could not be completed succesfully."`