Sign in
reward-distribution

Create merchant batch transfer

Create a batch transfer order from a merchant to multiple users.

post/v1/pay/batch/transfer

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

batchIdstring required

Internal batch correlation ID used to associate the batch record with its sub-orders. Keep it unique within the merchant account. It may use the same value as merchant_batch_no.

bizscene'DIRECT_TRANSFER' required

Business scenario identifier. This endpoint currently supports only DIRECT_TRANSFER.

merchant_batch_nostring required

Merchant-side business batch number used for request idempotency and merchant queries. It must be unique on the merchant side.

namestring

Display name of the batch transfer.

descriptionstring

Description of the batch transfer.

channelIdstring

Channel ID, optional.

is_couponboolean

Whether this is a coupon scenario. Optional, default is false.

Response

Batch transfer creation result

statusstring required

API response result, SUCCESS or FAIL.

codestring required

Response error code.

errorMessagestring

Error description.

Changes

Changed in 1 of the 5 revisions of this API.21

  • 2c8a39daf98621See the full diff
    • ▲

      the request property // became required

      request-property-became-required

    • ▲

      the request property // became required

      request-property-became-required

    • ●

      removed the request property

      request-property-removed