Skip to main content

Terminal

A POS Terminal registered with a PaymentGateway and optionally bound to a Store.

idstring

Unique identifier for the Terminal.

paymentGatewayAccountIdstring

The ID of the PaymentGatewayAccount this Terminal belongs to.

paymentGateway object

Essential information about a PaymentGateway, used when embedded in other resources (e.g., Transactions, Terminals).

idstring

Unique identifier for the PaymentGateway.

namestring

The display name of the PaymentGateway (e.g., "Visa", "Mastercard", "Edenred").

imagestringnullable

URL of the image to display for this PaymentGateway.

typeint32nullable

Null when the PaymentGateway is no longer offered and only survives on historical records.

Possible values: [0, 1, 2]

paymentActionPaymentGateways.CheckoutActionnullable

Null when the PaymentGateway is no longer offered and only survives on historical records.

Possible values: [OTP, REDIRECT, DROPIN]

storeIdstringnullable

The ID of the Store this Terminal is bound to, when applicable.

storeNamestringnullable

The name of the Store this Terminal is bound to, when applicable.

externalIdstring

The identifier assigned to the Terminal by the PaymentGateway provider.

referenceIdstringnullable

The identifier you assigned to the Terminal to reconcile it with your own systems.

namestring

The display name of the Terminal.

brandstringnullable

The brand of the physical device.

modelstringnullable

The model of the physical device.

serialNumberstringnullable

The serial number of the physical device.

statusTerminals.TerminalStatus

Lifecycle status of a Terminal.

Possible values: [Active, Inactive, Deleted]

externalCreatedAtdate-time

The UTC timestamp when the Terminal was created in the PaymentGateway provider system.

externalUpdatedAtdate-timenullable

The UTC timestamp when the Terminal was last updated in the PaymentGateway provider system.

Terminal
{
"id": "string",
"paymentGatewayAccountId": "string",
"paymentGateway": {
"id": "string",
"name": "string",
"image": "string",
"type": 0,
"paymentAction": "OTP"
},
"storeId": "string",
"storeName": "string",
"externalId": "string",
"referenceId": "string",
"name": "string",
"brand": "string",
"model": "string",
"serialNumber": "string",
"status": "Active",
"externalCreatedAt": "2024-07-29T15:51:28.071Z",
"externalUpdatedAt": "2024-07-29T15:51:28.071Z"
}