v1

latestOpenAPI 3.0.12026-07-242871595.3 MB

CARD

Create a card token for use with subsequent payments

A call to the token endpoint is used to create either a single-use or multi-pay token that can be used for subsequent transactions. Note: Tokenization through REST Pay Display API is not supported in Europe.

post/v1/card/tokens

Headers

User-Agentstring required

Identifies the application, operating system, vendor, and/or version of the requesting user agent. Format: <AppName>/<Version> <Comment>

X-Clover-Device-Idstring required

The Clover device to route the request to.

X-POS-Idstring required

An identifier for the POS making the request.

X-Clover-Timeoutinteger

The amount of time, in seconds, that this operation will process before timing out. A value of 0 indicates no timeout will be enforced by Remote Pay, although protocol specified timeouts may still apply.

Idempotency-Keystring

The idempotency key transmitted during the request, if any.

Request body

cardEntryMethodsCardEntryMethod[]

A collection of supported card entry methods for the operation.

tokenTypestring

The type of token requested. If not specified, a Clover legacy token will be returned. Supported values: ECOMM_COMPAT

Example request

{
  "tokenType": "ECOMM_COMPAT"
}

Response

A token was created.

expirationDatestring ####

A four-digit number representing the expiraction month (first two digits) and year (last two digits)

first6string ######

The first 6 digits

last4string ####

The last 4 digits

namestring

tokenstring

A string representing a token which may be used in a future payment operation

tokenTypestring

Example response

{
  "last4": "1234"
}