Transaction Inquiry

After the payment is completed, the merchant can call the payment query API to query the payment transaction information.

Regarding the transaction status and error code returned by payment query, please refer: 【Transaction Status/Errorcode List】.

Note:

The API will only return the corresponding error code when the transaction status is "Failed" or "BOUNCEBACK".

For details, please refer: API

Endpoint：paymentOrderQry Sign rule：[Rule](https://docs.shareitpay.in/#/30?page_id=647 "Rule")

Request and response data format: application/json

1.Request parameters

Parameter	Type	Is it required	The Max. length	Description	Example value
version	String	M	8	API version. Current value: 1.1	1.1
keyVersion	String	M	8	key version. Current value: 1	1
requestTime	String	M	32	Request time, in line with rfc3339 specification, format: yyyy-MM-dd'T'HH:mm:ss.SSSXXX	2022-01-22T10:00:00.500+08:00
appId	String	M	64	Merchant App Id, the unique identifier assigned to the merchant app by PayerMax	46153e2b787241ae8b01857bb087d1bd
merchantNo	String	O	32	Merchant ID, the unique identifier generated when the merchant signs the contract with PayerMax	10229810189301
+data	object	M		request data body
「outTradeNo	String	M	63	Original Merchant Txn ID	ORDER123

2.Response parameters

Parameter	Type	Is it required	The Max. length	Description	Example value
code	String	M	32	API response code, 'APPLY_SUCCESS' means the interface call is successful	APPLY_SUCCESS
msg	String	M	256	Response description, 'Success.'	Success
+data	Object	C		response data body
「outTradeNo	String	C	63	Merchant Txn ID	ORDER123
「tradeNo	String	C	64	PayerMax transaction serial Order ID	20220429052556PO71330000270184
「status	String	C	32	Transaction status, SUCCESS: succeeded;FAILED: failed; PENDING: in progress, BOUNCEBACK: bounceback	FAILED
「transactionUtcTime	String	M	32	Transaction creation time, conforming to rfc3339 specification, format: yyyy-MM-dd'T'HH:mm:ss Z	2022-12-14T06:35:38 +0000
「payFinishTime	String	O	32	Transaction completion time, in line with rfc3339 specification, format: yyyy-MM-dd'T'HH:mm:ss Z	2022-12-14T06:35:38 +0000
「bounceBackTime	String	O	32	Order bounced back time, in line with rfc3339 specification, format: yyyy-MM-dd'T'HH:mm:ss Z	2022-12-14T06:35:38 +0000
「redeemCode	String	O	32	1. FAWRY withdrawal code, 2. Carrier recharge PIN code	FAWRY withdrawal code: ABCD123445670, please refer to the PIN code exchange process table for PIN code
「expiryTime	String	O	32	Order expiration time, in line with rfc3339 specification, format: yyyy-MM-dd'T'HH:mm:ss Z	2022-12-14T06:35:38 +0000
「+trade	Object	M	512	Trading Information
『amount	String	M	12	The payment amount passed in by the merchant in the request (yuan)	1
『currency	String	M	3	The currency code corresponding to the disbursement amount passed in by the merchant in the request	USD
「+source	Object	M		Payment Information (Merchant)
『amount	String	M	12	Payer - Deduction Amount	14551
『currency	String	M	3	Payer - Deduction Currency	IDR
『exchangeRate	String	O	16	The exchange rate for converting the disbursement currency to the deduction currency	14551.332865014
『fee	String	O	12	Payer - handling fee	0
『feeCurrency	String	O	3	Payer - handing fee currency	USD
『tax	String	O	12	Payer - Tax fee	0
『taxCurrency	String	O	3	Payer - Tax fee currency	USD
「+ destination	Object	M		Payee Information (User)
『amount	String	M	12	Payee received Amount	14000
『currency	String	M	3	Payee Currency	IDR
『exchangeRate	String	O	16	The exchange rate for converting the source currency to the target currency	14551.332865014
『fee	String	O	12	Payee - handling fee	551
『feeCurrency	String	O	3	Payee - handing fee currency	IDR
『tax	String	O	12	Payee - Tax fee	0
『taxCurrency	String	O	3	Payee - Tax fee Currency	IDR
「reference	String	O	512	Additional data, the value sent by the merchant	USER10002
「notifyPhone	String	C	32	Payee notification phone number	081234567890
「notifyAddress	String	C	64	Payee notification email address	123456@123.com
「responseCode	String	C	32	Order failed error code，please refer to: [Errorcode List]	AMOUNT_NOT_ENOUGH
「responseMsg	String	C	256	Order failed error code description	Insufficient balance

3.Request Example

Request example:

{
    "version": "1.1",
    "keyVersion": "1",
    "requestTime": "2022-01-17T07:51:15.597+00:00",
    "appId": "a0dddd1f622243cb9aa1b676e808b5f8",
    "merchantNo": "02021382719993",
    "data": {
        "outTradeNo": "P1642410680681"
    }
}

Response example:

{
	"code": "APPLY_SUCCESS",
	"msg": "",
	"data": {
		"outTradeNo": "P1642410680681",
		"tradeNo": "20220429052556PO71330000270184",
		"status": "SUCCESS",
		"trade": {
			"amount": "100.12",
			"currency": "IDR"
		},
		"transactionUtcTime": "2022-01-17T09:33:54.540+00:00",
		"payFinishTime": "2022-01-17T09:33:54.540+00:00",
		"bounceBackTime": "2022-01-17T09:33:54.540+00:00",
		"expiryTime": "2022-01-17T09:33:54.540+00:00",
		"redeemCode": "1234444",
		"source": {
			"amount": "100.12",
			"currency": "IDR",
			"fee": "100.12",
			"feeCurrency": "IDR",
			"tax": "100.12",
			"taxCurrency": "IDR",
			"exchangeRate": "14551.3328650147"
		},
		"destination": {
			"amount": "100.12",
			"currency": "IDR",
			"fee": "100.12",
			"feeCurrency": "IDR",
			"tax": "100.12",
			"taxCurrency": "IDR",
			"exchangeRate": "14551.3328650147"
		},
		"reference": "020213827524152",
		"notifyEmail": "123456@123.com",
		"notifyPhone": "081234567890",
		"responseCode": "AMOUNT_NOT_ENOUGH",
		"responseMsg": "Insufficient balance",
	}
}