---
title: "Query merchant batch transfer order"
method: POST
path: "/v1/pay/batch/transfer/query"
tags: ["reward-distribution"]
---

# Query merchant batch transfer order

`POST /v1/pay/batch/transfer/query`

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

## Headers

- `X-GatePay-Certificate-ClientId` string, required
- `X-GatePay-Signature` string, required
- `X-GatePay-Timestamp` string, required
- `X-GatePay-Nonce` string, required
- `X-GatePay-On-Behalf-Of` string

## Request body

- RewardDistributionQueryRequest — 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. When both are provided, batch_id is used.
  - `merchant_batch_no` string — Merchant batch number. Either merchant_batch_no or batch_id can be provided. When both are provided, batch_id is used.
  - `detail_status` string — Sub-order status filter: ALL, PROCESSING, SUCCESS, FAIL.

## Response `200`

Batch transfer order details

- RewardDistributionQueryResponse — 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` RewardDistributionQueryResult
    - `batch_id` string — Batch ID.
    - `merchant_id` integer — Merchant ID.
    - `merchant_batch_no` string — Merchant batch number.
    - `status` string — Batch status, such as PROCESSING, SUCCESS, or FAIL.
    - `currency` string — Batch currency.
    - `channel_id` string — Channel ID.
    - `orders_list` RewardDistributionOrderResult[] — List of sub-orders.
      - `receiver_id` integer — Receiver user ID.
      - `amount` string — Transfer amount.
      - `currency` string — Currency.
      - `status` string — Sub-order status: PROCESSING, SUCCESS, or FAIL.
      - `reward_id` string — Reward identifier or business-side sub-order identifier.
      - `transaction_id` string — Transaction ID.
      - `create_time` integer — Creation time.
      - `channel_id` string — Channel ID.

---

[API](https://skmtc.net/gate/apis/gatepay-withdrawal-wallet-api.md) · [All operations](https://skmtc.net/gate/apis/gatepay-withdrawal-wallet-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/gate/gatepay-withdrawal-wallet-api/versions/4feb16b0979e/schema)