Payment inquiry

• Endpoint: POST /v2/delSuffixStart11
• Tags: Disbursement

Description

This interface is the API payment query interface. Please pay attention to the following matters when returning parameters of this interface, otherwise there may be a risk of capital loss:

1. When "bizCode": "0000" and status is returned, it means the query is successful. Please refer to status for order status;
2. When "bizCode": "4000" and "message": "The queried transaction does not exist", the same result is returned after multiple queries at intervals (5 minutes). You can place an order again without changing the orderId;
3. In other scenarios, please check the parameters and request again;

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
bizType	string	Yes	maxLength: 32	Business type. Value “paymentTransQry” needs to be passed here.
merchantId	string	Yes	maxLength: 32	Merchant ID assigned by PayerMax
orderId	string	No	maxLength: 63	Merchant order ID,Set at least one of the Merchant order ID and the PayerMax platform order number (tradeNo). Merchant order ID is given priority as the query condition.
tradeNo	string	No	maxLength: 64	PayerMax platform order number,Set at least one of the Merchant order ID (orderId) and the PayerMax platform order number. Merchant order ID is given priority as the query condition.
version	string	No	maxLength: 5	API version, currently always as “2.0”.

Example

{
  "bizType": "paymentTransQry",
  "merchantId": "SP12345678",
  "orderId": "WD12324345346",
  "tradeNo": "20230428081551DO1234524600475529002",
  "version": "2.0"
}

Responses

200

Field	Type	Required	Constraints	Description	Enum
bizCode	string	Yes	maxLength: 6	Response code, which indicates only whether the request is accepted. For disbursement result, please check the field “status” from callback or query API.
message	string	Yes	maxLength: 256	Response message.
data	object	Yes		Response data.
data.debit	string	Yes	maxLength: 512	Payer information(Merchant)
data.destination	string	Yes	maxLength: 512	Payee information(user)
data.source	string	Yes	maxLength: 512	Trade information
data.orderId	string	No	maxLength: 63	Merchant order ID.
data.passBackParams	string	No	maxLength: 512	A pass-through parameter, returned as-is in the notification callback
data.payFinishTime	number	No		The time when the order succeeds or fails, only exists when the order reaches its final state.
data.bounceBackTime	number	No		The time when the order bounced back（only appears in bounceback state）
data.redeemCode	string	No	maxLength: 32	1. FAWRY withdrawal code, 2. Carrier recharge PIN code
data.expiryTime	number	No		The lastest time the order can be withdrawn(appears only offline)
data.responseCode	string	No	maxLength: 32	Business response code
data.responseMsg	string	No	maxLength: 256	Business response message.
data.status	number	Yes		Disbursement status: 1- success, 2-failure,3-pending,4-bounceback
data.subStatus	string	No		Transaction sub-status. When the transaction status of an order is PENDING,PayerMax provides sub-statuses to display the transaction processing progress. For specific enumeration values, please refer to:【Transaction Sub-Status Introduction】. If not returned, please contact technical support for an upgrade.
data.tradeNo	string	No		PayerMax platform order number.
data.transactionUtcTime	number	Yes		Transaction UTC time.
data.fundsFreezeTime	string	No		Fund transfer time, comply with rfc3339 specification, format: yyyy-MM-dd'T'HH:mm:ss Z, the callback version needs to be upgraded to 3.0 to have this field. If necessary, you can contact PayerMax technical support for adjustment.
data.fundsReturnTime	string	No		Fund return time, comply with rfc3339 specification, format: yyyy-MM-dd'T'HH:mm:ss Z, the callback version needs to be upgraded to 3.0 to have this field. If necessary, you can contact PayerMax technical support for adjustment.
data.additionalIdentifier	string	No		Additional transaction information, this field will be returned only after the withdrawal callback is upgraded to version 4.0 or above. If necessary, you can contact PayerMax technical support for adjustments.

Response Example: 1

成功示例

{
  "bizCode": "0000",
  "data": {
    "debit": "{\"amount\":\"14551.00\",\"currency\":\"IDR\",\"exchangeRate\":\"14551.3328650147\",\"fee\":\"0.00\",\"feeCurrency\":\"USD\",\"tax\":\"0.00\",\"taxCurrency\":\"USD\"}",
    "destination": "{\"amount\":\"14551.00\",\"currency\":\"IDR\",\"exchangeRate\":\"14551.3328650147\",\"fee\":\"0.00\",\"feeCurrency\":\"IDR\",\"tax\":\"0.00\",\"taxCurrency\":\"IDR\"}",
    "fundsFreezeTime": "2024-04-17T06:35:09 +0000",
    "fundsReturnTime": "2024-04-18T07:13:01 +0000",
    "orderId": "dev_1639483955",
    "passBackParams": "this is passBackParams",
    "payFinishTime": 1639483970000,
    "source": "{\"amount\":\"1.00\",\"currency\":\"USD\"}",
    "status": 1,
    "tradeNo": "WD20211214121226853360448",
    "transactionUtcTime": 1639483946000,
    "additionalIdentifier": "{\"referenceId\":\"2024041710121481030100166528590615003\"}"
  },
  "message": "success"
}

Response Example: 2

异常示例

{
  "msg": "System is busy, please try again later.",
  "code": "SYSTEM_ERROR"
}