Skip to content

Query payout ​

POST /v1/api/disbursement/query_order

  • Statuses 1, 2, 10, 11 and 30 do not mean payout success. This query does not expose error_message, total_fee or settlement_amount; do not rely on absent fields.
  • 203006 means no order was found for this merchant and query; it is not an irreversible payment-failure status.

Request fields ​

FieldTypeRequirementDescription
tenant_idstringRequiredMerchant ID; must belong to the same merchant as app_key. Maximum 20 characters.
app_keystringRequiredApplication key, maximum 16 characters; sign using the secret of this exact application.
timestampstring / integerRequiredCurrent Unix timestamp in seconds. Timestamps older than 60 seconds are rejected; do not send milliseconds.
signstringRequired32-character lowercase MD5 calculated using the signature rules.
tenant_order_nostringEither IDMaximum 64 characters. Supply this or platform_order_no; if both are supplied, both must identify the same order.
platform_order_nostringEither IDPlatform order ID, maximum 32 characters.

For algorithm details, see signature rules.

Request example · cURL ​

bash
curl --request POST 'https://api.trpay2024.com/v1/api/disbursement/query_order' \
  --header 'Content-Type: application/json' \
  --data-raw '{
  "tenant_id": "DEMO0001",
  "app_key": "demo_app_key",
  "timestamp": "1791199800",
  "tenant_order_no": "DEMO-PAYOUT-001",
  "sign": "12010107711de8278226146267eab004"
}'

Response example ​

json
{
  "request_id": "00000000-0000-4000-8000-000000000001",
  "path": "/v1/api/disbursement/query_order",
  "success": true,
  "code": 200,
  "message": "成功",
  "data": {
    "tenant_id": "DEMO0001",
    "tenant_order_no": "DEMO-PAYOUT-001",
    "platform_order_no": "PRT202610051700DEMO0001",
    "amount": "500.00",
    "utr": "123456789012",
    "status": 20,
    "pay_time": "2026-10-05 17:02:00",
    "notify_url": "https://merchant.example/webhooks/payout",
    "notify_status": 2,
    "created_at": "2026-10-05 17:00:00"
  }
}

Fields in data ​

FieldTypeRequirementDescription
tenant_idstringRequiredMerchant ID.
platform_order_nostringRequiredPlatform order ID.
tenant_order_nostringRequiredMerchant order ID.
amountstringRequiredOrder amount; does not prove payment success.
statusintegerRequiredOrder status; see the status reference.
pay_timestring / nullRequiredPayment confirmation time; may be null before success.
notify_urlstringRequiredConfigured callback URL; may be empty.
notify_statusintegerRequiredNotification status: 0 not notified, 1 in progress, 2 acknowledged, 3 failed. Independent of payment status.
created_atstringRequiredCreation time; preserve the received value.
utrstringRequiredPayment reference; empty when not yet available.

Error handling ​

See HTTP handling, request errors and error codes.

OpenAPI v1 · Merchant integration