Error Code API

Common error code table for all APIs

EndPoint

GET /credit-card/error-code/list

Header Params

Param	Required	Data Type	Description	Note
X-APPOTAPAY-AUTH	required	String	How to create JWT_TOKEN
Content-Type	required	String	Value: application/json
X-Request-ID	optional	String	UUIDv4 format. Request ID to check request when error occurs	max:42
Language	optional	String	Value vi or en corresponding to payment link will be Vietnamese or English, (default: vi)	in:vi,en

{
    "X-APPOTAPAY-AUTH": "JWT_TOKEN",
    "Content-Type": "application/json",
    "X-Request-ID": "Your_Unique_id",
    "Language": "en"
}

Response Params

Param	Required	Data Type	Description
errorCode	required	Integer	Error code
message	required	String	Error description
errors	optional	Array of Object	Detailed error description for fields if any
errors.field	required	Object	Field data with error
errors.reason	required	Object	Description of field data with error

Success

Http Status Code 200 - OK

{
    "errorCode": 0,
    "message": "Success",
    "data": [
        {
            "code": 1,
            "message": "Missing or Invalid Params"
        }
    ]
}

Failure

HTTP Status Code != 200

With errorCode returned, please refer to the error code table here

Example Code

curl  "https://gateway.dev.appotapay.com/credit-card/error-code/list" \
  -H "X-APPOTAPAY-AUTH: JWT_TOKEN" \
  -H "Content-Type: application/json" \
  -H "X-Request-ID: Your_Unique_id" \
  -H "Language: en"

Request

REQUEST

Base URL

https://gateway.dev.appotapay.com

Development server

Path

Auth REQUIRED

Bearer Token

Language — header

vien

The value corresponding to the payment link can be in Vietnamese or English (default: vi)