跳转到主要内容
POST
/
v1
/
pay
/
batch
/
transfer
创建商户批量转账
curl --request POST \
  --url https://openplatform.gateapi.io/v1/pay/batch/transfer \
  --header 'Content-Type: application/json' \
  --header 'X-GatePay-Certificate-ClientId: <x-gatepay-certificate-clientid>' \
  --header 'X-GatePay-Nonce: <x-gatepay-nonce>' \
  --header 'X-GatePay-Signature: <x-gatepay-signature>' \
  --header 'X-GatePay-Timestamp: <x-gatepay-timestamp>' \
  --data '
{
  "merchant_batch_no": "RB202606300001",
  "currency": "USDT",
  "batchorderList": [
    {
      "user_id": 100001,
      "amount": "12.5",
      "currency": "USDT",
      "rewardId": "reward_001"
    },
    {
      "user_id": 100002,
      "amount": "8.8",
      "currency": "USDT",
      "rewardId": "reward_002"
    }
  ]
}
'
{
  "status": "SUCCESS",
  "code": "000000",
  "errorMessage": "",
  "data": {
    "merchant_batch_no": "RB202606300001",
    "batch_id": "237394559478075550"
  }
}

概述

本页说明 POST /v1/pay/batch/transfer 接口,用于创建商户批量转账订单。完整的请求参数、响应结构与示例由上方关联的 OpenAPI 定义渲染。

说明

  • 认证方式使用 GatePay 标准签名请求头。
  • 本接口归类在出金目录下“奖励分发”分组。
  • X-GatePay-On-Behalf-Of 为非必填;如需在机构代理上下文中标识请求发起方,可按需传入。
  • 通用签名规则请参见 /api-reference/version/100/cn/common/securityAndSignature

请求头

X-GatePay-Certificate-ClientId
string
必填

商户客户端ID,在 GatePay 平台申请获得

示例:

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

X-GatePay-Signature
string
必填

HMAC-SHA256签名,用于验证请求合法性

示例:

"672d5650dcc9bb22ebf25fa16c28d03c0e159d742a9176d4340a5da326d75dc8a2ec24c97fa6fc5d1533dd6e968863747e1d86a45e562cbe899f9ed7e9ca7f77"

X-GatePay-Timestamp
string
必填

时间戳(毫秒),与服务器时间差不能超过5分钟

示例:

"1672905655498"

X-GatePay-Nonce
string
必填

随机数,用于防止重放攻击

示例:

"3525756760"

X-GatePay-On-Behalf-Of
string

非必填代理归属请求头。需要在机构代理上下文中标识请求发起方账户 ID 时传入;未使用机构代理上下文时可不传。

请求体

application/json

创建商户批量转账请求体。

merchant_batch_no
string
必填

商户批次号,需由商户保证唯一。

currency
string
必填

批量转账币种。

batchorderList
object[]
必填

批量转账子单列表。

bizscene
string

业务场景标识。

name
string

批量转账名称。

description
string

批量转账描述。

channelId
string

渠道 ID,可选。

is_coupon
boolean

是否优惠券场景,可选,默认 false。

响应

200 - application/json

批量转账创建结果

创建商户批量转账响应体。

status
string
必填

接口响应结果,SUCCESS 或 FAIL。

code
string
必填

响应错误码。

errorMessage
string

错误描述。

data
object