Contents

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.

Info
The chargedescription is only supported by certain acquirers. For further information, please contact our Support Team.

 

This page explains how to include a charge description in your requests.

 


 

Process overview

There are two methods that can be used to include chargedescription in requests submitted to the acquiring bank:

 

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.

 

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 the additional field chargedescription, as shown below. Submitting the charge description in this way will always override any value stored on your account or inherited from a parent.

You can also include the chargedescription when submitting a request through our Webservices API. We’ve also provided examples of this in the other tabs below:


{"payload":{"accounttypedescription":"ECOM","baseamount":"1050","currencyiso3a":"GBP","sitereference":"test_site12345","chargedescription":"TEST DESCRIPTOR"},"iat":1559033849,"iss":"jwt.user"}
{"alias":"[email protected]","version":"1.00","request":[{"currencyiso3a":"GBP","requesttypedescriptions":["AUTH"],"sitereference":"test_site12345","baseamount":"1050","orderreference":"My_Order_123","accounttypedescription":"ECOM","chargedescription":"TEST DESCRIPTOR","pan":"4111111111111111","expirydate":"12\/2020","securitycode":"123"}]}
<requestblock version="3.67">
  <alias>[email protected]</alias>
  <request type="AUTH">
    <merchant>
      <orderreference>My_Order_123</orderreference>
      <chargedescription>TEST DESCRIPTOR</chargedescription>
    </merchant>
    <billing>
      <payment>
        <expirydate>12/2020</expirydate>
        <pan>4111111111111111</pan>
        <securitycode>123</securitycode>
      </payment>
      <amount currencycode="GBP">1050</amount>
    </billing>
    <operation>
      <sitereference>test_site12345</sitereference>
      <accounttypedescription>ECOM</accounttypedescription>
    </operation>
  </request>
</requestblock>

 

Field specification

Field Format Description
chargedescription
XPath: /merchant/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.

 


 

Additional notes

Supported request types

The charge description fields can be submitted in the following requests using our Webservices API:

Click here for a full list of request types.

 

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.