Use existing multi-pay tokens
Merchants/developers using TransArmor® tokens can now process payments with Clover by converting the TA token into a multi-pay CLV token using these steps.
North America—United States and Canada
Use your existing TransArmor token (TA) multi-pay token with the create a charge and pay for an order endpoints.
Prerequisites
- Create an ecommerce app integration on the Global Developer Dashboard. See Get started with the Global Developer Dashboard.
- Generate a PAKMS key.
- Create a multi-pay token to use as the existing TransArmor® token.
Create a multi-pay Clover token
- Send a POST request to the v1/tokens endpoint.
- Expand the
external_token
object. - Enter the required information:
token_value
—Value of the TransArmor token.token_type
—Type of the multi-pay token, such as TransArmor.exp_month
—Card expiration month in 2-digit format. Format: mmexp_year
—Card expiration year in 2- or 4-digit format. Format: yy or yyyy
- In the
apikey
header, enter theapiAccessKey
from the PAKMS endpoint.
In the response, a multi-pay token is returned. This token is alphanumeric and begins with clv_. Example: clv_1ABCDefgHI23jKL4m5nOPqR
Request and response example—Create a multi-pay Clover token
curl --request POST \
--url 'https://token-sandbox.dev.clover.com/v1/tokens' \
--header 'apikey: 7aacxxxx-xxxx-xxxx-xxxx-xxxxxxxxcae2' \
--header 'accept: application/json' \
--header 'content-type: application/json' \
--data '{
"external_token": {
"transarmor_token_attribute": {
"exp_month": "12",
"exp_year": "2027"
},
"token_value": 1234567890,
"token_type": "TRANSARMOR"
}
}
{
"id": "clv_1ABCDefgHI23jKL4m5nOPqR",
"object": "token",
"card": {
"last4": ""
}
}
Option 1: Create a charge with an existing multi-pay token
- Send a POST request to the v1/charges endpoint.
- Enter the required information:
amount
currency
source
- Under the
stored_credentials
object, select SUBSEQUENT as thesequence
.
The response returns a multi-pay token. You can use this token for recurring and multi-pay transactions.
Request and response example—Create a charge with a multi-pay token
curl --request POST \
--url 'https://scl-sandbox.dev.clover.com/v1/charges' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer ab86****-****-****-****-*****9867833' \
--header 'Content-Type: application/json' \
--header 'x-forwarded-for: {client_ip}' \
--data '{
"ecomind": "ecom",
"amount": 122,
"currency": "USD",
"capture": false,
"source": "clv_1ABCDefgHI23jKL4m5nOPqR",
"stored_credentials": {
"initiator": "MERCHANT",
"sequence": "SUBSEQUENT",
"is_scheduled": false
}
}'
{
"id": "3NHSD5ESJE0JE",
…
"saved_credentials_on_file": {
"tokenType": "TRANSARMOR",
"value": "122754**********"
}
…
}
Option 2: Pay for an order with an existing multi-pay token
- Send a POST request to v1/orders/{orderId}/pay endpoint.
- Enter the required information:
orderId
source
- Under the
stored_credentials
object, select SUBSEQUENT as thesequence
.
The response returns a multi-pay token. You can use this token for recurring and multi-pay transactions.
Request and response example—Pay for an order with a multi-pay token
curl --location 'https://scl-sandbox.dev.clover.com/v1/orders/3NHSD5ESJE0JE/pay' \
--header 'Authorization: Bearer ab86****-****-****-****-*****9867833' \
--header 'X-Clover-Merchant-Id: A2J94abcde851' \
--header 'Content-Type: application/json' \
--data '{
"source": "clv_1ABCDefgHI23jKL4m5nOPqR",
"stored_credentials": {
"initiator": "MERCHANT",
"sequence": "FIRST",
"is_scheduled": false
}
}'
{
"id": "3NHSD5ESJE0JE",
…
"saved_credentials_on_file": {
"tokenType": "TRANSARMOR",
"value": "122754**********"
}
…
}
Related topics
- Create a multi-pay token
- Create Clover token from an external token endpoint
- Create a charge endpoint
- Create a charge tutorial
- Pay for an order endpoint
- Pay for an order tutorial
Updated 14 days ago