查询Query
POST
/api功能描述
当出现交互超时、异常时,可通过订单查询接口查询预授权、预授权完成、支付、预授权撤销、退款交易。
时序图
sequenceDiagram
Merchant->>UseePay Server: 调用查询接口
UseePay Server-->>Merchant: 返回查询结果
Response 参数对象说明
参数 | 说明 | 是否必须 |
---|---|---|
merchantNo | max=16 商户编号,由 USEEPAY 分配 | true |
resultCode | max=32本次查询的业务结果(详见 业务结果码) | true |
errorCode | max=4本次查询的错误码 | false |
errorMsg | max=256本次查询的错误码消息描述 | false |
transactionInfo | 交易信息。resultCode=xxxx 的时候有返回 | |
reserved | max=256预留字段,值同请求报文 | false |
echoParam | max=256 回声参数,响应报文会原样返回 | false |
sign | max=256商户请求参数的签名串 | true |
transactionInfo 参数对象说明
参数 | 描述 | 是否必须 |
---|---|---|
transactionId | max=64商户订单号 | true |
originalTransactionId | max=64 原始商户订单号 | |
reference | max=32USEEPAY 订单号 | false |
transactionType | max=64 pay; authorization; refund; capture;authorizationVoid; | true |
amount | max=12交易金额,单位为对应币种的最小货币单位(详见 ISO 4217) | false |
currency | max=33 位 ISO 大写字母货币代码(详见 ISO 4217) | false |
arn | max=128 ARN | false |
settlement | List集合 支付成功的订单的结算信息 | false |
resultCode | max=32业务结果(详见 业务结果码) | true |
errorCode | max=4错误码(详见 错误码 errorCode) | false |
errorMsg | max=256错误码消息描述 | false |
settlement 参数对象说明
参数 | 描述 | 是否必须 |
---|---|---|
settlementCurrency | max=3 结算币种 | false |
settlementRate | max=12 结算汇率 | false |
settlementCurrency | max=12 结算金额 | false |
请求参数
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 商户订单号。transactionld 和reference二选—
示例值:
202301300237522
transactionType
string
必需
max=18 交易类型:query
示例值:
query
reference
string
可选
string max=32USEEPAY订单号
示例值:
202301300237522
notifyUrl
string
可选
max=512 USEEPAY回调商户地址
示例值:
https://gatewaytest.useepay.com/gateway-test/redirectV2u0
signType
string
必需
max=4 商户生成签名字符串所使用的签名算法类型,目前支持:RSA MD5
示例值:
MD5
sign
string
必需
max=256商户请求参数的签名串
示例值:
decb3b9b728c7af4251acae23804939b
echoParam
string
可选
max=256 回声参数,响应报文会原样返回
示例值:
echoParam
示例代码
返回响应
成功(200)
HTTP 状态码: 200
内容格式: JSONapplication/json
数据结构
echoParam
string
可选
max=256 回声参数,响应报文会原样返回
resultCode
string
必需
max=32 表示本次查询的结果(详见 业务结果码)
sign
string
必需
errorCode
string
可选
错误码(详见 错误码 errorCode)
signType
string
必需
max=16 商户生成签名字符串所使用的签名算法类型 RSA/MD5
merchantNo
string
必需
max=16 商户编号,由 USEEPAY 分配
errorMsg
string
本次查询的错误码消息描述
错误码(详见 错误码 errorMsg)
transactionInfo
string
必需
示例
成功示例
{
"echoParam": "echoParam",
"resultCode": "succeed",
"sign": "26e12b8a690f9d4584d19272359a5520",
"signType": "MD5",
"errorCode": "0000",
"merchantNo": "500000000008901",
"errorMsg": "Successful payment",
"transactionInfo": "{\"transactionType\":\"pay\",\"reference\":\"1012404081006710607\",\"amount\":\"1111\",\"originalTransactionId\":\"\",\"resultCode\":\"succeed\",\"errorCode\":\"0000\",\"currency\":\"USD\",\"arn\":\"6612404081006710607\",\"transactionId\":\"202404081006163\",\"settlement\":[{\"settlementCurrency\":\"USD\",\"settlementRate\":\"1\",\"settlementAmount\":\"11.11\"}],\"errorMsg\":\"Successful payment\"}"
}
最后修改时间: 8 个月前