Overview
A CREDIT transaction puts money onto a card or into a bank account. It is used to deposit funds without an offsetting sale, unlike a refund which is linked to a previous transaction.
Due to sensitive security measures, this type of transaction is only permitted if the account is configured to allow credits and requires only one specific scope definition to be added to a PayConex™ V4 API key.
Note
Additionally, credit transactions must be permitted and enabled by the Payment Processor as well.
Some of the real-world scenarios include:
- Rebates and Incentives: A customer buys a product with a promotional offer that includes a $50 rebate. Instead of sending a physical check, the company credits $50 directly to the customer's bank account or card.
- Compensation for Errors or Issues: A restaurant overcharged a customer but cannot link the correction to the original transaction. They issue a credit directly to the customer's account to compensate for the overcharge.
- Gift and Prepaid Cards: A company issues a prepaid card as a gift for employee appreciation or a holiday bonus. They deposit funds onto the card using a credit transaction.
- Employee Bonuses: A business rewards employees with quarterly bonuses by crediting their accounts directly. For example, $500 is added to a prepaid bonus card for each employee.
Request Example
POST /api/v4/accounts/{accountId}/payments/credit
{
"bfTokenReference": "PAYCONEX_TOKEN",
"posProfile": "ECOMMERCE",
"amounts": {
"total": "5",
"currency": "USD"
}
}
*Required Scopes: pcx:payments:card_not_present:credit
Optional Parameters
With the exception of BillPayment, the CREDIT request mostly shares the same body parameters as the Sale Transaction given it can either be a CIT or MIT. See API Reference.