Tokenization in Ecommerce requires encrypting a customer card as a source token using the relevant Ecommerce API endpoint. Clover uses this token to process secure payments.

Ecommerce integration types and tokenization

• Clover iframe (inline frame) and API Integration—Complete the Ecommerce API flow using an OAuth API token and the source token. This integration allows secure card data entry through the inline payment form and returns a tokenized card for use with the Clover payment system with a reduced PCI compliance burden.
• Clover API-only integration—Complete the OAuth flow using an OAuth API token to generate an Ecommerce API key (PAKMS key). Use this static key to identify the merchant requesting tokenization and then authorize the tokenization of a card. To use the API-only integration in production, you must have (or use a service that has) a PCI DSS certification.

🚧

IMPORTANT

Clover reserves the right to disable keys suspected of misuse and violation of our terms. If needed, you can send an email to: [email protected]to request the deactivation of an Ecommerce API key.

Generate a card token

Step 1: Encrypt card data

1. Retrieve the public encryption keys from CDN. These keys generally do not change and should be cached by your application. The endpoint returns:

• TA_PUBLIC_KEY_DEV for use in the sandbox environment, and
• TA_PUBLIC_KEY_PROD for use in the production environment

{
  "TA_PUBLIC_KEY_DEV": "...",
  "TA_PUBLIC_KEY_PROD": "..."
}

2. Do the following to encrypt the card information. See the following code: Java example.
   • Parse the Base64 public key string (returned by the CDN). Obtain the modulus and exponent.
   • Generate an RSA public key using the modulus and exponent values.
   • Prepend the prefix value to the card number.
   • Using the public key, encrypt the combined prefix and card number.
   • Base64 encode the resulting encrypted data into a string. This string is the encrypted_pan value in the /v1/tokens request.

Step 2: Tokenize encrypted card data

1. Generate an Ecommerce API key or apiAccessKey.
2. Create a token request containing a card object with its required fields:

3. Set the Ecommerce API key or apiAccessKey as the value of the apikey header and send a POST request to the /v1/tokens endpoint. See Create a card token in the API reference for more information.

curl --request POST \
  --url 'https://token-sandbox.dev.clover.com/v1/tokens' \
  --header 'accept: application/json' \
  --header 'apikey: {apiAccessKey}' \
  --header 'content-type: application/json' \
  --data '{"card":{"encrypted_pan":"{encrypted_card_number}", "transarmor_key_id":"{transarmor_key_id}","first6":"601136","last4":"6668","exp_month":"12","exp_year":"2021","cvv":"123","brand":"DISCOVER"}}'

The server returns a source token that begins with clv_. With a source token, you can create a charge, create and pay for orders, accept tips, and save customer cards for future transactions.

Clover provides several sandbox test cards that you can use when developing your app.

Related topics

• Ecommerce integration types
• Generate an OAuth API token or access_token
• Generate an Ecommerce API key (PAKMS key)
• Blog: How does tokenization work?
• Blog: Ecommerce Tokenization: Understanding Methods that Keep Card Data Safe
• API reference: Create a card token
• Tutorial: Save a card for future transactions