付款结果通知

• Endpoint: POST /disbursementResultNotifyUrl
• Tags: 付款

Description

该地址无需商户主动请求，以下request.body为payermax对订单状态的回调内容，您在收到回调后需要响应

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
code	string	Yes	maxLength: 32	回调通知码，APPLY_SUCCESS代表有效回调
msg	string	Yes	maxLength: 256	回调通知码描述，Success.
keyVersion	string	Yes	maxLength: 8	密钥版本，当前版本1
appId	string	Yes	maxLength: 64	商户应用Id，PayerMax分配给商户应用的唯一标识
merchantNo	string	Yes	maxLength: 32	商户号，商户与PayerMax业务签约时生成的唯一标识
notifyTime	string	Yes	maxLength: 32	通知时间，符合rfc3339规范，格式：yyyy-MM-dd'T'HH:mm:ss.SSSXXX
notifyType	string	Yes	maxLength: 16	通知类型 PAYOUT
data	object	Yes		数据体
data.outTradeNo	string	Yes	maxLength: 64, minLength: 1	商户订单号
data.tradeNo	string	Yes	maxLength: 64	PayerMax交易流水号
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	maxLength: 32	交易完成时间，符合rfc3339规范，格式：yyyy-MM-dd'T'HH:mm:ss Z
data.bounceBackTime	string	No	maxLength: 32	退票时间，符合rfc3339规范，格式：yyyy-MM-dd'T'HH:mm:ss Z
data.redeemCode	string	No	maxLength: 32	1.FAWRY取款码，2.运营商充值PIN码
data.expiryTime	string	No	maxLength: 32	订单过期时间，符合rfc3339规范，格式：yyyy-MM-dd'T'HH:mm:ss Z
data.status	string	Yes	maxLength: 32	交易状态，SUCCESS成功, FAILED失败 ，PENDING进行中，BOUNCEBACK退票
data.subStatus	string	No		交易子状态, 当订单交易状态为PENDING时，PayerMax将提供子状态，展示交易处理进度，具体枚举值请参考：【交易子状态介绍】。未返回可联系技术支持升级。
data.trade	object	Yes		交易信息
data.trade.amount	string	Yes	maxLength: 12	商户在请求中传入的交易金额，单位元
data.trade.currency	string	Yes	maxLength: 3	商户在请求中传入的交易金额对应货币代码
data.source	object	Yes		付款信息（商户）
data.source.amount	string	Yes	maxLength: 12	付款方-扣款金额
data.source.currency	string	Yes	maxLength: 3	付款方-扣款币种
data.source.exchangeRate	string	No	maxLength: 16	交易币种转换为扣款币种的汇率
data.source.fee	string	No	maxLength: 12	付款方-手续费
data.source.feeCurrency	string	No	maxLength: 3	付款方-手续费币种
data.source.tax	string	No	maxLength: 12	付款方-税费
data.source.taxCurrency	string	No	maxLength: 3	付款方-税费币种
data.destination	object	Yes		收款信息（用户）
data.destination.amount	string	Yes	maxLength: 12	收款方-到账金额
data.destination.currency	string	Yes	maxLength: 3	收款方-到账币种
data.destination.exchangeRate	string	No	maxLength: 16	交易款币种转换为到账币种的汇率
data.destination.fee	string	No	maxLength: 12	收款方-手续费
data.destination.feeCurrency	string	No	maxLength: 3	收款方-手续费币种
data.destination.tax	string	No	maxLength: 12	收款方-税费
data.destination.taxCurrency	string	No	maxLength: 3	收款方-税费币种
data.reference	string	No	maxLength: 512	附加数据，商户上送的值
data.notifyPhone	string	No	maxLength: 32	收款方通知邮件手机号
data.notifyEmail	string	No	maxLength: 64	收款方通知邮件地址
data.responseCode	string	No	maxLength: 32	订单失败错误码，详见【错误码】
data.responseMsg	string	No	maxLength: 256	订单失败错误码描述
data.additionalIdentifier	object	No		交易附加信息，出款回调升级到3.0版本以上，才会返回该字段。如有需求，可以联系PayerMax技术支持进行调整
data.additionalIdentifier.referenceId	string	No		收款银行/机构的交易单号（依据历史经验，目前仅沙特BankTransfer返回的该单号可以作为凭证跟收款行确认是否到账，交易单号格式如：20240418SAARNBARNB1B44410558522170）

Example

{
  "code": "APPLY_SUCCESS",
  "data": {
    "destination": {
      "amount": "30.00",
      "currency": "IDR",
      "exchangeRate": "1.0000000000",
      "fee": "0.00",
      "feeCurrency": "IDR",
      "tax": "0.00",
      "taxCurrency": "IDR"
    },
    "source": {
      "amount": "31.00",
      "currency": "IDR",
      "exchangeRate": "1.0000000000",
      "fee": "1.00",
      "feeCurrency": "IDR",
      "tax": "0.00",
      "taxCurrency": "IDR"
    },
    "trade": {
      "amount": "30.00",
      "currency": "IDR"
    },
    "additionalIdentifier": {
      "referenceId": "2024041710121481030100166528590615003"
    },
    "fundsFreezeTime": "2024-04-17T06:35:09 +0000",
    "fundsReturnTime": "2024-04-18T07:13:01 +0000",
    "transactionUtcTime": "2023-03-08T10:22:05 +0000",
    "payFinishTime": "2023-03-08T10:23:05 +0000",
    "expiryTime": "2023-03-12 02:37:37",
    "bounceBackTime": "",
    "reference": "Excepteur in non Ut elit",
    "status": "SUCCESS",
    "redeemCode": "123456",
    "tradeNo": "20230308080847PO7777298223436669001",
    "outTradeNo": "outTradeNo167823423411",
    "notifyPhone": "18168567713",
    "notifyEmail": "example@gmail.com",
    "responseCode": "",
    "responseMsg": ""
  },
  "keyVersion": "1",
  "appId": "6666c83333a24666674497c444a33333",
  "merchantNo": "010213834123456",
  "msg": "Success.",
  "notifyTime": "2023-03-08T16:22:05 +0000",
  "notifyType": "PAYOUT"
}

Responses

200

Field	Type	Required	Constraints	Description	Enum
msg	string	Yes		响应 ‘Success’(仅代表成功收到通知,不代表订单状态)
code	string	Yes		仅可响应 ‘SUCCESS’(仅代表成功收到通知,不代表订单状态)

Response Example: 1

成功示例

{
  "msg": "Success",
  "code": "SUCCESS"
}

Response Example: 2

异常示例

{
  "bizCode": "9998",
  "message": "data is invalid"
}