Check Deposit Status¶
Saudi Arabia APIs
Introduction 路 Response Code 路 Checkout 路 Check Deposit Status 路 Deposit WayCode 路 Check Balance 路 Webhook
Tip
- All requests are
POSTrequests, and the data format isjson
Brief Description¶
- Use this API to query the latest status of a Saudi Arabia collection transaction.
Request URL¶
/v1/vexora/queryPayInResult
Request Method¶
- Method: POST
- Content-Type: application/json
Header¶
| Name | Required | Type | Description |
|---|---|---|---|
| merchantNo | Yes | String | Merchant number assigned by Vexora |
Request Body Parameters¶
| Name | Required | Type | Description |
|---|---|---|---|
| tradeNo | Yes | String | Merchant transaction number from the original collection request |
| timestamp | Yes | String | Timestamp |
| sign | Yes | String | Request signature generated from all non-empty body fields except sign |
Request Example¶
{
"sign": "af1c0d6d9b8f4a8c6d18c8859438f92a",
"timestamp": "1782878520000",
"tradeNo": "SA202607010001"
}
Successful Response Example¶
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| msg | Yes | String | API request message |
| code | Yes | String | API request code |
| timestamp | Yes | Integer | Response timestamp |
| success | Yes | Boolean | Whether the query request was processed successfully |
| data | Yes | Object | Returned object |
| data.platFormTradeNo | Yes | String | Platform order number |
| data.tradeNo | Yes | String | Merchant transaction number |
| data.status | Yes | String | Transaction status used for final business judgment |
| data.amount | Yes | Float | Transaction amount |
| data.channelCode | Yes | String | Actual payment product code used to process the transaction. This may differ from the value submitted at checkout |
| data.wayCode | Yes | String | Actual payment method code used to process the transaction. This may differ from the value submitted at checkout |
| data.message | Yes | String | Error description |