Gkash API

Refund

Server-to-server Request

Method : POST
Content Type: application/json
Staging URL : https://api-staging.pay.asia/api/payment/refund

NOTE

Refund returns funds to the customer before settlement. (Before money is settled with the merchant.)

Request Parameters

Parameter	Type	Required	Description	Example
version	String	Yes	Version number. Constant string: ‘1.3.1’.	1.3.1
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

Response Parameters

Parameter	Type	Required	Description	Example
status	String	Yes	status	00 - RefundSuccessful 01 - Refund Failed
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 Request

                    
                             { 
                        
                            "status" :
                            "00 - Refund Successful"

                            "description" :
                            "SUCCESS"

                            "CID" :
                            "M102-U-999"

                            "POID" :
                            "M102-PO-999"

                            "cartid" :
                            "GkashPO-12345"

                            "currency" :
                            "MYR"

                            "amount" :
                            "100.00"
                        
                             }