Chargent Order Credit
Overview
A credit transaction may be used to apply a credit to a bank account without a prior transaction.
Prequisites
Conditions
- The payment gateway must support bank account credits without a prior transaction.
- The Gateway Setup Wizard advanced settings must be used to configure the payment gateway.
- A Chargent Order must be created with the Credit Amount amount field set to the amount to credit the bank account.
- 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. |
Create Chargent Order Credit
Flow Action
| Action Name | Label | Category |
|---|
| apex-ChargentBase_FlowPaymentsCredits | Chargent Payments Credits | Chargent Payments |
Flow Method
| Method Name | Input | Input Type | Output | Output Type |
|---|
| refund() | CreditInput | List<CreditInput> | CreditOutput | List<CreditOutput> |
| Property | Type | Description |
|---|
| orderId | String | The Chargent Order ID to apply the credit. |
CreditOutput Properties
| Property | Type | Description |
|---|
| status | Boolean | Success or failure status for the payment refund action. |
| message | String | The detailed message for the result of the payment refund action. |
| transactionId | String | The transaction ID associated with refund to the Chargent Order. |
Learn More
Learn more about Sending Credits.