Set soft descriptors

United States

Soft descriptors let merchants provide customers with information about the business that processed a charge with the Ecommerce API. These descriptors appear on the customer's card statements and can include the doing business as (DBA) name, address, and contact information.

Confirm merchant availability

Some Clover merchants are unable to process soft descriptors, and attempts to include them will return a warning in these cases. Before requesting a charge, you can check if a merchant is able to use soft descriptors with the /v3/merchants/{mId}/ecomm_payment_configs or the create a charge endpoint. The response for a merchant that supports soft descriptors will include the following property.

  "softDescriptors": {
    "supported": true


The following table describes the softDescriptors parameter:

dba_namestringThis is the DBA (Doing business as) name. This could be a merchant name, product, or service. Limited to 38 alphanumeric characters.
streetstringThis is the merchant's street address.
citystringThis is the merchant's city.
regionstringThis is the merchant's state as a two-character postal abbreviation (US only).
postal_codestringThis is the merchant's postal code.
country_codestringMerchant's country as a three-digit code (refer to the Country code reference).
merchant_contact_infostringMerchant's phone number or email address. This is limited to thirteen characters for both Discover® and Visa® transactions.

Add soft descriptors

When constructing a charge request, include the soft_descriptor object and any of the properties you want to appear on the statement, for example:

    "amount": 3900,
    "currency": "usd",
    "source": "{cardToken}",
    "soft_descriptor": {
      "dba_name": "Clover",
      "street": "415 N Mathilda Ave",
      "city": "Sunnyvale",
      "region": "CA",
      "postal_code": "94085",
      "country_code": "840",
      "merchant_contact_info": "9015559928"