Chargent Order Credit

Overview

A credit transaction may be used to apply a credit to a bank account without a prior transaction.

Prequisites

Conditions

1. The payment gateway must support bank account credits without a prior transaction.
2. The Gateway Setup Wizard advanced settings must be used to configure the payment gateway.
3. A Chargent Order must be created with the Credit Amount field set to the amount to credit the bank account.
4. A Payment Method with bank account type must be assigned to the Chargent Order.

Resources

There are multiple prerequisite resources depending on the call method that must be created before requesting a payment authorization.

Object	Definition
Chargent Order	Chargent Orders are central objects to payments lifecycle management.
Payment Method	Payment Methods are instruments that may be used to make or take payment.

Workflow

Step	Result
Create Credit Chargent Order	A Chargent Order is created with a credit amount.
Create Payment Method Tokenization	A Payment Method Tokenization is created with a bank account type.
Assign Payment Method to Chargent Order	A Payment Method with a bank account type is assigned to a Chargent Order with a credit amount.

Create Chargent Order Credit

Resource URL

HTTP Request	URL
POST	/services/apexrest/ChargentBase/orders/chargent-orders/{{orderId}}/credits

Request

JSON Example

{}

Response

JSON Example

{
    "logs": [
        {
            "interactionStatus": "APPROVED",
            "id": "{{logId}}",
            "gatewayResultCode": "122",
            "gatewayId": "{{gatewayId}}",
            "createdDate": "2023-10-19T18:34:44.000Z"
        }
    ],
    "gatewayResponse": {
        "gatewayToken": "{{token}}",
        "gatewayResultCodeDescription": "Your check was successfully refunded.",
        "gatewayResultCode": "122",
        "gatewayMessage": "Your check was successfully refunded.",
        "gatewayDate": "2023-10-19T18:34:44.978Z",
        "gatewayAuthorizationCode": ""
    },
    "credit": {
        "status": "Approved",
        "requestDate": "2023-10-19T18:34:44.978Z",
        "id": "{{transactionId}}",
        "effectiveDate": "2023-10-19T18:34:44.978Z",
        "creditNumber": "{{creditNumber}}"
    }
}

Learn More

Learn more about Sending Credits.