Skip to navigation

Get card read status

Returns the status of a card read interaction. result is null while status is pending.

Interactions expire 3 minutes after they’re created. A 404 means the interaction never existed, the device_id is wrong, or the interaction expired.

If a signature was requested on a terminal that doesn’t support it, status is still succeeded: the card was tokenized and only the signature step was skipped. In that case result.error is signature not supported.

Authentication

AuthorizationBearer

Use a Payments API key as the bearer token: Authorization: Bearer <api_key>. Get a fresh key from Refresh API Keys.

Path parameters

device_idstringRequired

Hardware Serial Number (HSN) of the terminal, provided by your Integration Delivery lead.

interaction_idstringRequiredformat: "uuid"

The interaction_id returned when the interaction was created.

Query parameters

midstringOptional

Merchant ID. Required when your bearer token is an ISV token acting on behalf of a merchant. If the mid can't be resolved to an authorized account, the request returns 400.

Response

Interaction status
interaction_idstringformat: "uuid"
The interaction identifier.
statusenum
Status of the interaction.
Allowed values:
resultobject or null

null while pending. On success, contains the card token and details. On failure or cancellation, contains only error.

updated_atstringformat: "date-time"
Time of the last status update.

Errors

401
Unauthorized Error
404
Not Found Error
429
Too Many Requests Error