Sign In     Back

Transaction Refund API

In order to mark a transaction as refund, you can call the below API.

This API call will be done when you want to Refund a particular transaction. After the API call, that Successful Transaction will be marked as Refund.

Note: You can not request for refund of the transactions which is already marked as suspicious or chargeback.

Request Parameter *

Paramters Required Data Type Description
api_key Yes String API key from your account.
order_id Optional String Value you returned from Transaction API.
customer_order_id Optional String Merchant side unique transaction Ref.
URL -
https://portal.gatewaypay.io/api/refund
Method - POST

Note: order_id or customer_order_id, You should pass at-least one Parameter. Both Parameters can be passed as well.

Response

DESCRIPTION OF SUCCESS JSON PARAMETER

status : success means transaction found in our system.

IF TRANSACTION NOT FOUND IN RECORD.

{
    "status": "fail",
    "message": "Transaction not found."
}
After successful CURL request example :

If there will be no validation errors in request, response will be like:


{
    "status": "success",
    "message" : "Refund Updated Successfully!"
}