Checkout¶
Tip
- All requests are
Postrequests, and the data format isjson
Brief Description¶
Request URL¶
/v1/vexora/checkout
Request Method¶
- Method: POST
- Content-Type: application/json
Header¶
| Header | Required | Type | Description |
|---|---|---|---|
| merchantNo | Yes | String | None |
Body¶
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| sign | Yes | String | Except for sign, the remaining fields should be sorted by the first letter to form key1=value1key2=value2, and then use the app secret as salt to perform MD5 encryption. The final sign should be in lowercase. |
| timestamp | Yes | String | Timestamp (e.g., 1715941383720) |
| amount | Yes | String | Payment amount (amounts with decimals are not recommended) |
| payType | Yes | String | Supported payment types: • E-wallet: GCash, GrabPay, Maya • Modify QR: GCash2, QRPH |
| tradeNo | Yes | String | Unique disbursement ID for a specific request, generated by partner. |
| remark | No | String | Remarks; this field will be returned as is |
| notifyUrl | Yes | String | The URL used by the system to send an automatic response or N otification after a transaction or process is completed. |
| returnUrl | Yes | String | Redirect page after successful payment |
Example of Request Parameters¶
{
"amount": "200",
"payType": "QRPH",
"tradeNo": "99333213852",
"notifyUrl": "https://www.111.com/",
"sign": "50f25c09a201e9df0fa9d4c67a53a092",
"timestamp": "1729945561186"
}
Response Result¶
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| msg | Yes | String | Request result (when returning "success", it only indicates that this request was successful; it should not be used for merchant-side logic judgment) |
| code | Yes | String | Request response code (when returning "0000", it only indicates that this request was successful; it should not be used for merchant-side logic judgment). For specific error codes, please refer to the business error code enumeration. |
| timestamp | Yes | String | Transaction time |
| success | Yes | String | Transaction result |
| data | Yes | Object | Returned object |
| data.platFormTradeNo | Yes | String | Unique disbursement ID from vexora, partners can use this ID for reconciliation. |
| data.status | Yes | String | Transaction results,Merchants can process subsequent workflows based on the returned status in the transaction result. For details, please refer to the status code reference table. |
| data.desc | Yes | String | Error description |
| data.remark | Yes | String | Content returned from the request (returned as is) |
| data.paymentLink | Yes | String | Payment link, i.e., the cash register |
Example of Successful Return¶
{
"msg": "success",
"code": "0000",
"timestamp": 1729945579983,
"success": true,
"data": {
"platFormTradeNo": "8h7kold1d6g8fbmm",
"status": "0015",
"desc": "CREATED",
"paymentLink": "https://www.kaixin199.info/payment/Maya/PHP60801Maya061484533"
}
}