Money In
Terminals
Retrieve & Update details of terminals (Point of Sale devices).
Update
Update the details of a specific terminal.
Path
POST /terminals/:id
Where id is the ID of the terminal you would like to update e.g. ter_0YetDW3cjCAaMPVOgbPTO.
Body
{
"terminal_status": "ACTIVE",
"nickname": "Mills Group",
"location": {
"name": "Pretoria",
"coordinates": "-44.236, 161.269"
},
"contact_numbers": ["0830000000", "0720000000"],
"settings": {
"is_debicheck": true,
"is_card_payment": true,
"is_customers": true,
"is_invoices": true
}
}
Parameters
Field | Required | Can be Cleared | Type | Description | Example |
|---|---|---|---|---|---|
| *.terminal_status | N | N | ENUM | If provided will change the status of the terminal (leave blank to keep same status). (ACTIVE,DISABLED,ARCHIVED). | ACTIVE |
| *.nickname | N | N | String(128) | Nickname for the terminal | Mills Group |
| *.location.name | N | N | String(256) | Name of the location where the terminal is kept | Pretoria |
| *.location.coordinates | N | N | String(34) | Custom coordinates where the terminal is kept. Your choice of Decimal Degrees or Degrees, Minutes, Seconds. | -44.236, 161.269 |
| *.contact_numbers | N | Y | Array | OTP's are allowed to be sent to either of these contact numbers when logging the device in. If terminal is in PIN mode these numbers won't be used. | "0830000000", "0720000000" |
| *.settings.is_debicheck | N | N | Boolean | Show DebiCheck options on the terminal device. Only applicable if the terminal has been configured with a DebiCheck payment method. | true |
| *.settings.is_card_payment | N | N | Boolean | Show card payment options on the terminal device. | true |
| *.settings.is_customers | N | N | Boolean | Show the customers section on the terminal device. | true |
| *.settings.is_invoices | N | N | Boolean | Show the invoices section on the terminal device. | true |
Response Body
The response follows the same format as the list response
{
"status": true,
"records": [{
"id": "ter_VLSEUZK5STgmP4J6yBDlU",
"created_at": "2024-12-28 22:14:47",
"updated_at": null,
"activated_at": null,
"last_seen_at": "2026-03-28 11:14:11",
"last_login_at": "2026-03-28 11:14:11",
"warranty_expire_at": "2026-12-21 14:12:03",
"terminal_brand": "SNUMI",
"terminal_device": "P2_LITE_SE",
"terminal_status": "ACTIVE",
"terminal_id": "301316",
"serial_number": "573412",
"nickname": "Mills Group",
"location": {
"name": "Pretoria",
"coordinates": "-44.236, 161.269"
},
"contact_numbers": ["0830000000", "0720000000"],
"settings": {
"is_debicheck": true,
"is_card_payment": true,
"is_customers": true,
"is_invoices": true
}
}, ...]
}
List
List all terminals loaded.
Path
GET /terminals
Query Parameters
| Field | Type | Required | Description | Example |
|---|---|---|---|---|
| id | String(32) | N | Filter for a specific terminal | ter_VLSEUZK5STgmP4J6yBDlU |
Response Body
{
"status": true,
"records": [{
"id": "ter_VLSEUZK5STgmP4J6yBDlU",
"created_at": "2024-12-28 22:14:47",
"updated_at": null,
"activated_at": null,
"last_seen_at": "2026-03-28 11:14:11",
"last_login_at": "2026-03-28 11:14:11",
"warranty_expire_at": "2026-12-21 14:12:03",
"terminal_brand": "SNUMI",
"terminal_device": "P2_LITE_SE",
"terminal_status": "ACTIVE",
"terminal_id": "301316",
"serial_number": "573412",
"nickname": "Mills Group",
"location": {
"name": "Pretoria",
"coordinates": "-44.236, 161.269"
},
"contact_numbers": ["0830000000", "0720000000"],
"settings": {
"is_debicheck": true,
"is_card_payment": true,
"is_customers": true,
"is_invoices": true
}
}, ...]
}
Customer Portal
Create a link for a customer so that they can manage their subscriptions, billing details, invoices and payment methods.
Payouts
Send money to customer bank accounts and manage outbound transfers. Create single or batch payouts with real-time status tracking, beneficiary management, and comprehensive transaction reporting.