Interoperability with Ecommerce API

If the merchant is configured for multipay tokens, the card tokens created using the /v1/card/tokens endpoint can be used for recurring card-not-present payments. This allows you to build an integrated application where a customer's card data is captured in person and then charged in the future without being present.

To check if a merchant is set up for multipay tokens, send a GET request to the /v3/merchants/{mId}/gateway endpoint. In the response, check that the supportsMultiPayToken value is true. You can also see the merchant's credit card surcharge rate in the rate field.

curl --request GET \
  --url 'https://apisandbox.dev.clover.com/v3/merchants/{merchantUUID}/gateway' \
  --header 'accept: application/json'
{
  "accountName": "Sandbox Test Merchant",
  "supportsMultiPayToken": true,
  ...
}

See Creating and using a card token to learn how to create an ECOMM_COMPAT card token and use it to make a charge with the Ecommerce API.

Example use case

A retail store selling soaps may offer a monthly soap subscription mailed to the customer's home. The initial charge is $20, and each month is an additional $15. A new customer could enroll in December for an annual subscription and pay the $20 charge in the store. This transaction uses the REST Pay API to take the payment and create a card token using a Clover device. Then, on the 1st of the each of the following eleven months, the merchant automatically charges the customer $15 for that month's soap using the Ecommerce API /v1/charges endpoint. When the recurring charge is processed, the customer is automatically notified with an emailed receipt.


Did this page help you?