Skip to main content

Payment Sale Reversal

Overview​

Payment Autorization Reversal will void a previously autorized and captured transaction.

Prerequisites​

There is one prerequisite resource that must be created before requesting a payment refund.

           Object           Definition
Chargent TransactionTransactions record the results of the requests made to the payment gateway on the Chargent Order. Transactions are also used to make additional requests in the payments lifecycle.

Create Payment Authorization Reversal​

Resource URL​

HTTP RequestURL
POST/services/apexrest/ChargentBase/payments/sales/{{transactionId}}/reversals

Request​

JSON Example
{}

Response​

JSON Example
{
    "logs": [
        {
            "interactionStatus": "APPROVED",
            "id": "{{logId}}",
            "gatewayResultCode": "200",
            "gatewayId": "{{gatewayId}}",
            "createdDate": "2023-12-07T20:16:56.000Z"
        }
    ],
    "gatewayResponse": {
        "gatewayToken": "{{token}}",
        "gatewayResultCodeDescription": "",
        "gatewayResultCode": "200",
        "gatewayMessage": "",
        "gatewayDate": "2023-12-07T20:16:56.665Z",
        "gatewayAuthorizationCode": "{{authCode}}"
    },
    "paymentAuthAdjustment": {
        "status": "Approved",
        "requestDate": "2023-12-07T20:16:56.665Z",
        "paymentAuthAdjustmentNumber": "{{authCode}}",
        "id": "{{transactionId}}",
        "effectiveDate": "2023-12-07T20:16:56.665Z"
    }
}

Learn More​

Learn more about Payment Reversals.