Skip to main content
POST
Query merchant batch transfer order

Overview

This page documents the POST /v1/pay/batch/transfer/query endpoint, which queries a merchant batch transfer order and its sub-order statuses. The full request schema, response structure, and examples are rendered from the linked OpenAPI definition above.

Notes

  • Authentication uses the standard GatePay signed headers.
  • This endpoint is grouped under PayoutReward Distribution in institution merchant APIs.
  • X-GatePay-On-Behalf-Of is optional for this endpoint. Pass it only when you need to specify the initiating account context in an institution-delegated scenario.
  • For shared signing rules, see /api-reference/version/100/en/common/securityAndSignature.

Headers

X-GatePay-Certificate-ClientId
string
required

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

Example:

"4186d0c6-6a35-55a9-8dc6-5312769dbff8"

X-GatePay-Signature
string
required

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

X-GatePay-Timestamp
string
required

UTC timestamp in milliseconds when the request is generated. GatePay will not process requests where the difference from the receive time exceeds 10 seconds.

Example:

"1672905655498"

X-GatePay-Nonce
string
required

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

Example:

"9578"

X-GatePay-On-Behalf-Of
string

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.

Body

application/json

Request body for querying a merchant batch transfer order.

batch_id
string

GatePay batch ID. Either batch_id or merchant_batch_no can be provided.

merchant_batch_no
string

Merchant batch number. Either merchant_batch_no or batch_id can be provided.

detail_status
string

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

Response

200 - application/json

Batch transfer order details

Response body for querying a merchant batch transfer order.

status
string
required

API response result, SUCCESS or FAIL.

code
string
required

Response error code.

errorMessage
string

Error description.

data
object