Skip to main content

Payment Authorization Capture

Overview​

Payment Authorization Capture will capture a previously authorized 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 Capture​

Resource URL​

HTTP RequestURL
POST/services/apexrest/ChargentBase/payments/authorizations/{{transactionId}}/captures

Request​

JSON Example
{}

Response​

JSON Example
{
    "logs": [
        {
            "interactionStatus": "APPROVED",
            "id": "{{logId}}",
            "gatewayResultCode": "200",
            "gatewayId": "{{gatewayId}}",
            "createdDate": "2023-12-07T00:53:28.000Z"
        }
    ],
    "gatewayResponse": {
        "gatewayToken": "{{token}}",
        "gatewayResultCodeDescription": "",
        "gatewayResultCode": "200",
        "gatewayMessage": "",
        "gatewayDate": "2023-12-07T00:53:28.625Z",
        "gatewayAuthorizationCode": ""
    },
    "payment": {
        "status": "Approved",
        "requestDate": "2023-12-07T00:53:28.625Z",
        "id": "{{transactionId}}",
        "effectiveDate": "2023-12-07T00:53:28.625Z"
    }
}

Learn More​

Learn more about Payment Captures.