预授权完成(Capture)
POST
/api功能说明
::: caution
Top1:请款扣除之前被预订的金额。预授权完成,只能在预授权成功才能被执行。预授权完成的金额,只能小于预授权的 金额,不能大于预授权的金额。
Top2:预授权完成最好在3个工作日内完成,否则万事达卡会被加收0.033欧元+0.28%的手续费,同时,超过3天的预授权拒付是无法申诉的。
:::
时序图
sequenceDiagram
Merchant->>UseePay Server: 请求预授权完成/capture
UseePay Server->>Merchant: 返回预授权完成结果
Merchant-->>UseePay Server: 异步通知notifyUrl预授权完成结果
Response响应参数说明
字段 | 长度 | 描述 | 是否必要 |
---|---|---|---|
merchantNo | max=16 | max=16 商户编号,由 USEEPAY 分配 | yes |
transactionId | max=64 | 商户订单号,需保证在商户端不重复 | yes |
originalTransactionId | max=64 | 原始预授权的商户订单号 | yes |
transactionType | max=18 | 交易类型:capture | yes |
reference | max=32 | USEEPAY 订单号 | |
amount | max=12 | 支付金额,单位为对应币种的最小货币单位金额和货币单位 | yes |
currency | max=3 | 3 位 ISO 大写字母货币代码金额和货币单位 | yes |
resultCode | max=32 | 业务结果(业务结果码(ResultCode))判断交易是否成功的依据 | yes |
errorCode | max=4 | 错误码(详见 错误码 errorCode) | |
errorMsg | max=256 | 错误码消息描述 | |
echoParam | max=256 | 回声参数,响应报文会原样返回 | |
sign | max=256 | 签名 | yes |
请求参数
Header 参数
Content-Type
string
必需
示例值:
application/x-www-form-urlencoded
Body 参数application/x-www-form-urlencoded
version
string
必需
max=5 调用的接口版本,固定为:1.0
示例值:
1.0
merchantNo
string
必需
max=16 商户号,由 USEEPAY 分配
示例值:
500000000007362
transactionId
string
必需
max=64 UseePay 商户订单号,建议每次请求的 transactionId 唯一,有利于后续订单查询和对账。
示例值:
{% mock 'uuid' %}
transactionType
string
必需
capture (max=64)
示例值:
capture
originalTransactionId
string
必需
max=64 原始预授权的商户订单号
示例值:
{% mock 'uuid' %}
signType
string
必需
签名类型,MD5/ RSA (max=4)
示例值:
MD5
echoParam
string
可选
回声参数,Response中将会原样返回(max=256)
notifyUrl
string
可选
max=512 异步通知地址
示例值:
https://gatewaytest.useepay.com/notifyV2u0
sign
string
必需
max=256 商户请求参数的签名串
示例值:
82b04931f07474ec423510207c461d74
示例代码
返回响应
成功(200)
HTTP 状态码: 200
内容格式: JSONapplication/json
数据结构
amount
string
必需
max=12 支付金额,单位为对应币种的最小货币单位ISO 4217
resultCode
string
必需
max=32 业务结果(详见 业务结果码)
sign
string
必需
max=256 商户请求参数的签名串
errorCode
string
可选
错误码(详见 错误码 errorCode)
transactionId
string
必需
max=64 商户订单号,需保证在商户端不重复
errorMsg
string
可选
错误码(详见 错误码 errorMsg)
transactionType
string
必需
max=18 交易类型: authorizationVoid
reference
string
可选
max=64 USEEPAY 订单号
echoParam
string
可选
max=256 回声参数,响应报文会原样返回
originalTransactionId
string
可选
max=64 原始预授权完成/支付商户订单号
signType
string
可选
max=16 商户生成签名字符串所使用的签名算法类型 RSA/MD5
currency
string
必需
merchantNo
string
必需
示例
{
"amount": "100",
"resultCode": "succeed",
"sign": "8a6a0792f318a29d7232ad3af05437e3",
"errorCode": "0000",
"transactionId": "202305281007042",
"errorMsg": "Approved or completed successfully",
"transactionType": "capture",
"reference": "1112305282207689135",
"echoParam": "echoParam",
"originalTransactionId": "202305281006558",
"signType": "MD5",
"currency": "USD",
"merchantNo": "500000000007362"
}
最后修改时间: 1 年前