Asynchronous Notification for Payment
- Endpoint:
POST /delSuffixStart8 - Tags: Collection Service
Parameters
| Field | In | Type | Required | Constraints | Description |
|---|---|---|---|---|---|
sign | header | string | Yes |
Parameter Examples
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 |
|---|---|---|---|---|---|
merchantId | string | Yes | Merchant ID assigned by PayerMax. | ||
tradeOrderNo | string | Yes | Trade order number defined by PayerMax. | ||
orderId | string | Yes | Original merchant order id. | ||
status | number | Yes | 1 - Success; 2 - Failure. | ||
countryCode | string | No | Country code,This parameter will be returned only when the merchant passes in the countrycode in the order interface,refer to 【Country & Region Codes】 | ||
totalAmount | string | Yes | Transaction amount transferred from merchant. | ||
currency | string | Yes | The transaction currency introduced by the merchant. In the US dollar receipt scenario, the currency is US dollars. | ||
payAmount | string | Yes | Payment amount actually paid by the user. | ||
payCurrency | string | Yes | Currency actually paid by the user. | ||
exchangeRate | string | No | Exchange rate used to convert transaction amount to payment amount. Returned when the transaction currency and payment currency are not the same. | ||
errorCode | string | Yes | Error code for payment failure. Empty string if payment success. | ||
errorMsg | string | Yes | Error message for payment failure. Empty string if payment success. | ||
reference | string | No | The parameters passed in by the merchant are exactly the same as the reference in the request parameters. | ||
cardInf | object | No | Card Info. | ||
cardInf.cardOrg | string | No | Card Scheme, will return when the user chooses card scheme to pay | ||
cardInf.cardIdentifierNo | string | No | Card number, the ciphertext is returned when paymentMethodType is CARD. Remarks: If you need to return this field, you can feedback payermax technical support to upgrade the callback version | ||
cardInf.cardIdentifierName | string | No | Card name, returned as a mask when paymentMethodType is CARD. Remarks: If you need to return this field, you can feedback payermax technical support to upgrade the callback version | ||
paymentMethodType | string | No | maxLength: 16 | Payment method | |
targetOrg | string | No | maxLength: 16 | Target organization | |
channelNo | string | No | maxLength: 64 | Channel Order No. | |
thirdChannelNo | string | No | maxLength: 64 | third channel No | |
paymentCode | string | No | maxLength: 64 | VA No | |
orderType | string | Yes | Order type, the default is PAYMENT, when repeated payment is DUPLICATE_PAYMENT | ||
originalOrderId | string | No | When orderType is DUPLICATE_PAYMENT, this value is the original merchant order number associated with the repeated payment, otherwise it is empty. | ||
originalTradeOrderNo | string | No | When orderType is DUPLICATE_PAYMENT, this value is the original trade order number defined by PayerMax associated with the repeated payment, otherwise it is empty. |
Example
json
{
"orderId": "21230412340979178110000805",
"tradeOrderNo": "TOKEN202304111948856115",
"errorCode": "",
"errorMsg": "",
"paymentType": "A34",
"reference": "GM666814221071401199#20230412340979178100000805",
"totalAmount": "33.50",
"payAmount": "33.50",
"merchantId": "SP35661109",
"exchangeRate": "1",
"countryCode": "ID",
"payCurrency": "IDR",
"currency": "IDR",
"channelNo": "DMCP000000000177005",
"thirdChannelNo": "4ikqJ6ktEqyRawE1dvqb9c",
"paymentCode": "2312121212",
"status": 1,
"paymentMethodType": "CARD",
"cardInfo": {
"cardOrg": "MASTERCARD",
"cardIdentifierNo": "520000******0007",
"cardIdentifierName": "*D"
},
"targetOrg": "",
"orderType": "PAYMENT",
"originalOrderId": "",
"originalTradeOrderNo": ""
}Responses
200
| Field | Type | Required | Constraints | Description | Enum |
|---|---|---|---|---|---|
bizCode | string | Yes | maxLength: 6 | Interface response code.The value ‘0000’ only represents the receipt of the notification and does not represent the order status. | |
message | string | No | maxLength: 32 | Interface response message. |
Response Example
json
{
"bizCode": "0000",
"message": "success"
}