Result Query
- Endpoint:
POST /delSuffixStart5 - Tags: Collection Service
Description
Note that the request address does not contain the interface description in brackets
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 | maxLength: 30 | Merchant ID assigned by PayerMax. | |
bizType | string | Yes | maxLength: 30 | Business type. Value 'payTransQuery' needs to be passed here. | |
version | string | Yes | maxLength: 5 | API version, currently always pass '2.5'. | |
orderId | string | Yes | maxLength: 64 | Merchant order ID. |
Example
json
{
"bizType": "payTransQuery",
"merchantId": "SP12345678",
"orderId": "154391186666",
"version": "2.5"
}Responses
200
| Field | Type | Required | Constraints | Description | Enum |
|---|---|---|---|---|---|
data | object | Yes | Response body,refer to the below【data parameters】 | ||
data.totalAmount | string | Yes | maxLength: 12 | Transaction amount transferred from merchant. Value range: [1, 100000000], up to two decimal places.Note: Bahrain, Kuwait, Jordan, Omar,Tunisia, the local currency only supports two decimal places; In Indonesia, Taiwan (China), South Korea, Vietnam, Chile,Pakistan, Colombia, Japan, Iceland, Paraguay, the local currency does not support decimal amounts.See【Supported Country/Region and Currency】 | |
data.currency | string | Yes | maxLength: 8 | Transaction currency transferred from merchant, in capital letters. See 【Country & Region Codes】 | |
data.payAmount | string | Yes | maxLength: 12 | Payment amount actually paid by the user. | |
data.payCurrency | string | Yes | maxLength: 8 | Transaction currency transferred from merchant, in capital letters. See 【Country & Region Codes】 | |
data.exchangeRate | string | No | maxLength: 16 | Exchange rate used to convert transaction amount to payment amount. Returned when the transaction currency and payment currency are not the same. | |
data.tradeNo | string | Yes | maxLength: 64 | PayerMax platform order number. | |
data.orderId | string | Yes | maxLength: 64 | Merchant order number. | |
data.status | number | Yes | The order status: 0-Pending, 1-Success, 2-Failed. This parameter shows the current order status. | ||
data.errorCode | string | Yes | maxLength: 64 | Error code for payment failure. Empty string if payment is successful. | |
data.errorMsg | string | Yes | maxLength: 256 | Error message for payment failure. Empty string if payment is successful. | |
data.reference | string | No | maxLength: 512 | The parameters passed in by the merchant are exactly the same as the reference in the request parameters. | |
data.paymentMethodType | string | No | maxLength: 16 | Payment method | |
data.targetOrg | string | No | maxLength: 16 | Target organization | |
data.cardInfo | string | No | maxLength: 256 | Card information cardOrg:Card organization, returned when the paymentMethod is CARD, only returned when the transaction is successful and the user chooses card organization to pay cardIdentifierNo:Card number, when the paymentMethod is CARD, the mask returns cardIdentifierName:Card name, when the paymentMethod is CARD, the mask returns | |
data.channelNo | string | No | maxLength: 64 | Channel Order No. | |
data.thirdChannelNo | string | No | maxLength: 64 | third channel No | |
data.paymentCode | string | No | maxLength: 64 | VA No | |
bizCode | string | Yes | Response code | ||
message | string | No | maxLength: 256 | Response msg |
Response Example
json
"\n \"data\": {\n \"totalAmount\": \"1\",\n \"currency\": \"USD\",\n \"channelNo\": \"DMCP000000000177005\",\n \"thirdChannelNo\": \"4ikqJ6ktEqyRawE1dvqb9c\",\n \"paymentCode\": \"2312121212\",\n \"payAmount\": \"78\",\n \"payCurrency\": \"INR\",\n \"exchangeRate\": \"78\",\n \"tradeNo\": \"TRADE201812040812430212755\",\n \"orderId\": \"15439118556646\",\n \"status\": 1, \n \"errorCode\": \"\", \n \"errorMsg\": \"\", \n \"reference\":\"Item157\"\n },\n \"bizCode\": \"0000\"\n}"