Dynamic Descriptors

How it Works

Descriptors

Transaction descriptors describe a particular payment in order to help to identify that transaction on a bank statement or online bank interface. A good practice to help minimize the risk of chargeback and in turn, to save money! Provide your customers with your brand name and contact information to help them recognize their purchase, that’s all it takes to make descriptors work for your business.

Dynamic Descriptors

These type of descriptors describe a specific product or service and can vary from one merchant to another. If your website sells applications or software services, this type of descriptor can be a great way to let your customers know what they bought. Usually customers know the name of an application they purchased and they will therefore recognize that name on their bank statement.

The text that appears on the cardholders statement will be made up of:

  1. A “Prefix”, which is a static text value up to 12 characters long that is the same for every transaction followed by.
  2. The dynamic value, which is sent in by the website with the transaction. Length is detailed in pseudo-code below.

If there is no dynamic value sent with the transaction then we also store a “default” value that will be displayed instead of the combination above.

The “Prefix” will be right space padded up to 2, 7 or 12 characters, whichever is the shortest.

Support and Activation

Currently Dynamic Descriptors is only available on TSYS Saratoga terminal IDs. They are available on XML, Hosted Payment Page and Virtual Terminal transactions. The RESTful interface does not support this feature.

Merchant Request

If required, the merchant must raise a support ticket to request that this feature be enabled on their Terminal ID. We will require 3 values to be able to enable this:

  1. The Terminal ID that it is to be enabled on.
  2. The “Prefix” string up to 12 characters long.
  3. The “Default” string up to 25 characters long.

Overview of Implementation

Merchant Access & Configuration

Dynamic Descriptors are implemented using Worldnet s “custom fields” functionality. When the feature is enabled on the terminal ID any user that has “Terminal Setup” permissions, and therefore access to the Settings ⇒ Custom Fields control panel

A new section for the Dynamic Descriptors is shown on the Custom Fields control panel. This will allow the user to assign the desired custom field to be the Dynamic Descriptor. A single custom field may be used by all possible integrations (Example above), or a different custom field can be set per different integration method. Note that “Other” will cover the XML gateway.

Implementation/Integration

As stated above, the dynamic value for the transaction must be sent along with the transaction parameters as a custom fields with the correct name, as defined by the merchant when they configured the Dynamic Descriptors. Please refer to the Integrator Guide document for details about how to send custom fields with transactions.

Logic Flow

The logic of how Dynamic Descriptors are handled by our host is described in this pseudo-code:

if (Terminal ID allows Dynamic Descriptors)
	if (Prefix is not blank AND correct custom field is sent and valid)
		Set the Dynamic Descriptor to the Prefix value followed by a “*” character and then the sent custom field value, and then truncated to 25 characters.
	else if (Default value is not blank)
		Set the Dynamic Descriptor to the first 25 characters of the Default value.
	end if
else
	Set the Dynamic Descriptor to the “terminal merchant name” value from the terminal settings.
end if

A valid custom field value in not blank and contains only letters numbers and spaces.

The terminal merchant name it's provided when the terminal is configured and can be requested to the support team.

Examples

Terminal cases with Dynamic descriptor enabled.

Add Details Configured and Sent

Terminal merchant name = “Pivotal Example” Dynamic Descriptor Prefix = “Order N” Dynamic Descriptor Default Value = “Storename” Custom Field value = “1234

  • a) If a transaction is sent with order number “1234”, the result would be: Order N 1234.
  • b) If a transaction is sent with no order number, the result would be: Storename.

No default

Terminal merchant name =”Pivotal Example” Dynamic Descriptor Prefix= “Order N” Dynamic Descriptor Default = “” Custom Field value = “Order Number

  • a) If a transaction is sent with order number “1234”, the result would be: Order N 1234.
  • b) If a transaction is sent with no order number, the result would be: Pivotal Example.

No Default and no Prefix

Terminal merchant name =”Pivotal Example” Dynamic Descriptor Prefix = “” Dynamic Descriptor Default = “” Custom Field value = “”

  • a) If a transaction is sent, the result would be: Pivotal Example.
Except where otherwise noted, content on this wiki is licensed under the following license: CC Attribution-Share Alike 4.0 International