Charge description (API)
The charge description is a field that we provide to the acquiring bank during a transaction. It is a basic description of the transaction that is shown on the customer’s bank statement.
This page explains how to include a charge description in your requests.
There are two methods that can be used to include chargedescription in requests submitted to the acquiring bank:
- Method 1: By assigning a default charge description to your account:
Using this method, the charge description is automatically included in transactions processed on your account, with no additional configuration required. To configure your account to use this method, contact our Support Team, requesting to configure a default charge description.
- Method 2: By manually including a charge description in your requests:
Using this method allows you to specify a different charge description on a request-by-request basis.
Submitting charge description in a request
You will need to update the payload submitted within your JWT to include an additional field, as shown below. Submitting the charge description in this way will always override any value stored on your account or inherited from a parent.
|chargedescription||Alphanumeric including spaces and special characters||25||The charge description is a field that we provide to the acquiring bank during a transaction. It is a basic description of the transaction that is shown on the customer’s bank statement.
The charge description is returned in the response JWT if it has been sent to the acquiring bank.
Supported request types
The charge description fields can be submitted in the following requests:
Inheriting from parent requests
If you do not submit the chargedescription in a request, and a parent transaction reference is specified, the chargedescription is inherited from said parent, unless the parent request type is AUTH or REFUND.