Payment Terminals

Retrieve a list of payment terminals

GET

https://partner-api.monta.com

/api/v1/payment-terminals

Required scope: payment-terminals:read

Retrieve a list of payment terminals › query Parameters

page

integer · int32

page number to retrieve (starts with 0)

Default: 0

perPage

integer · int32

number of items per page (between 1 and 100, default 10)

Default: 10

serial

string | null

Allows to filter list of terminals by a serial

Example: XYZ123-DF-123

teamId

integer | null · int64

Allows to filter list of terminals by a team id.

Example: 19

includeDeleted

boolean | null

If true, deleted entities will be included in the response.

Example: true

Retrieve a list of payment terminals › Responses

List of payment terminals that match the criteria

OffsetBasedResponse_39

PaymentTerminal[] · required

MontaPage.Meta · required

GET/api/v1/payment-terminals

curl https://partner-api.monta.com/api/v1/payment-terminals \
  --header 'Authorization: Bearer <token>'

Example Responses

{
  "data": [
    {
      "id": "payter_123",
      "type": "payter",
      "teamId": 0,
      "payingTeamId": 1234,
      "idTag": "04A1B2C3D4E5F6",
      "chargePointIds": [
        0
      ],
      "serial": "XYZ123-DF-123",
      "name": "MyPaymentTerminal 042",
      "isConnected": true,
      "connectedAt": "2022-05-12T15:56:45.99Z",
      "createdAt": "2022-05-12T15:56:45.99Z",
      "updatedAt": "2022-05-12T15:56:45.99Z",
      "deletedAt": "2022-05-12T15:56:45.99Z"
    }
  ],
  "meta": {
    "itemCount": 0,
    "currentPage": 0,
    "perPage": 0,
    "totalPageCount": 0,
    "totalItemCount": 0
  }
}

json

application/json

Create a local payment terminal

POST

https://partner-api.monta.com

/api/v1/payment-terminals/local

Create a local (offline) payment terminal owned by the given team.
Required scope: payment-terminals:write

Create a local payment terminal › Request Body

CreateLocalPaymentTerminalDto

teamId

integer · int64 · required

The team that owns the local payment terminal.

Example: 19

payingTeamId

integer · int64 · required

The team that pays for charges started on this terminal.

Example: 19

idTag

string · minLength: 1 · required

The id tag (or prefix) used to authorize charges on this terminal.

Example: ABC123

idTagPrefix

boolean · required

If true, the id tag is treated as a prefix (any tag starting with this value is accepted).

Example: false

name

string · minLength: 1 · required

Display name of the local payment terminal.

Example: Office Garage Reader

priceLimit

number | null · double · min: 0

Optional spending limit (in the team's currency) per charge.

Example: 20

Create a local payment terminal › Responses

Local payment terminal created

PaymentTerminal

id

string · required

Id of this terminal. NOTE: This is a String

Example: payter_123

type

string · enum · required

Type of this terminal, ie "payter"

Enum values:

payter

local

nayax

cpi

other

Example: payter

chargePointIds

integer[] · required

The charge points ids this terminal is assigned to

serial

string · required

Serial number of the Payment Terminal

Example: XYZ123-DF-123

name

string · required

Name given to the Payment Terminal, defaults to "No Name" if not set by the merchant

Example: MyPaymentTerminal 042

createdAt

string · date-time · required

Date this entity was created

Example: 2022-05-12T15:56:45.99Z

teamId

integer · int64

The team this terminal belongs to

payingTeamId

integer | null · int64

The team charged for sessions started on this terminal. Only set for local terminals

Example: 1234

idTag

string | null

RFID token the charge point authorises with. Only set for local terminals

Example: 04A1B2C3D4E5F6

isConnected

boolean

Indicates if the terminal is connected or disconnected.

Example: true

connectedAt

string | null · date-time

Date this payment terminal did connect

Example: 2022-05-12T15:56:45.99Z

updatedAt

string | null · date-time

Date this entity was updated

Example: 2022-05-12T15:56:45.99Z

deletedAt

string | null · date-time

Date this entity was deleted

Example: 2022-05-12T15:56:45.99Z

POST/api/v1/payment-terminals/local

curl https://partner-api.monta.com/api/v1/payment-terminals/local \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "teamId": 19,
  "payingTeamId": 19,
  "idTag": "ABC123",
  "idTagPrefix": false,
  "name": "Office Garage Reader",
  "priceLimit": 20
}'

Example Request Body

{
  "teamId": 19,
  "payingTeamId": 19,
  "idTag": "ABC123",
  "idTagPrefix": false,
  "name": "Office Garage Reader",
  "priceLimit": 20
}

json

Example Responses

{
  "id": "payter_123",
  "type": "payter",
  "teamId": 0,
  "payingTeamId": 1234,
  "idTag": "04A1B2C3D4E5F6",
  "chargePointIds": [
    0
  ],
  "serial": "XYZ123-DF-123",
  "name": "MyPaymentTerminal 042",
  "isConnected": true,
  "connectedAt": "2022-05-12T15:56:45.99Z",
  "createdAt": "2022-05-12T15:56:45.99Z",
  "updatedAt": "2022-05-12T15:56:45.99Z",
  "deletedAt": "2022-05-12T15:56:45.99Z"
}

json

application/json

Update a local payment terminal

PUT

https://partner-api.monta.com

/api/v1/payment-terminals/local/{terminalId}

Update the paying team, id tag, name, and price limit of a local payment terminal.
Required scope: payment-terminals:write

Update a local payment terminal › path Parameters

terminalId

integer · int64 · required

Update a local payment terminal › Request Body

UpdateLocalPaymentTerminalDto

payingTeamId

integer · int64 · min: 1 · required

idTag

string · minLength: 1 · required

idTagPrefix

boolean · required

name

string · minLength: 1 · required

priceLimit

number | null · min: 0

Update a local payment terminal › Responses

Updated local payment terminal

PaymentTerminal

id

string · required

Id of this terminal. NOTE: This is a String

Example: payter_123

type

string · enum · required

Type of this terminal, ie "payter"

Enum values:

payter

local

nayax

cpi

other

Example: payter

chargePointIds

integer[] · required

The charge points ids this terminal is assigned to

serial

string · required

Serial number of the Payment Terminal

Example: XYZ123-DF-123

name

string · required

Name given to the Payment Terminal, defaults to "No Name" if not set by the merchant

Example: MyPaymentTerminal 042

createdAt

string · date-time · required

Date this entity was created

Example: 2022-05-12T15:56:45.99Z

teamId

integer · int64

The team this terminal belongs to

payingTeamId

integer | null · int64

The team charged for sessions started on this terminal. Only set for local terminals

Example: 1234

idTag

string | null

RFID token the charge point authorises with. Only set for local terminals

Example: 04A1B2C3D4E5F6

isConnected

boolean

Indicates if the terminal is connected or disconnected.

Example: true

connectedAt

string | null · date-time

Date this payment terminal did connect

Example: 2022-05-12T15:56:45.99Z

updatedAt

string | null · date-time

Date this entity was updated

Example: 2022-05-12T15:56:45.99Z

deletedAt

string | null · date-time

Date this entity was deleted

Example: 2022-05-12T15:56:45.99Z

PUT/api/v1/payment-terminals/local/{terminalId}

curl https://partner-api.monta.com/api/v1/payment-terminals/local/:terminalId \
  --request PUT \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "payingTeamId": 1,
  "idTag": "idTag",
  "idTagPrefix": true,
  "name": "name",
  "priceLimit": 0
}'

Example Request Body

{
  "payingTeamId": 1,
  "idTag": "idTag",
  "idTagPrefix": true,
  "name": "name",
  "priceLimit": 0
}

json

Example Responses

{
  "id": "payter_123",
  "type": "payter",
  "teamId": 0,
  "payingTeamId": 1234,
  "idTag": "04A1B2C3D4E5F6",
  "chargePointIds": [
    0
  ],
  "serial": "XYZ123-DF-123",
  "name": "MyPaymentTerminal 042",
  "isConnected": true,
  "connectedAt": "2022-05-12T15:56:45.99Z",
  "createdAt": "2022-05-12T15:56:45.99Z",
  "updatedAt": "2022-05-12T15:56:45.99Z",
  "deletedAt": "2022-05-12T15:56:45.99Z"
}

json

application/json

Retrieve a single payment terminal

GET

https://partner-api.monta.com

/api/v1/payment-terminals/{paymentTerminalId}

Required scope: payment-terminals:read

Retrieve a single payment terminal › path Parameters

paymentTerminalId

string · required

Retrieve a single payment terminal › Responses

Payment Terminal with provided id

PaymentTerminal

id

string · required

Id of this terminal. NOTE: This is a String

Example: payter_123

type

string · enum · required

Type of this terminal, ie "payter"

Enum values:

payter

local

nayax

cpi

other

Example: payter

chargePointIds

integer[] · required

The charge points ids this terminal is assigned to

serial

string · required

Serial number of the Payment Terminal

Example: XYZ123-DF-123

name

string · required

Name given to the Payment Terminal, defaults to "No Name" if not set by the merchant

Example: MyPaymentTerminal 042

createdAt

string · date-time · required

Date this entity was created

Example: 2022-05-12T15:56:45.99Z

teamId

integer · int64

The team this terminal belongs to

payingTeamId

integer | null · int64

The team charged for sessions started on this terminal. Only set for local terminals

Example: 1234

idTag

string | null

RFID token the charge point authorises with. Only set for local terminals

Example: 04A1B2C3D4E5F6

isConnected

boolean

Indicates if the terminal is connected or disconnected.

Example: true

connectedAt

string | null · date-time

Date this payment terminal did connect

Example: 2022-05-12T15:56:45.99Z

updatedAt

string | null · date-time

Date this entity was updated

Example: 2022-05-12T15:56:45.99Z

deletedAt

string | null · date-time

Date this entity was deleted

Example: 2022-05-12T15:56:45.99Z

Delete a payment terminal

DELETE

https://partner-api.monta.com

/api/v1/payment-terminals/{paymentTerminalId}

Soft-deletes the payment terminal identified by {type}_{id} (e.g. payter_123).
Required scope: payment-terminals:delete

Delete a payment terminal › path Parameters

paymentTerminalId

string · required

Delete a payment terminal › Responses

Payment terminal deleted

No data returned

Apply a payment terminal to charge points

PUT

https://partner-api.monta.com

/api/v1/payment-terminals/{paymentTerminalId}/charge-points

Replaces the set of charge points assigned to the payment terminal identified by {type}_{id} (e.g. payter_123). Pass an empty list to clear the assignment. All charge point ids must belong to the payment terminal's team. Only payter, nayax and cpi terminals support this operation.
Required scope: payment-terminals:write

Apply a payment terminal to charge points › path Parameters

paymentTerminalId

string · required

Apply a payment terminal to charge points › Request Body

ApplyChargePoints

charge_point_ids

integer[] · required

Ids of the charge points to assign to the payment terminal. Pass an empty list to clear the current assignment. All ids must belong to the payment terminal's team.

Example: [1,2,3]

Apply a payment terminal to charge points › Responses

Charge points applied to the payment terminal

No data returned

Retrieve payment sessions for a payment terminal

GET

https://partner-api.monta.com

/api/v1/payment-terminals/{type}/{id}/sessions

List the payment sessions performed on the given payment terminal.
Required scope: payment-terminals:read

Retrieve payment sessions for a payment terminal › path Parameters

type

string · enum · required

Payment terminal type. Only session-aware types are supported.

Enum values:

payter

cpi

id

integer · int64 · required

Numeric identifier of the payment terminal.

Retrieve payment sessions for a payment terminal › query Parameters

page

integer · int32

page number to retrieve (starts with 0)

Default: 0

perPage

integer · int32

number of items per page (between 1 and 100, default 10)

Default: 10

Retrieve payment sessions for a payment terminal › Responses

Sessions performed on the payment terminal

OffsetBasedResponse_40

PaymentTerminalSession[] · required

MontaPage.Meta · required

Operators Plans