Payout Query API
Overview
Payout Query API queries payout order status and details. Merchants can get real-time order status and processing results.
API Info
- Endpoint:
POST /api/ar/payout-query - Method: POST
- Content-Type: application/json
Request Headers
All API requests require the following headers, see API Signature:
| Header | Type | Required | Description |
|---|---|---|---|
| Content-Type | string | Y | application/json, fixed |
| MerchantId | string | Y | Merchant ID provided by Veloraya |
| Timestamp | string | Y | Current timestamp (ms), anti-replay |
| Nonce | string | Y | Random string, unique per request, anti-replay |
| Signature | string | Y | Request signature (RSA), Base64 encoded |
Request Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| merchantOrderId | string | N | Merchant order ID (one of orderId/merchantOrderId required) |
| orderId | string | N | Platform order ID (one of orderId/merchantOrderId required) |
Request Example
By platform order ID
json
{
"orderId": "PAYOUT2059898124479799296"
}By merchant order ID
json
{
"merchantOrderId": "Order17424109"
}Response Format
| Field | Type | Description |
|---|---|---|
| code | int | 200 success, 500 failure |
| msg | string | Response message |
| data | object | Response data, order info on success |
Response Parameters (data)
| Field | Type | Description |
|---|---|---|
| orderId | string | Platform order ID |
| merchantOrderId | string | Merchant order ID |
| amount | BigDecimal | Order amount |
| fee | BigDecimal | Fee |
| currency | string | Currency code |
| completeDatetime | string | Completion time (yyyy-MM-dd HH:mm:ss), empty if not complete |
| orderStatus | string | Order status, see enum |
| resultCode | string | Error code (on failure) |
| resultDesc | string | Error description (on failure) |
Order status enum
| Value | Description |
|---|---|
| PENDING | Pending |
| SUCCESS | Success |
| FAILED | Failed |
Notes
- Headers: all required headers must be passed, see API Signature
- Signature: all requests must include a valid signature
- Query scope: only this merchant's orders can be queried; merchantId is checked
- Logging: log queries for audit