预授权撤销(Void)

全球收单-SandBox环境

https://pay-gateway1.uat.useepay.com

POST

/api

功能描述

提示

可对预授权交易进行撤销操作，撤销成功后，客户被冻结的资金将被解冻。

预授权撤销金额必须和预授权金额一样

时序图

请求参数

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 唯一，有利于后续订单查询和对账。

示例值:

202301300237532

transactionType

string

必需

max=18 交易类型: authorizationVoid

示例值:

authorizationVoid

originalTransactionId

string

必需

max=64 原始商户订单号

示例值:

202301300237532

notifyUrl

string

可选

max=512 USEEPAY 回调商户地址

示例值:

https://gatewaytest.useepay.com/notifyV2u0

echoParam

string

可选

max=256 回声参数，响应报文会原样返回

示例值:

echoParam

signType

string

必需

max=16 商户生成签名字符串所使用的签名算法类型 RSA/MD5

示例值:

MD5

sign

string

必需

max=256 商户请求参数的签名串

示例值:

decb3b9b728c7af4251acae23804939b

amount

string

必需

max=12 支付金额，单位为对应币种的最小货币单位ISO 4217

示例值:

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://pay-gateway1.uat.useepay.com/api' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'version=1.0' \
--data-urlencode 'merchantNo=500000000007362' \
--data-urlencode 'transactionId=202301300237532' \
--data-urlencode 'transactionType=authorizationVoid' \
--data-urlencode 'originalTransactionId=202301300237532' \
--data-urlencode 'notifyUrl=https://gatewaytest.useepay.com/notifyV2u0' \
--data-urlencode 'echoParam=echoParam' \
--data-urlencode 'signType=MD5' \
--data-urlencode 'sign=decb3b9b728c7af4251acae23804939b' \
--data-urlencode 'amount=1'

返回响应

🟢200成功

application/json

Body

transactionType

string

必需

max=18 交易类型: authorizationVoid

reference

string

可选

max=64 USEEPAY 订单号

echoParam

string

可选

max=256 回声参数，响应报文会原样返回

originalTransactionId

string

必需

max=64 原始预授权完成/支付商户订单号

resultCode

string

必需

max=32 业务结果（详见业务结果码）

sign

string

必需

max=256 商户请求参数的签名串

errorCode

string

可选

错误码（详见错误码 errorCode）

signType

string

必需

max=16 商户生成签名字符串所使用的签名算法类型 RSA/MD5

transactionId

string

必需

max=64 商户订单号，需保证在商户端不重复

merchantNo

string

必需

max=16 商户号，由 USEEPAY 分配

errorMsg

string

必需

错误码（详见错误码 errorMsg）

示例

{
    "transactionType": "authorizationVoid",
    "reference": "1122305282117689132",
    "echoParam": "echoParam",
    "originalTransactionId": "202305280917268",
    "resultCode": "succeed",
    "sign": "acd54b23a7302be97efffcdd77f576d9",
    "errorCode": "0000",
    "signType": "MD5",
    "transactionId": "202305280917403",
    "merchantNo": "500000000007362",
    "errorMsg": "Approved or completed successfully"
}

修改于 2023-11-03 10:33:10

查询Query

预授权完成(Capture)

预授权撤销(Void)

功能描述#

时序图#

请求参数

示例代码

返回响应

功能描述

时序图