v1

latestOpenAPI 3.0.12026-07-242871595.3 MB
CARD

Read a card's track data using a Clover device

A call to this endpoint initiates a read card operation on a Clover device and returns the card track data. The data will be encrypted unless the card read is not a financial card or the card's BIN has been allowlisted.

post/v1/card/read

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.

Response

The card was read.

cardholderNamestring
encryptedboolean
expstring
first6string
firstNamestring
last4string
lastNamestring
panstring
track1string
track2string
track3string