Contents

Charge description

 

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

The following is an example of a request where the chargedescription is included. Submitting the charge description in this way will always override any value stored on your account or inherited from a parent.


#!/usr/bin/python
import securetrading

stconfig = securetrading.Config()
stconfig.username = "webservices@example.com"
stconfig.password = "Password1^"
st = securetrading.Api(stconfig)

auth = {
  "sitereference": "test_site12345",
  "requesttypedescriptions": ["AUTH"],
  "accounttypedescription": "ECOM",
  "currencyiso3a": "GBP",
  "baseamount": "1050",
  "orderreference": "My_Order_123",
  "chargedescription": "TEST DESCRIPTOR",
  "cachetoken": "token_posted_by_st.js"
}

strequest = securetrading.Request()
strequest.update(auth)
stresponse = st.process(strequest) #stresponse contains the transaction response
<?php

if (!($autoload = realpath(__DIR__ . '/../../../autoload.php')) && !($autoload = realpath(__DIR__ . '/../vendor/autoload.php'))) {
  throw new Exception('Composer autoloader file could not be found.');
}
require_once($autoload);

$configData = array(
  'username' => 'webservices@example.com',
  'password' => 'Password1^',
);

$requestData = array(
  'sitereference' => 'test_site12345', 
  'requesttypedescriptions' => array('AUTH'),
  'accounttypedescription' => 'ECOM',
  'currencyiso3a' => 'GBP',
  'baseamount' => '1050',
  'orderreference' => 'My_Order_123',
  'chargedescription' => 'TEST DESCRIPTOR',
  'cachetoken' => 'token_posted_by_st.js'
);

$api = Securetradingapi($configData);
$response = $api->process($requestData);
var_dump($response->toArray());

?>
curl --user webservices@example.com:Password1^ https://webservices.securetrading.net/json/ -H "Content-type: application/json" -H "Accept: application/json" -X POST -d '{
"alias":"webservices@example.com",
"version": "1.00",
"request": [{
  "currencyiso3a": "GBP",
  "requesttypedescriptions": ["AUTH"],
  "sitereference": "test_site12345",
  "baseamount": "1050",
  "orderreference": "My_Order_123",
  "accounttypedescription": "ECOM",
  "chargedescription": "TEST DESCRIPTOR",
  "cachetoken": "token_posted_by_st.js"
}]}'

 

Field specification

Field name Type Length Request Response Description
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.

 

Additional notes

Supported request types

The charge description fields can be submitted in the following requests:

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.