支付成功通知商户

• Endpoint: POST /collectResultNotifyUrlForBillPayment
• Tags: 收单/账单支付

Description

对客扣款成功后，PayerMax会自动入账并将调用该接口通知商户入账结果，商户可仅响应code和msg，无需响应data。

注：如商户希望PayerMax先不处理入账，可联系PayerMax进行相应配置。配置完成后，PayerMax 会根据商户的入账结果进行处理，方式有如下两种：

• 商户可同步响应入账结果，即接收到该通知后，可将入账确认结果响应到data中。
• 商户可异步通知PayerMax入账结果，即调用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: 8	返回码
msg	string	Yes	maxLength: 256	返回描述
keyVersion	string	Yes	maxLength: 8	密钥版本。当前值为：1
merchantAppId	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	通知类型REPAYMENT_RECEIPT
data	object	Yes
data.tradeToken	string	Yes	maxLength: 64	PayerMax订单号。
data.outTradeNo	string	Yes	maxLength: 64	订单号。注：该单号由PayerMax生成。
data.referenceNo	string	Yes	maxLength: 64	商户的还款合同号，其中前五位由PayerMax生成。
data.payStatus	string	Yes	maxLength: 32	支付状态. PAY_SUCCESS
data.totalAmount	number	Yes		订单金额。
data.currency	string	Yes	maxLength: 3	订单币种。
data.completeTime	string	Yes	maxLength: 32	用户真实付款的时间。
data.paymentSucceedTime	string	No	maxLength: 32	支付完成时间。
data.payerMobileNumber	string	Yes	maxLength: 64	付款人手机号。
data.payerEmail	string	No	maxLength: 64	付款人邮箱。
data.paymentDetails	array[object]	Yes		支付详情。
data.paymentDetails[].paymentMethodType	string	Yes	maxLength: 16	用户选择的支付方式。
data.paymentDetails[].targetOrg	string	Yes	maxLength: 32	用户选择的目标机构。

Example

{
  "merchantAppId": "04d20279df234fe8871d1da97c781234",
  "code": "APPLY_SUCCESS",
  "keyVersion": "1",
  "merchantNo": "01011382731234",
  "msg": "Success.",
  "notifyTime": "2024-02-27T10:59:08.295Z",
  "notifyType": "REPAYMENT_RECEIPT",
  "data": {
    "tradeToken": "T20240131032712345123456",
    "outTradeNo": "outTradeNo001",
    "referenceNo": "TEST100001",
    "payStatus": "PAY_SUCCESS",
    "totalAmount": 40.85,
    "currency": "PHP",
    "completeTime": "2024-02-27T11:00:51.185Z",
    "paymentSucceedTime": "2024-02-27T11:05:32.124Z",
    "payerMobileNumber": "50976123",
    "payerEmail": "123@example.com",
    "paymentDetails": [
      {
        "paymentMethodType": "BILL_PAYMENT",
        "targetOrg": "GCASH"
      }
    ]
  }
}

Responses

200

Field	Type	Required	Constraints	Description	Enum
code	string	Yes		返回码，’SUCCESS’代表成功
msg	string	Yes		返回描述，’Success’
data	object	No		响应data。注：本data体可选填，但如果返回了data，data内的各字段类型和必填性描述如下。
data.referenceNo	string	Yes	maxLength: 64	商户的还款合同号，其中前五位由PayerMax生成。
data.tradeToken	string	Yes	maxLength: 64	PayerMax订单号。
data.amount	number	Yes		订单金额
data.currency	string	Yes	maxLength: 3	订单币种
data.confirmation	string	Yes	maxLength: 16	商户入账确认的结果。"Y"或"N"。注：为N时PayerMax不会对该笔做结算。
data.failureReason	string	No	maxLength: 255	商户入账确认失败的原因。注意：confirmation为N时，该值必填。

Response Example

{
  "code": "SUCCESS",
  "msg": "Success",
  "data": {
    "referenceNo": "TEST100001",
    "tradeToken": "T20240131032712345123456",
    "amount": 40.85,
    "currency": "PHP",
    "confirmation": "Y",
    "failureReason": ""
  }
}