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 endpoint. The response for a merchant that supports soft descriptors will include the following property

{
  "softDescriptors": {
    "supported": true
  }
}

Adding soft descriptors to a charge

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

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

📘

NOTE

The country_code values can be found in the Country code reference.


Did this page help you?