跳转到主要内容
POST
/
open
/
institution
/
v1
/
order
/
deduct
主动发起扣款
curl --request POST \
  --url https://openplatform.gateapi.io/pay-subscription/open/institution/v1/order/deduct \
  --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 '
{
  "merchantDeductNo": "DEDUCT_20260420_001",
  "amount": 10.5,
  "currency": "USDT"
}
'
{
  "code": "0",
  "message": "",
  "data": {
    "deductOrderNo": "70778338049917033",
    "merchantDeductNo": "DEDUCT_20260420_001",
    "status": "SUCCESS",
    "amount": "10.50000000",
    "currency": "USDT",
    "totalDeducted": "10.50000000",
    "remainingAmount": "89.50000000",
    "deductTime": 1773989575000
  },
  "success": true
}

Documentation Index

Fetch the complete documentation index at: https://docs.gate.com/llms.txt

Use this file to discover all available pages before exploring further.

概述

本页说明 POST /open/institution/v1/order/deduct 接口。完整的请求参数、响应结构与示例由上方关联的 OpenAPI 定义渲染。

说明

请求头

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
必填

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

示例:

"9578"

请求体

application/json

主动扣款请求体

merchantDeductNo
string
必填

商户扣款编号,全局唯一,用于幂等控制

amount
number
必填

扣款金额,须大于 0,且须与订阅单约定一致

currency
string
必填

扣款币种,须与订阅单一致

subscriptionOrderNo
string

平台订阅订单编号(与 merchantSubscriptionOrderNo 二选一必填)

merchantSubscriptionOrderNo
string

商户订阅订单编号(与 subscriptionOrderNo 二选一必填)

description
string

扣款说明,展示给用户,最多 100 字符

Maximum string length: 100

响应

200 - application/json

请求已受理(具体是否扣款成功见 data.status

code
string

响应码,0 表示成功

示例:

"0"

message
string

响应描述,成功时为空

示例:

""

success
boolean

请求是否成功

示例:

true

data
object

扣款结果数据