Setting soft descriptors

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 DBA name, address, and contact information.

Confirming 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
  }
}

Parameters

The following table describes the softDescriptors parameter:

Object	Type	Description
`dba_name`	string	This is the DBA (Doing business as) name. This could be a merchant name, product, or service. Limited to 38 alphanumeric characters.
`street`	string	This is the merchant's street address.
`city`	string	This is the merchant's city.
`region`	string	This is the merchant's state as a two-character postal abbreviation (US only).
`postal_code`	string	This is the merchant's postal code.
`country_code`	string	Merchant's country as a three-digit code (refer to the Country code reference).
`merchant_contact_info`	string	Merchant's phone number or email address. This is limited to thirteen characters for both Visa and Discover transactions.

Adding 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"
    }
}