Bavindo
  1. Terminal
Bavindo
API
  • API
  • Webhook
  • v1
    • Terminal
      • POS Connected Terminals
        GET
    • Payment
      • POS Payment Create
      • POS Payment Cancel
      • Get Payment Details
      • POS Payment Refund Referenced
    • NFC
      • NFC Transaction Start/Continue
      • NFC Transaction Stop
  1. Terminal

POS Connected Terminals

Developing
GET
https://api.bavindo.com/v1/connected_terminals
INFO
This endpoint can be accessed with the following API type: pos-payment,
TIP
Don't have an API key? Create one in your Customer Area with the type pos-payment, go to Developers -> Api Credentials,

Get the terminal ID#

When you make for example a POS Payment Create request, you need to indicate which payment terminal you want to use. To do so, you populate the terminal_id field in the payload with the unique identifier of the payment terminal in the format [device model]-[serial number]. For example, P400Plus‑00000000.
There are several ways to get the unique ID (terminal_id) of a payment terminal:

⭐ Make an API call#

1.
Make a POST to this endpoint while using your api key linked to a store.
2.
In the response, get the terminal ID's which are assigned to your store. An API key is linked to a store.

Get the terminal ID from your Customer Area#

1.
In your Customer Area, go to Terminals -> Select the desired terminal
2.
Check the assignment status.

Get the terminal ID from the terminal#

To construct the terminal_id of the payment terminal:
1.
Find the serial number of the payment terminal:
On the back of the payment terminal.
On the payment terminal screen under Settings > Device info.
2.
Take the device model, for example, P400Plus, and combine it with the serial number.
3.
Add a dash between the device model and the serial number.
4.
Remove any dashes from the serial number.
5.
Check the assignment status of the terminal in your Customer Area or if it exists in the API call.

Terminal statuses#

StatusDescription
shutdownThe terminal is shutting down.
beginmaintenanceTerminal maintenance is starting.
endmaintenanceTerminal maintenance is finishing.
outoforderThe terminal is out of order.
initialisedThe terminal has been initialised and is ready for transactions.
rejectA request was rejected.
salewakeupThe terminal is starting a payment request.

Request

Authorization
Provide your bearer token in the
Authorization
header when making requests to protected resources.
Example:
Authorization: Bearer ********************

Responses

🟢200OK
application/json
Body

Example
{
    "store_id": "3294V22322755KZ6TWHGPRJ",
    "terminals": [
        {
            "terminal_id": "P400Plus-00000000",
            "terminal_name": "name",
            "connected": true,
            "status": "initialised"
        }
    ],
    "environment": "test"
}
Modified at 2024-10-21 12:28:30
Previous
v1
Next
POS Payment Create
Built with