Skip to content

查询支付状态

请求方式和路径

POST /payment/payin/v1/getPaymentStatus

请求头

字段名类型必传描述
content-typestringYesapplication/json
x-api-keystringYesPaydify提供,跟appId相同
x-api-timestampstringYes时间戳,单位毫秒
x-api-signaturestringYes签名,具体参看签名算法

请求体

字段名类型必传描述
appIdstringPaydify提供
mchTxnIdstring商户侧订单ID,mchTxnIdtxnId 不能同时为空
txnIdstringPaydify返回的订单ID,mchTxnIdtxnId 不能同时为空

响应头参数

字段名类型必传描述
x-api-keystringPaydify提供,跟appId相同
x-api-timestampstring时间戳,单位毫秒
x-api-signaturestring签名,具体参看签名算法

返回值

FieldData TypeDescription
statusint请求错误码,0表示成功,非0表示失败 ,枚举值参看错误码
msgstring请求错误描述信息
data[i].txnIdstringPaydify侧的订单ID
data[i].mchTxnIdstring商户侧的订单ID
data[i].txnHashstring链上的交易hash
data[i].txnAmountstring订单金额,假如币种currency是USDT,则1.23表示1.23USDT
data[i].paidAmountstring实际金额,假如币种currency是USDT,则1.23表示1.23USDT
data[i].mchReceivedAmountstring商户应该收到的金额,假如币种currency是USDT,则1.23表示1.23USDT
data[i].mchFeestringPaydify收取的手续费,假如币种currency是USDT,则0.23表示0.23USDT
data[i].mchFeeRatestringPaydify收取的手续费费率,1表示1%
data[i].currencystring支付币种
data[i].gasFeestring上链的Gas费
data[i].gasFeeCurrencystringGas费币种
data[i].payMethod1string支付使用的钱包,枚举值参看支持的链和币种
data[i].payMethod2string支付使用的链,枚举值参看支持的链和币种
data[i].appIdstringPaydify提供
data[i].statestring支付状态,枚举值参看支付状态
data[i].refundStateint退款标识,注意跟退款状态区分
data[i].mchExtInfostring商户扩展信息,JSON字符串
data[i].errorMsgstring支付失败原因说明
data[i].envTypestringBase64 encoded string, which is QR code data generated using payment link
data[i].fromAddressstring付款地址
data[i].checkoutModeint收银台模式,目前只有1
data[i].paidTimeint支付成功的时间戳,单位毫秒,只有支付成功才有值
data[i].failedTimeint支付失败的时间戳,单位毫秒,只有支付失败/超时才有值
data[i].expiredTimeint预计支付超时的时间戳,单位毫秒
data[i].createdTimeint支付发起的时间戳,单位毫秒

请求示例

shell
# 请求

# 成功的返回值
{
  "status": 0,
  "msg": "success",
  "data": {
    "txnId": "2209141130105863014",
    "mchTxnId": "220914xxx",
    "state": "pending",
    "errorMsg": "xxx",
  }
}

# 失败的返回值
{
  "status": 9999,
  "msg": "system error",
  "data": null
}
# 请求

# 成功的返回值
{
  "status": 0,
  "msg": "success",
  "data": {
    "txnId": "2209141130105863014",
    "mchTxnId": "220914xxx",
    "state": "pending",
    "errorMsg": "xxx",
  }
}

# 失败的返回值
{
  "status": 9999,
  "msg": "system error",
  "data": null
}