支付链接更新回调
- Endpoint:
POST /payLinkResultNotifyUrl - 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: 15 | 商户号,商户与PayerMax业务签约时生成的唯一标识 | |
notifyTime | string | Yes | maxLength: 16 | 通知时间,符合rfc3339规范,格式:yyyy-MM-dd’T’HH:mm:ss.SSSXXX | |
notifyType | string | Yes | maxLength: 16 | 通知类型 PAYBYLINK | |
data | object | No | 返回数据体 | ||
data.linkId | string | Yes | maxLength: 64 | PMmax链接唯一单号 | |
data.merchantLinkId | string | Yes | maxLength: 64 | 商户链接唯一订单号 | |
data.linkUrl | string | Yes | maxLength: 256 | PayByLink url | |
data.qrCodeUrl | string | Yes | maxLength: 256 | PayByLink QRcode url | |
data.linkStatus | string | Yes | maxLength: 16 | ACTIVE、EXPIRED | |
data.totalAmount | string | Yes | maxLength: 24 | 商户传入的订单金额,金额的单位为元。 除以下国家外,按照各国币种支持的小数点位上送 注意:巴林、科威特、约旦、阿曼、突尼斯,本币只支持两位小数; 印尼、中国台湾、韩国、越南、智利、巴基斯坦、哥伦比亚、日本、冰岛、巴拉圭,本币不支持带小数金额。 | |
data.country | string | Yes | maxLength: 2 | 国家代码,大写字母,如果所传的国家代码与币种不匹配,则以货币代码对应的地区展示收银台。如指定了支付方式,则国家必须上送,参见【交易支持国家/地区与币种】 | |
data.currency | string | Yes | maxLength: 3 | 币种代码,大写字母,参见【交易支持国家/地区与币种】 | |
data.expiresAt | string | Yes | maxLength: 32 | 链接具体失效时间 | |
data.linkDescription | string | Yes | 链接描述,不展示给用户,用于商户备注 | ||
data.payByLinkInfo | array[object] | Yes | 链接单的交易详情结构体,只会返回成功的支付详情。 | ||
data.payByLinkInfo[].outTradeNo | string | No | maxLength: 64 | 每笔交易订单的唯一标识,当链接没有被打开时,该字段为空 | |
data.payByLinkInfo[].status | string | Yes | maxLength: 32 | 交易状态:SUCCESS、PENDING、CLOSE | SUCCESS, PENDING, CLOSE |
data.payByLinkInfo[].completeAt | string | No | maxLength: 32 | 交易成功时间,仅当交易状态为成功时,返回该时间 | |
data.payByLinkInfo[].paymentDetails | array[object] | No | 支付方式信息,只有交易成功会返回支付方式 | ||
data.payByLinkInfo[].paymentDetails[].targetOrg | string | No | maxLength: 64 | 目标机构,用户支付所选择的目标机构,只有交易成功才会返回用户支付所选择的目标机构 | |
data.payByLinkInfo[].paymentDetails[].paymentMethodType | string | No | maxLength: 64 | 支付方式类型,用户支付选择的支付方式,只有交易成功才会返回用户支付所选择的支付方式 | |
data.payByLinkInfo[].paymentDetails[].cardInfo | object | No | 卡信息 | ||
data.payByLinkInfo[].paymentDetails[].cardInfo.cardOrg | string | No | maxLength: 32 | 卡组织,当paymentMethodType为CARD时返回,只有交易成功且用户选择卡组织支付时才返回 | |
data.payByLinkInfo[].paymentDetails[].cardInfo.country | string | No | maxLength: 2 | 发卡国家 | |
data.payByLinkInfo[].paymentDetails[].cardInfo.cardType | string | No | maxLength: 32 | 卡类型,DEBIT、CREDIT等。 | |
data.payByLinkInfo[].paymentDetails[].cardInfo.totalCardOrg | array[string] | No | 卡的所有卡组织,双标卡会返回两个。 | ||
data.payByLinkInfo[].paymentDetails[].cardInfo.type | string | No | maxLength: 32 | 卡性质。PAN为真实卡;NETWORK_TOKEN为虚拟卡,如APPLEPAY。 | |
data.payByLinkInfo[].paymentDetails[].cardInfo.source | string | No | maxLength: 32 | 卡信息来源。CARD、APPLEPAY、GOOGLEPAY_PAN、GOOGLEPAY_CRYPTOGRAM、NETWORK_TOKEN | |
data.payByLinkInfo[].paymentDetails[].cardInfo.cardBinNo | string | No | maxLength: 16 | 卡bin号。 | |
data.payByLinkInfo[].paymentDetails[].cardInfo.cardNumber | string | No | maxLength: 32 | 卡号,掩码返回。 | |
data.payByLinkInfo[].paymentDetails[].cardInfo.cardHolderName | string | No | maxLength: 128 | 持卡人姓名,掩码返回。 | |
data.payByLinkInfo[].paymentDetails[].cardInfo.cardLast4 | string | No | maxLength: 4 | 真实卡号后四位。 | |
data.payByLinkInfo[].paymentDetails[].cardInfo.cardExpirationYear | string | No | maxLength: 2 | 卡有效年。 | |
data.payByLinkInfo[].paymentDetails[].cardInfo.cardExpirationMonth | string | No | maxLength: 2 | 卡有效月。 | |
data.payByLinkInfo[].paymentDetails[].cardInfo.cardIdentifierNo ⚠️ | string | No | maxLength: 19 | 卡号,当paymentMethodType为CARD时掩码返回 |
Example
json
{
"code": "APPLY_SUCCESS",
"msg": "Success.",
"keyVersion": "1",
"appId": "a801ef1fa1a74db683aed2d768a41df1",
"merchantNo": "020113827303196",
"notifyTime": "2022-10-20T10:00:00.500+08:00",
"notifyType": "PAYBYLINK",
"data": {
"linkId": "jyirffse",
"merchantLinkId": "paybylinktest001",
"totalAmount": "10000",
"country": "ID",
"currency": "IDR",
"linkStatus": "active",
"expiresAt": "2022-11-22T10:00:00.500+08:00",
"linkUrl": "https://www.payermax.link/mtfbpomjw",
"qrCodeUrl": "https://www.payermax.link/images/mtfbpomjwquc/qrcode",
"linkDescription": "link Description",
"payByLinkInfo": [
{
"outTradeNo": "order2022001",
"status": "SUCCESS",
"completeAt": "2022-10-20T10:00:00.500+08:00",
"paymentDetails": [
{
"targetOrg": "",
"paymentMethodType": "CARD",
"cardInfo": {
"cardOrg": "VISA",
"cardNumber ": "625244****9483"
}
}
]
}
]
}
}Responses
200
| Field | Type | Required | Constraints | Description | Enum |
|---|---|---|---|---|---|
code | string | Yes | 返回码,’ SUCCESS’代表成功 | ||
msg | string | Yes | 返回描述,’Success.’ |
Response Example
json
{
"code": "SUCCESS",
"msg": "Suceess."
}Enum Reference
data.payByLinkInfo[].status
SUCCESSPENDINGCLOSE
