Refund

Refund API is designed to issue refunds on an existing transaction. This API can't be used to issue standalone refunds or credits.

POST https://<Platform-host>/api/payment/refund

Request Body

Name	Type	Description
amount*	string	Amount to be refunded. Should be less or equal to available transaction amount
id*	string	Transaction ID
reason*	string	Reason for the refund
internalTransactionID	string	An internal ID from integrating system. Will be returned in the response and associated refunds if provided.
metadata	object	Add any additional metadata by passing a json object

200

Refund Response Field Definitions

Field Name	Type	Description	Required?
ID	string	Platform system ID for the sale request	Required
TransactionID	string	Unique transaction ID	Required
MerchantID	string	Merchant ID	Required
reason	string	Reason provided in the request	Required
token	string	Card token used in the original transaction	Required
internalTransactionID	string	An internal ID from integrating system. Will be returned in the response and associated refunds if provided. If not provided in the request, the internalTransactionID from the original sale transaction will be returned	Optional
order_number	string	Order number provided in the original transaction	Optional
Metadata	object	Return all the metadata sent in the request	Optional
ReturnResponse	Object	Refer to Credit Card Sale (SaleResponse) or ACH Sale (AchResponse) object definitions	Required
device	object	Device Object. This would exist for device based transactions	Optional
device.id	string	Device ID
device.type	string	Device Type
device.name	string	Device Name
device.model	string	Device Model
device.serial_number	string	Device Serial Number
device.sdk_version	string	Device SDK Version
device.manufacturer	string	Device Manufacturer
device.app_version	string	Device App Version
device.os	string	Device Operating System
device.os_version	string	Device OS version

Sample Request / Response

Request

Example Request

{
    "id": "9a0df7ef-b77f-4525-97e1-f41a98ad7f75",
    "amount": 10,
    "reason": "Discount issued",
    "internalTransactionID": "121212",
    "metadata": {
        "customerId": "123",
        "email" : "[email protected]"
    }
}

Response

Example Response

{
    "data": {
        "ID": "336cb9f7-3733-4e5a-9ab7-c42a05ebff22",
        "MerchantID": "1e4e6029-2cc9-4b2c-87c1-7a4b2af6d6c6",
        "TransactionID": "0ceec557-418c-476d-a9b2-def89048dc4d",
        "reason": "some reason",
        "internalTransactionID": "121212",
        "token": "card_sandbox_8Aq30HAc8TLFUFvTjqwo556i",
        "ReturnResponse": {
            "status": "PASS",
            "responseCode": "A0000",
            "responseMessage": "Success",
            "authCode": "255385",
            "hostResponseCode": "00",
            "hostReferenceNumber": "497915451651",
            "taskID": "20501784",
            "transactionID": "76968598",
            "transactionTimestamp": "2025-04-02T18:58:21",
            "orderNumber": "59753509",
            "processedAmount": "16.40",
            "externalReferenceID": "59753509",
            "customerReceipt": "        Sandbox US Merchant         \\n        200 Epcot Center Dr         \\n         Orlando, FL 32836          \\n            800-490-8514            \\n                 \\n                 \\n        2025-04-02 06:58 PM         \\n               REFUND               \\n            Card # 1111             \\n          Card Type: VISA           \\n         Entry Mode : KEYED         \\n      Transaction ID: 76968598      \\n        SUBTOTAL: USD $16.40        \\n         TOTAL: USD $16.40          \\n                 \\n                 \\n       NO SIGNATURE REQUIRED        \\n              APPROVED              \\n                 \\n                 \\n                 \\n                 \\n                 \\n                 \\n                 \\n                 \\n                 \\n                 \\n           Customer Copy            \\n",
            "merchantReceipt": "        Sandbox US Merchant         \\n        200 Epcot Center Dr         \\n         Orlando, FL 32836          \\n            800-490-8514            \\n                 \\n                 \\n        2025-04-02 06:58 PM         \\n               REFUND               \\n            Card # 1111             \\n          Card Type: VISA           \\n         Entry Mode : KEYED         \\n      Transaction ID: 76968598      \\n        SUBTOTAL: USD $16.40        \\n         TOTAL: USD $16.40          \\n                 \\n                 \\n      X_______________________      \\nI AGREE TO PAY ABOVE TOTAL AMOUNT IN\\n ACCORDANCE WITH CARD ISSUER's AGREE\\nMENT (MERCHANT AGREEMENT IF CREDIT V\\n              OUCHER)               \\n     KEEP COPY FOR YOUR RECORDS     \\n               \\n \\n                \\n              APPROVED              \\n                 \\n                 \\n                 \\n                 \\n                 \\n                 \\n                 \\n                 \\n                 \\n                 \\n           Merchant Copy            \\n",
            "maskedCardNumber": "1111",
            "cardType": "visa",
            "bank_routing_number":"121122676", // present for ACH Transaction
	    "masked_bank_account":"9020", // present for ACH Transaction
            "returnedAmount": "16.40"
        },
        "Metadata": {
            "customerId": "123",
            "email": "[email protected]"
        },
        "order_number": "150t65898",
        "device": {
            "id":"a42627a7-1368-4f2d-b22e-f78f2d216d3e",
            "type":"pax",
            "name":"Shaun's Mobile",
            "model":"S24",
            "serial_number":"1234de30e5fcfcbb7819c18e264ce4000dd0",
            "sdk_version":"1.0.0",
            "manufacturer": "Pax",
            "app_version": "1.0.0 (1)",
            "os": "android",
            "os_version": "14" 
        }
    }
}