Dynamic Descriptors

Specifies the card acceptor descriptor details to show up on the cardholder's statement. This is currently only supported for a handful of banks, and must be enabled before use.

Dynamic Descriptors are specified by the field descriptor of type Hash.
Required "descriptor" fields are name and location and they are both of type String. Alternatively you can provide the raw descriptor field in lieu of name and location.

Note: If the length of the values exceeds the maximum you will receive a validation error. It is also important to note that the values may be truncated or reflected differently based on how card issuers display these values to their customers.

Field

Type

Description

name

String

The card descriptor name to show on the customers statement. Maximum 20 characters

location

String

The card descriptor location to show on the customers statement. Maximum 13 characters

raw

String

A raw descriptor value which can be presented instead of the name and location values. Maximum 38 characters.

{
  "extra": {
    "descriptor": {
      "name": "Biz Name Pty",
      "location": "Surry Hills"
    }
  }
}
{
  "extra": {
    "descriptor": {
      "raw": "Biz Name Pty Surry Hills NSW AU"
    }
  }
}