查询接口 - Payout query

请求地址

https://{{gateway_domain}}/pg/v2/payout/query

请求参数

HTTP Method

POST

HTTP Header

字段	数据类型	长度限制	是否必填项	说明
Content-Type	String	N/A	是	字段值只支持 application/json
Accept	String	N/A	是	字段值只支持 application/json
Authorization	String		是	Authorization: {type} {credentials}，详情参考签名规范部分

HTTP Body

字段	数据类型	长度限制	是否必填项	说明
merchantTradeNo	String	50	merchantTradeNo, payoutNo 二选一	商户订单号
payoutNo	String	32	merchantTradeNo, payoutNo 二选一

响应结果

HTTP Header

字段	数据类型	是否必填项	说明
Content-Type	String	是	字段值只支持 application/json
Authorization	String	是	Authorization: {type} {credentials}，详情参考签名规范部分

HTTP Body

字段	数据类型	是否必填项	说明
code	Enum String	是	参考响应码表
errorMessage	String	否	错误信息
data	JSON Object	否

data 字段说明

字段	数据类型	是否必填项	说明
payoutNo	String	是	支付平台交易流水号
merchantTradeNo	String	是	商户生成的订单号
amount	String	是	订单金额
currency	Enum String	是	订单的币种
totalFee	String	是	代付手续费
status	Enum String	是	详见订单状态
rrn	String	否	渠道检索参考号码，依赖渠道返回
merchantAttach	String	否	支付请求时，如使用此字段，支付平台则原样返回
createdTime	Number	是	订单创建时间（本地时间，含时间区间）
paidTime	Number	是	支付成功时间（本地时间，含时间区间）。未支付成功返回 null

示例

请求

curl https://{{gateway_domain}}/pg/v2/payout/query \
  -X POST \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -H 'Authorization: V2_SHA256 appId=1111b620f93b48c5904210ff47bb1111,sign=9e494e8a91bcdd08f18ad5b2cfdbfd5654f5c00c89f8216eebd7c1637b6ce01b,timestamp=1714128828114,nonce=C7CA27DC6D55DA935DFC8450C721CC99' \
  -d '{
  "merchantTradeNo": "MTOU-0211",
  "payoutNo": ""
}'

响应

HTTP/1.1 200 OK
Content-Type: application/json
Server: nginx/1.18.0
Date: Mon, 06 Mar 2024 12:00:00 GMT
Authorization: V2_SHA256 appId=1111b620f93b48c5904210ff47bb1111,sign=ac6ae72f8c46f5c2092c3dab9bb0e08b6cdb6d5e7ff8ad190499a8955d57f297,timestamp=1714128245401,nonce=28FA11BF8FD1309767551B4FD8A57BD5

{
    "code": "OK",
    "errorMessage": null,
    "data": {
        "payoutNo": "20240426192048100800062197000010",
        "merchantTradeNo": "MTOU-0211",
        "amount": "1.00",
        "currency": "INR",
        "totalFee": "0.00",
        "status": "PENDING",
        "rrn": "123456789",
        "merchantAttach": "merchant attach",
        "createdTime": "2024-04-26T19:20:53+08:00",
        "paidTime": "2024-04-26T19:21:28+08:00"
    }
}

Payout 订单状态

状态	说明
PENDING	待处理
PROCESSING	处理中
PAID	代付成功
FAILURE	代付失败
REVERSED	代付退票
CANCELLED	代付取消