id
required |
string (uuid)
|
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
friendlyId
required |
string
|
A user-friendly identifier for this register. Required.
nullablemin length 3max length 20
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
name
required |
string
|
A unique name for this register. Optional.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
description
required |
string
|
A brief description of this register and/or its purpose. Optional.
nullablemax length 40
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
enabled
required |
boolean
|
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
terminal1
required |
RegisterTerminal
RegisterTerminal |
A terminal slot on a `MerchantRegister`.
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
Fields of RegisterTerminal:
| Field |
Type |
Description |
|---|
id
required |
string (uuid)
|
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| terminalNumber
required |
string
|
The terminal number assigned to this slot. Optional; typically null.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| masterKeyPointer
required |
string
|
The master key pointer for this slot. Optional; typically null.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| workingKey
required |
string
|
The working key for this slot. Optional; typically null.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| lastRecordNumber
required |
string
|
The last record number seen on this slot. Optional; typically null.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
This body has no documented fields. |
terminal2
required |
RegisterTerminal
RegisterTerminal |
A terminal slot on a `MerchantRegister`.
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
Fields of RegisterTerminal:
| Field |
Type |
Description |
|---|
id
required |
string (uuid)
|
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| terminalNumber
required |
string
|
The terminal number assigned to this slot. Optional; typically null.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| masterKeyPointer
required |
string
|
The master key pointer for this slot. Optional; typically null.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| workingKey
required |
string
|
The working key for this slot. Optional; typically null.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| lastRecordNumber
required |
string
|
The last record number seen on this slot. Optional; typically null.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
This body has no documented fields. |
terminal3
required |
RegisterTerminal
RegisterTerminal |
A terminal slot on a `MerchantRegister`.
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
Fields of RegisterTerminal:
| Field |
Type |
Description |
|---|
id
required |
string (uuid)
|
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| terminalNumber
required |
string
|
The terminal number assigned to this slot. Optional; typically null.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| masterKeyPointer
required |
string
|
The master key pointer for this slot. Optional; typically null.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| workingKey
required |
string
|
The working key for this slot. Optional; typically null.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| lastRecordNumber
required |
string
|
The last record number seen on this slot. Optional; typically null.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
This body has no documented fields. |
terminal4
required |
RegisterTerminal
RegisterTerminal |
A terminal slot on a `MerchantRegister`.
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
Fields of RegisterTerminal:
| Field |
Type |
Description |
|---|
id
required |
string (uuid)
|
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| terminalNumber
required |
string
|
The terminal number assigned to this slot. Optional; typically null.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| masterKeyPointer
required |
string
|
The master key pointer for this slot. Optional; typically null.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| workingKey
required |
string
|
The working key for this slot. Optional; typically null.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| lastRecordNumber
required |
string
|
The last record number seen on this slot. Optional; typically null.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
This body has no documented fields. |
terminal5
required |
RegisterTerminal
RegisterTerminal |
A terminal slot on a `MerchantRegister`.
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
Fields of RegisterTerminal:
| Field |
Type |
Description |
|---|
id
required |
string (uuid)
|
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| terminalNumber
required |
string
|
The terminal number assigned to this slot. Optional; typically null.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| masterKeyPointer
required |
string
|
The master key pointer for this slot. Optional; typically null.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| workingKey
required |
string
|
The working key for this slot. Optional; typically null.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| lastRecordNumber
required |
string
|
The last record number seen on this slot. Optional; typically null.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
This body has no documented fields. |
legacyNumber
required |
integer (int64)
|
The integer key the v1 API addresses this register by (its `RegisterKey`). Server-owned:
allocated once, when the register is first saved, and never reassigned.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|