代付订单查询

查询代付订单状态的接口,支持通过 merchantReference 或 pspReference 查询订单详情。

1.请求地址(POST)

实时 API: https://api.futurepay.global/api/v1/payout/query

沙盒 API: https://api.futurepay-develop.com/api/v1/payout/query

2.请求参数

请求使用 application/json 格式,请求参数如下:

参数名类型是否必填说明
merchantReferenceString商户订单号,和 pspReference 必须二选一
pspReferenceString平台订单号,和 merchantReference 必须二选一
clientIpString客户端 IP 地址

请求示例:

{
  "merchantReference": "MCH121323313317202",
  "pspReference": "PT699020910133248",
  "clientIp": "127.0.0.1"
}

3.响应参数

返回为统一结构:

字段名类型说明
codeString状态码,"0" 表示成功
msgString状态信息
serverTimeLong服务器响应时间戳
successBoolean请求是否成功
dataObject返回业务数据

data 结构说明

字段名类型说明
merchantReferenceString商户订单号
pspReferenceString平台订单号
resultCodeString状态码:PENDING
failReasonString失败原因(如有)
dataObject订单金额相关详情

data.data 结构说明

字段名类型说明
paymentAmountObject支付总金额
payeeAmountObject实际收款金额
feeAmountObject手续费金额

每个金额字段结构如下:

{
  "currency": "NGN",
  "value": "1108.0000000000"
}

成功响应示例:

{
  "code": "0",
  "msg": "succeeded",
  "serverTime": 1748503139972,
  "data": {
    "merchantReference": "MCH121323313317202",
    "pspReference": "PT699020910133248",
    "resultCode": "PENDING",
    "data": {
      "paymentAmount": {
        "currency": "NGN",
        "value": "1108.0000000000"
      },
      "payeeAmount": {
        "currency": "NGN",
        "value": "1000.0000000000"
      },
      "feeAmount": {
        "currency": "NGN",
        "value": "108.0000000000"
      }
    }
  },
  "success": true
}

4.注意事项

1.merchantReference 和 pspReference 至少提供一个,建议同时提供以提高查询匹配精度。

2.接口采用 HTTPS,请确保服务器支持安全传输。

3.所有金额单位均为指定币种的小数表示(保留小数点后 10 位)。