Error codes

An error code looks like [PREFIX]_[CODE], where:

[PREFIX]	Defines the application layer where the error occurred.
[CODE]	Numeric error code.

There are different prefixes:

PREFIX	Description	EXAMPLE OF AN ERROR
ACQ	Error on the acquirer side	ACQ_001
AUTH	Authentication error.	AUTH_149
CLIENT	JavaScript application error (in the buyer's browser)	CLIENT_003
INT	Integration error (on the merchant side)	INT_007
PSP	Error on the PSP side	PSP_001

Errors are returned via 4 parameters:

{
  "errorCode": "INT_015",
  "errorMessage": "invalid customer email",
  "detailedErrorCode": null,
  "detailedErrorMessage": "Invalid input value [name=customer.email, value=fake-email]"
}

Parameter	TYPE DESCRIPTION	FORMAT	Max LENGTH
errorCode	Error code string (in [PREFIX]_[CODE] format)	String	7
errorMessage	Error message string	String	127
detailedErrorCode	Detailed error code string (or null)	String	127
detailedErrorMessage	Detailed message string (or null)	String	127

The following error codes are described here:

New error codes can be added in the future. Your implementation must imperatively take this fact into account.

Categories

Tags

Error codes