Vaulting cards for future transactions

Clover's Remote Pay SDKs and Payment Connector SDK, as well as the Developer Pay API and Ecommerce API, provide functions to capture an encrypted card token and store it (vault it) for later use. This allows merchants to process recurring payments or complete in-person transactions more quickly for returning customers. Card tokens are one-way encrypted and can be stored on systems outside of PCI DSS scope.

Prerequisites

Regional limitations (driven by law or regulation) and a merchant's individual settings combine to determine whether card vaulting is allowed for a particular merchant. For example, merchants in Argentina, the UK, and Ireland cannot use the card vaulting features. Further, merchants must be configured to accept and use vaulted cards; this can happen during initial merchant setup or after the fact.

Vaulting with Developer Pay

❗️

IMPORTANT

The Developer Pay API is deprecated and will be retired on October 27th, 2021. All apps should use the Ecommerce API instead. See Migrating from Developer Pay to Ecommerce for more information.

If all of the prerequisites are met, the response from the /v2/merchant/{mId}/pay endpoint includes a token that can be used for subsequent transactions. See Build Payment Solutions - Payment Flow for complete information.

Vaulting with Ecommerce API

Card data sent with the iframe (or to the v1/tokens endpoint) returns a token that can be used for subsequent transactions. See Using the Clover-hosted iframe for complete information.

Vaulting with Remote Pay

The CloverConnector#vaultCard method displays a screen on the Clover device prompting the customer to provide their card data. By default, the customer can swipe, dip, or tap their card. You can adjust the card entry methods allowed during the capture by passing the wanted values to vaultCard().

In the following example, manual card entry is allowed in addition to the defaults.

public void onVaultButtonTap() {
  getCloverConnector().vaultCard(cardEntryMethods.ALL)
}

Vaulting with Payment Connector

The PaymentConnector#vaultCard method displays a screen on the Clover device prompting the customer to provide their card data. By default, the customer can swipe, dip, or tap their card. You can adjust the card entry methods allowed during the capture by passing the wanted values to vaultCard().

In the following example, manual card entry is allowed in addition to the defaults.

public void onVaultButtonTap() {
  paymentConnector().vaultCard(cardEntryMethods.ALL)
}