GAgate
reward-distribution

Query merchant batch transfer order

Changed on

Query a merchant batch transfer order and its sub-order statuses by batch_id or merchant_batch_no.

post/v1/pay/batch/transfer/query

Request

  • Base URL
    https://openplatform.gateapi.io
  • URL
    https://openplatform.gateapi.io/v1/pay/batch/transfer/query
  • Auth
    none declared. Required headers: X-GatePay-Certificate-ClientId, X-GatePay-Signature, X-GatePay-Timestamp, X-GatePay-Nonce

Headers

X-GatePay-Certificate-ClientIdstring required
Example:4186d0c6-6a35-55a9-8dc6-5312769dbff8

The clientId assigned when the merchant registers an application in the Gate merchant console.

X-GatePay-Signaturestring required

Request signature. GatePay uses this signature to verify whether the request is valid.

X-GatePay-Timestampstring required
Example:1672905655498

Millisecond timestamp; the difference from server time must not exceed 30 seconds.

X-GatePay-Noncestring required
Example:9578

Random string. Must comply with HTTP header rules; recommended length is within 32 characters, composed of digits and letters.

X-GatePay-On-Behalf-Ofstring

Optional delegated-subject header. Pass the initiating account ID only when an institution-delegated context needs to be identified; otherwise this header can be omitted.

Request body

batch_idstring

GatePay batch ID. Either batch_id or merchant_batch_no can be provided. When both are provided, batch_id is used.

merchant_batch_nostring

Merchant batch number. Either merchant_batch_no or batch_id can be provided. When both are provided, batch_id is used.

detail_statusstring

Sub-order status filter: ALL, PROCESSING, SUCCESS, FAIL.

Response

Batch transfer order details

statusstring required

API response result, SUCCESS or FAIL.

codestring required

Response error code.

errorMessagestring

Error description.

Changes