支付成功通知商户
- Endpoint:
POST /collectResultNotifyUrlForBillPayment - Tags: 收单/账单支付
Description
对客扣款成功后,PayerMax会自动入账并将调用该接口通知商户入账结果,商户可仅响应code和msg,无需响应data。
注:如商户希望PayerMax先不处理入账,可联系PayerMax进行相应配置。配置完成后,PayerMax 会根据商户的入账结果进行处理,方式有如下两种:
- 商户可同步响应入账结果,即接收到该通知后,可将入账确认结果响应到data中。
- 商户可异步通知PayerMax入账结果,即调用PayerMax提供的商户入账结果确认接口。
Parameters
| Field | Type | Required | Description |
|---|
Content-Type (header) | string | Yes | |
sign (header) | string | Yes | 签名信息请参考技术文档 |
Request Body
| Field | Type | Required | Description |
|---|
code | string | Yes | 返回码 |
msg | string | Yes | 返回描述 |
keyVersion | string | Yes | 密钥版本。当前值为:1 |
merchantAppId | string | Yes | 商户应用Id,PayerMax分配给商户应用的唯一标识 |
merchantNo | string | Yes | 商户号,商户与PayerMax业务签约时生成的唯一标识 |
notifyTime | string | Yes | 通知时间,符合rfc3339规范,格式:yyyy-MM-dd'T'HH:mm:ss.SSSXXX |
notifyType | string | Yes | 通知类型REPAYMENT_RECEIPT |
data | object | Yes | |
data.tradeToken | string | Yes | PayerMax订单号。 |
data.outTradeNo | string | Yes | 订单号。注:该单号由PayerMax生成。 |
data.referenceNo | string | Yes | 商户的还款合同号,其中前五位由PayerMax生成。 |
data.payStatus | string | Yes | 支付状态. PAY_SUCCESS |
data.totalAmount | number | Yes | 订单金额。 |
data.currency | string | Yes | 订单币种。 |
data.completeTime | string | Yes | 用户真实付款的时间。 |
data.paymentSucceedTime | string | No | 支付完成时间。 |
data.payerMobileNumber | string | Yes | 付款人手机号。 |
data.payerEmail | string | No | 付款人邮箱。 |
data.paymentDetails | array[object] | Yes | 支付详情。 |
data.paymentDetails[].paymentMethodType | string | Yes | 用户选择的支付方式。 |
data.paymentDetails[].targetOrg | string | Yes | 用户选择的目标机构。 |
Responses
200
| Field | Type | Required | Description |
|---|
code | string | Yes | 返回码,’SUCCESS’代表成功 |
msg | string | Yes | 返回描述,’Success’ |
data | object | No | 响应data。注:本data体可选填,但如果返回了data,data内的各字段类型和必填性描述如下。 |
data.referenceNo | string | Yes | 商户的还款合同号,其中前五位由PayerMax生成。 |
data.tradeToken | string | Yes | PayerMax订单号。 |
data.amount | number | Yes | 订单金额 |
data.currency | string | Yes | 订单币种 |
data.confirmation | string | Yes | 商户入账确认的结果。"Y"或"N"。注:为N时PayerMax不会对该笔做结算。 |
data.failureReason | string | No | 商户入账确认失败的原因。注意:confirmation为N时,该值必填。 |