Skip to content

Dynamic billing descriptor

Last updated: February 1, 2023

The billing descriptor is the text that is displayed on the customer's credit card statement identifying a purchase from a merchant’s website. This descriptor can be set dynamically in a payment request.

Information

If you would like to enable this functionality, please contact our Support team.

Parameters

Field nameDescription

billing_descriptor

optional

object

Details about the billing descriptor.

billing_descriptor.name

required

string

Dynamic description of the charge.

Up to 25 characters

Allowed characters:

  • Uppercase: A-Z
  • Lowercase: a-z
  • Numbers: 0-9
  • Special characters: . ! * - = _

billing_descriptor.city

required

string

City from which the charge originated.

Up to 13 characters

Allowed characters:

  • Uppercase: A-Z
  • Lowercase: a-z
  • Numbers: 0-9

Note

Do not use # in your descriptor as this will cause a validation error.

Example

1
{
2
  "billing_descriptor": {
3
    "name": "test payment",
4
    "city": "Anytown"
5
  }
6
}