Query
Server-to-server Request
Method : POST
Content Type: application/json
Staging URL : https://api-staging.pay.asia/api/payment/query
NOTE
By calling this API, merchant is able to get the details of the specific transaction requested.
Request Parameters
Parameter | Type | Required | Description | Example |
---|---|---|---|---|
version |
String | Yes |
Version number. Constant string: ‘1.3.0’. |
1.3.0 |
CID |
String | Yes | Merchant ID | M102-U-999 |
cartid |
String | Yes | Unique Referece ID(Order ID from Merchant) | GkashPO-12345 |
currency |
String | Yes |
Currency notation (currently only support MYR) ISO 4217 currency code, e.g. MYR |
MYR |
amount |
String | Yes | Payment amount | 100.00 |
signature |
String | Yes |
Refer to SHA512 Hash |
abcdefghijsdf123131234124 |
Example Request
{
"version" :
"1.3.0"
"CID" :
"M102-U-999"
"cartid" :
"GkashPO-12345"
"currency" :
"MYR"
"amount" :
"100.00"
"signature" :
"abcdefghijklmnopqrstuvwxyz0123456780"
}
Server-to-server Response
Method : POST
Content Type: application/json
NOTE
- Upon receving and processing the query request, GKash unified payment system would respond in a synchronous way.
- Merchant should not rely on the status return from web-to-web response, should rely the status on CallbackURL
Response Parameters
Parameter | Type | Required | Description | Example |
---|---|---|---|---|
refundstatus |
String | Yes | Refund status |
00 - Refund Successful 01 - Refund Failed |
refundamount |
String | Yes | Refund amount | 100.00 |
refunddate |
String | Yes | Refund date | 2020-10-22 00:00:00 |
status |
String | Yes | Payment status |
88 - Transferred 66 - Failed 11 - Pending |
description |
String | Yes | Payment description | SUCCESS |
CID |
String | Yes | Merchant ID | M102-U-999 |
POID |
String | Yes | Gkash's Unique Referece No.(Issue by GKash) | M102-PO-999 |
cartid |
String | Yes | Merchant's Unique Referece ID(Order ID from Merchant) | GkashPO-12345 |
currency |
String | Yes |
Currency notation (currently only support MYR) ISO 4217 currency code, e.g. MYR |
MYR |
amount |
String | Yes | Payment amount | 100.00 |
Example Response
{
"refundstatus" :
"00 - Refund Successful"
"refundamount" :
"100.00"
"refunddate" :
"2020-10-22 00:00:00"
"status" :
"88 - Transferred"
"description" :
"SUCCESS"
"CID" :
"M102-U-999"
"POID" :
"M102-PO-999"
"cartid" :
"GkashPO-12345"
"currency" :
"MYR"
"amount" :
"100.00"
}