Terminal-Create

Create a new terminal

curl --request POST \
  --url https://api.example.com/terminal-management/terminals \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <x-api-key>' \
  --header 'x-profile-id: <x-profile-id>' \
  --header 'x-tenant-id: <x-tenant-id>' \
  --data '
{
  "terminal_name": "Store 123 Terminal 1",
  "merchant_id": "mer_1234567890",
  "profile_id": "pro_1234567890",
  "terminal_type": "pos",
  "tms_id": "tms_1234567890",
  "terminal_id_from_tms": "TMS12345",
  "serial_number": "SN12345678",
  "location": {
    "address": "123 Main St",
    "city": "San Francisco",
    "state": "CA",
    "country": "US",
    "postal_code": "94105"
  },
  "capabilities": {
    "emv": true,
    "contactless": true,
    "magstripe": true,
    "pin": true
  },
  "metadata": {}
}
'

{
  "terminal_id": "term_1234567890",
  "terminal_name": "Store 123 Terminal 1",
  "merchant_id": "mer_1234567890",
  "profile_id": "pro_1234567890",
  "organization_id": "org_1234567890",
  "tms_id": "tms_1234567890",
  "terminal_id_from_tms": "TMS12345",
  "serial_number": "SN12345678",
  "terminal_type": "pos",
  "status": "active",
  "last_seen": "2023-11-07T05:31:56Z",
  "location": {
    "address": "123 Main St",
    "city": "San Francisco",
    "state": "CA",
    "country": "US",
    "postal_code": "94105"
  },
  "capabilities": {
    "emv": true,
    "contactless": true,
    "magstripe": true,
    "pin": true
  },
  "metadata": {},
  "created_at": "2023-11-07T05:31:56Z",
  "modified_at": "2023-11-07T05:31:56Z"
}

POST

terminal-management

terminals

Create a new terminal

curl --request POST \
  --url https://api.example.com/terminal-management/terminals \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <x-api-key>' \
  --header 'x-profile-id: <x-profile-id>' \
  --header 'x-tenant-id: <x-tenant-id>' \
  --data '
{
  "terminal_name": "Store 123 Terminal 1",
  "merchant_id": "mer_1234567890",
  "profile_id": "pro_1234567890",
  "terminal_type": "pos",
  "tms_id": "tms_1234567890",
  "terminal_id_from_tms": "TMS12345",
  "serial_number": "SN12345678",
  "location": {
    "address": "123 Main St",
    "city": "San Francisco",
    "state": "CA",
    "country": "US",
    "postal_code": "94105"
  },
  "capabilities": {
    "emv": true,
    "contactless": true,
    "magstripe": true,
    "pin": true
  },
  "metadata": {}
}
'

{
  "terminal_id": "term_1234567890",
  "terminal_name": "Store 123 Terminal 1",
  "merchant_id": "mer_1234567890",
  "profile_id": "pro_1234567890",
  "organization_id": "org_1234567890",
  "tms_id": "tms_1234567890",
  "terminal_id_from_tms": "TMS12345",
  "serial_number": "SN12345678",
  "terminal_type": "pos",
  "status": "active",
  "last_seen": "2023-11-07T05:31:56Z",
  "location": {
    "address": "123 Main St",
    "city": "San Francisco",
    "state": "CA",
    "country": "US",
    "postal_code": "94105"
  },
  "capabilities": {
    "emv": true,
    "contactless": true,
    "magstripe": true,
    "pin": true
  },
  "metadata": {},
  "created_at": "2023-11-07T05:31:56Z",
  "modified_at": "2023-11-07T05:31:56Z"
}

Headers

x-tenant-id

string

required

x-profile-id

string

required

x-api-key

string

required

Body

application/json

terminal_name

string

required

Name of the terminal

Example:

"Store 123 Terminal 1"

merchant_id

string

required

Merchant ID associated with the terminal

Example:

"mer_1234567890"

profile_id

string

required

Profile ID associated with the terminal

Example:

"pro_1234567890"

terminal_type

enum<string>

required

Type of terminal

Available options:

pos,

mpos,

standalone

Example:

"pos"

tms_id

string

TMS provider ID associated with the terminal

Example:

"tms_1234567890"

terminal_id_from_tms

string

Terminal ID from the TMS provider

Example:

"TMS12345"

serial_number

string

Serial number of the terminal

Example:

"SN12345678"

location

object

Location details of the terminal

Show child attributes

location.address

string

Address where the terminal is located

Example:

"123 Main St"

location.city

string

City where the terminal is located

Example:

"San Francisco"

location.state

string

State where the terminal is located

Example:

"CA"

location.country

string

Country where the terminal is located

Example:

"US"

location.postal_code

string

Postal code where the terminal is located

Example:

"94105"

capabilities

object

Capabilities of the terminal

Show child attributes

capabilities.emv

boolean

Whether the terminal supports EMV chip cards

Example:

true

capabilities.contactless

boolean

Whether the terminal supports contactless payments

Example:

true

capabilities.magstripe

boolean

Whether the terminal supports magnetic stripe cards

Example:

true

capabilities.pin

boolean

Whether the terminal supports PIN entry

Example:

true

metadata

object

Additional metadata for the terminal

Response

Terminal created successfully

terminal_id

string

Unique identifier for the terminal

Example:

"term_1234567890"

terminal_name

string

Name of the terminal

Example:

"Store 123 Terminal 1"

merchant_id

string

Merchant ID associated with the terminal

Example:

"mer_1234567890"

profile_id

string

Profile ID associated with the terminal

Example:

"pro_1234567890"

organization_id

string

Organization ID associated with the terminal

Example:

"org_1234567890"

tms_id

string

TMS provider ID associated with the terminal

Example:

"tms_1234567890"

terminal_id_from_tms

string

Terminal ID from the TMS provider

Example:

"TMS12345"

serial_number

string

Serial number of the terminal

Example:

"SN12345678"

terminal_type

enum<string>

Type of terminal

Available options:

pos,

mpos,

standalone

Example:

"pos"

status

enum<string>

Status of the terminal

Available options:

active,

inactive,

pending

Example:

"active"

last_seen

string<date-time>

Timestamp when the terminal was last seen

location

object

Location details of the terminal

Show child attributes

location.address

string

Address where the terminal is located

Example:

"123 Main St"

location.city

string

City where the terminal is located

Example:

"San Francisco"

location.state

string

State where the terminal is located

Example:

"CA"

location.country

string

Country where the terminal is located

Example:

"US"

location.postal_code

string

Postal code where the terminal is located

Example:

"94105"

capabilities

object

Capabilities of the terminal

Show child attributes

capabilities.emv

boolean

Whether the terminal supports EMV chip cards

Example:

true

capabilities.contactless

boolean

Whether the terminal supports contactless payments

Example:

true

capabilities.magstripe

boolean

Whether the terminal supports magnetic stripe cards

Example:

true

capabilities.pin

boolean

Whether the terminal supports PIN entry

Example:

true

metadata

object

Additional metadata for the terminal

created_at

string<date-time>

Timestamp when the terminal was created

modified_at

string<date-time>

Timestamp when the terminal was last modified

API Key - Create Auth

⌘I

Organization

Merchant

Merchant API Key

Terminal

POS

Headers

Body

Response