Skip to content

Common responses

All countries and endpoints use the following response structure. Business fields are contained in data, and documented separately on each endpoint page.

Response parameters

FieldTypeRequiredDescription
codeIntegerYesResponse status code, 200 indicates successful request processing
dataObject / Array / nullYesBusiness response data; structure depends on the endpoint
msgStringNoResponse description or error details
tidStringYesRequest trace identifier; provide it for troubleshooting

Success response example

{
"code": 200,
"data": {},
"msg": "success",
"tid": "747bbf80261844ed85b809212aab0d81"
}

Error response example

{
"code": 414,
"data": null,
"msg": "paymentType is invalid",
"tid": "747bbf80261844ed85b809212aab0d81"
}

When code is not 200, treat the request as failed and retain tid. See Common error codes for meanings and suggested actions.