Refund - ZenPayments

The refund method is used to refund/void an authorized or settled transaction. This method will void or reverse the transaction based on the card network.

Important: We do not allow refunds without transaction.id and an amount that exceeds the captured of the original transaction.

We support additional data for a refund request. If no amount is specified in the request, the system will return the full amount of the original transaction. You need to provide any discount and tax amount that was in the original transaction to perform a partial refund.

Important: In a refund request if the amount is present but the order.tax and order.discounts amounts are not present, the amount must be less than or equal to the subtotal amount of the original order.

The system will create a new transaction id for all refund transactions.

If the original transaction has been settled, the new transaction id created by the return will be processed offline and will not generate an auth code.
If the original transaction has not been settled, we link the original transaction to the return transaction. The gateway automatically reverses the transaction and an auth code will be generated.

Object

Fields	Description	Type	Filterable	Required	Readonly
id	Unique ID of the refund record	Integer	Yes	No	Yes
terminal	Terminal Object	Object	No	Yes	No
terminal.id	Dashboard Terminal ID	Integer	Yes	Yes	No
amount	Amount of the refund	Number	No	No	No

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Body Params application/json

Example

{
    "id": 883,
    "amount": "1.99",
    "origin": "API",
    "type": "Return",
    "level": 1,
    "authCode": null,
    "parent": {
        "id": 882
    },
    "terminal": {
        "id": 24
    },
    "threeds": {
        "id": null
    },
    "card": {
        "bin": 530957,
        "name": null,
        "number": 2257,
        "exp": "2030-12-31",
        "verification": {
            "cvv": null,
            "address": null
        },
        "networkTransactionId": null
    },
    "contact": null,
    "externalId": null,
    "isRecurring": "No",
    "split": null,
    "refunded": false,
    "captured": false,
    "history": [],
    "order": null,
    "feeTransaction": null,
    "batch": {
        "id": null,
        "number": null,
        "batchedOn": null
    },
    "ip": {
        "address": "216.73.161.60",
        "isp": "Ipxo Limited",
        "type": "hosting",
        "location": {
            "city": "New York",
            "state": "NY",
            "country": "US",
            "zip": "10013"
        },
        "info": {
            "isAnonymous": "Yes",
            "isAnonymousVpn": "No",
            "isPublicProxy": "No",
            "isHostingProvider": "Yes",
            "isTorExitNode": "No"
        }
    },
    "status": {
        "status": "Approved",
        "reason": null
    },
    "updatedOn": "2023-05-09 15:51:36",
    "createdOn": "2023-05-09 15:51:36"
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200Refund

application/json

Body

Example

{
    "id": 883,
    "amount": "1.99",
    "origin": "API",
    "type": "Return",
    "level": 1,
    "authCode": null,
    "parent": {
        "id": 882
    },
    "terminal": {
        "id": 24
    },
    "threeds": {
        "id": null
    },
    "card": {
        "bin": 530957,
        "name": null,
        "number": 2257,
        "exp": "2030-12-31",
        "verification": {
            "cvv": null,
            "address": null
        },
        "networkTransactionId": null
    },
    "contact": null,
    "externalId": null,
    "isRecurring": "No",
    "split": null,
    "refunded": false,
    "captured": false,
    "history": [],
    "order": null,
    "feeTransaction": null,
    "batch": {
        "id": null,
        "number": null,
        "batchedOn": null
    },
    "ip": {
        "address": "216.73.161.60",
        "isp": "Ipxo Limited",
        "type": "hosting",
        "location": {
            "city": "New York",
            "state": "NY",
            "country": "US",
            "zip": "10013"
        },
        "info": {
            "isAnonymous": "Yes",
            "isAnonymousVpn": "No",
            "isPublicProxy": "No",
            "isHostingProvider": "Yes",
            "isTorExitNode": "No"
        }
    },
    "status": {
        "status": "Approved",
        "reason": null
    },
    "updatedOn": "2023-05-09 15:51:36",
    "createdOn": "2023-05-09 15:51:36"
}