付款查询
- Endpoint:
POST /aggregate-pay/api/gateway/paymentOrderQry - Tags: 付款
Description
此接口为API付款查询接口，该接口返回参数请注意以下事项，否则可能会有资损风险：
- 当"code": "APPLY_SUCCESS"且返回status，代表查询成功，订单状态请以status为准；
- 当"code": "ORDER_NOT_EXIST" 且间隔（5min）查询多次后返回一样，可不换outTradeNo重新下单；
- 其他场景请检查参数后，可重新查询，注意重新设置requestTime;
Parameters
| Field | In | Type | Required | Constraints | Description |
|---|---|---|---|---|---|
Content-Type | header | string | Yes | ||
sign | header | string | Yes | 签名信息请参考技术文档 |
Parameter Examples
Content-Type:"application/json"sign:"FPFVT3o227JrFRbqu19boZCpVVTF9KznxyRawUmxpfXilHV/0yK46haPhAjNu1hPUMy7Vw/ILXhfzffNm4Fj0apWknlTY9OJxnSoQxS9BTFtc61tn5yV1q69x/kkBl82/qwg+XTJ4fOzy7Mar3VaC1E2PlDA6RkkKBUyNE6RYgsdB+Su7an4+4HVTNAnoe74WyvBgxTLMNg28igBTdqxaO3w/UBY6ObVp7vkqkQGdL1Y+HgmMYaAVwrM3+ALWGId0sJ+YqTY4WJ+0xCRGhaSnybiIjZsQEYyID68WNUfuavDLDsEhaMm/HfQvf5p0R1Ltovp3wwJnEbQcjY458iX5A=="
Request Body
Content-Type: application/json
| Field | Type | Required | Constraints | Description | Enum |
|---|---|---|---|---|---|
version | string | Yes | maxLength: 8 | 接口版本，当前版本1.4 | |
keyVersion | string | Yes | maxLength: 8 | 密钥版本，当前版本1 | |
requestTime | string | Yes | maxLength: 32 | 请求时间，符合rfc3339规范，格式：yyyy-MM-dd’T’HH:mm:ss.SSSXXX | |
appId | string | Yes | maxLength: 64 | 商户应用ID，PayerMax分配给商户应用的唯一标识 | |
merchantNo | string | No | maxLength: 32 | 商户号，商户与PayerMax业务签约时生成的唯一标识 | |
data | object | Yes | 请求数据体 | ||
data.outTradeNo | string | Yes | maxLength: 63 | 原商户订单号 |
Example
json
{
"version": "1.4",
"keyVersion": "1",
"requestTime": "2023-03-08T14:41:47.095+08:00",
"appId": "6666c83333a24666674497c444a33333",
"merchantNo": "010213834123456",
"data": {
"outTradeNo": "outTradeNo16699809174221"
}
}Responses
200
| Field | Type | Required | Constraints | Description | Enum |
|---|---|---|---|---|---|
code | string | Yes | 返回码，APPLY_SUCCESS代表成功。只代表接口请求成功，不代表订单状态。 | ||
msg | string | Yes | 返回描述，’Success.’ | ||
data | object | Yes | 返回数据体 | ||
data.outTradeNo | string | No | maxLength: 64 | 商户订单号 | |
data.tradeNo | string | No | PayerMax交易流水号 | ||
data.status | string | No | maxLength: 32 | 交易状态，SUCCESS成功, FAILED失败 ，PENDING进行中，BOUNCEBACK退票 | |
data.subStatus | string | No | 交易子状态, 当订单交易状态为PENDING时，PayerMax将提供子状态，展示交易处理进度，具体枚举值请参考：【交易子状态介绍】。未返回可联系技术支持升级。 | ||
data.notifyEmail | string | No | 通知邮箱 | ||
data.notifyPhone | string | No | 通知电话 | ||
data.responseCode | string | No | 订单失败错误码，详见【错误码】 | ||
data.responseMsg | string | No | 订单失败错误码描述 | ||
data.reference | string | No | 附加数据，上送的值 | ||
data.redeemCode | string | No | 1.FAWRY取款码，2.运营商充值PIN码 | ||
data.expiryTime | string | No | 订单过期时间，符合rfc3339规范，格式：yyyy-MM-dd’T’HH:mm:ss Z | ||
data.bounceBackTime | string | No | 退票时间，符合rfc3339规范，格式：yyyy-MM-dd’T’HH:mm:ss Z | ||
data.transactionUtcTime | string | Yes | maxLength: 32 | 交易创建时间，符合rfc3339规范，格式：yyyy-MM-dd’T’HH:mm:ss Z | |
data.fundsFreezeTime | string | No | 资金动账时间，符合rfc3339规范，格式：yyyy-MM-dd'T'HH:mm:ss Z | ||
data.fundsReturnTime | string | No | 资金返还时间，符合rfc3339规范，格式：yyyy-MM-dd'T'HH:mm:ss Z | ||
data.payFinishTime | string | No | 交易完成时间，符合rfc3339规范，格式：yyyy-MM-dd’T’HH:mm:ss Z | ||
data.trade | object | Yes | 交易信息 | ||
data.trade.amount | string | Yes | 请求中传入的付款金额 | ||
data.trade.currency | string | Yes | 付款币种，商户在请求中传入的付款金额对应货币代码 | ||
data.source | object | Yes | 付款信息（商户） | ||
data.source.amount | string | Yes | 付款方-扣款金额 | ||
data.source.currency | string | Yes | 付款方-扣款币种 | ||
data.source.exchangeRate | string | No | 交易币种转换为扣款币种的汇率 | ||
data.source.fee | string | No | 付款方-手续费 | ||
data.source.feeCurrency | string | No | 付款方-手续费币种 | ||
data.source.tax | string | No | 付款方-税费 | ||
data.source.taxCurrency | string | No | 付款方-税费币种 | ||
data.destination | object | Yes | 收款信息（用户） | ||
data.destination.amount | string | Yes | 收款方到账金额 | ||
data.destination.currency | string | Yes | 收款方到账金额币种 | ||
data.destination.exchangeRate | string | No | 交易币种转换为到账币种的汇率 | ||
data.destination.fee | string | No | 收款方-手续费 | ||
data.destination.feeCurrency | string | No | 收款方-手续费币种 | ||
data.destination.tax | string | No | 收款方-税费 | ||
data.destination.taxCurrency | string | No | 收款方-税费币种 | ||
data.additionalIdentifier | object | No | 交易附加信息，出款回调升级到3.0版本以上，才会返回该字段。如有需求，可以联系PayerMax技术支持进行调整 | ||
data.additionalIdentifier.referenceId | string | No | 收款银行/机构的交易单号（依据历史经验，目前仅沙特BankTransfer返回的该单号可以作为凭证跟收款行确认是否到账，交易单号格式如：20240418SAARNBARNB1B44410558522170） |
Response Example: 1
成功示例
json
{
"msg": "Success.",
"code": "APPLY_SUCCESS",
"data": {
"outTradeNo": "outTradeNo1669980917422",
"tradeNo": "20221202113517PO8822546300427849",
"status": "SUCCESS",
"fundsFreezeTime": "2024-04-17T06:35:09 +0000",
"fundsReturnTime": "2024-04-18T07:13:01 +0000",
"notifyEmail": "example@gmail.com",
"notifyPhone": "79189772406",
"responseCode": "",
"responseMsg": "",
"reference": "this is reference",
"redeemCode": "",
"expiryTime": "",
"bounceBackTime": "",
"transactionUtcTime": "2022-12-02T11:35:17 +0000",
"payFinishTime": "2022-12-02T11:35:23 +0000",
"trade": {
"amount": "3223.59",
"currency": "PHP"
},
"destination": {
"amount": "3223.00",
"taxCurrency": "PHP",
"exchangeRate": "1.0000000000",
"fee": "0.59",
"feeCurrency": "PHP",
"currency": "PHP",
"tax": "0.00"
},
"source": {
"amount": "3223.59",
"taxCurrency": "PHP",
"exchangeRate": "1.0000000000",
"fee": "0.00",
"feeCurrency": "PHP",
"currency": "PHP",
"tax": "0.00"
},
"additionalIdentifier": {
"referenceId": "2024041710121481030100166528590615003"
}
}
}Response Example: 2
异常示例
json
{
"msg": "The order does not exist.",
"code": "ORDER_NOT_EXIST"
}