API reference

Base URL https://api.example.com (yours is given with your credentials). Authenticate with X-Api-Key or a bearer token; operator writes are also signed. Read Authentication first, and Errors and limits for conventions.

OpenAPI 3.1 (JSON) Postman collection

Admin

GET/v1/admin/domains
Parameters
NameInType
statusqueryinteger
Responses
200OK
Example
bash
curl -X GET "$BASE/v1/admin/domains" \
  -H "X-Api-Key: $API_KEY"

Auth

POST/v1/auth/forgot-password
Request body
FieldTypeNotes
email requiredstring
json
{
  "email": "string"
}
Responses
200OK
Example
bash
curl -X POST "$BASE/v1/auth/forgot-password" \
  -H "X-Api-Key: $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"email":"string"}'
POST/v1/auth/reset-password
Request body
FieldTypeNotes
token requiredstring
password requiredstring
json
{
  "token": "string",
  "password": "string"
}
Responses
200OK
Example
bash
curl -X POST "$BASE/v1/auth/reset-password" \
  -H "X-Api-Key: $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"token":"string","password":"string"}'
POST/v1/auth/login
Request body
FieldTypeNotes
email requiredstring
password requiredstring
json
{
  "email": "string",
  "password": "string"
}
Responses
200OK
Example
bash
curl -X POST "$BASE/v1/auth/login" \
  -H "X-Api-Key: $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"email":"string","password":"string"}'
POST/v1/auth/refresh
Request body
FieldTypeNotes
refreshToken requiredstring
json
{
  "refreshToken": "string"
}
Responses
200OK
Example
bash
curl -X POST "$BASE/v1/auth/refresh" \
  -H "X-Api-Key: $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"refreshToken":"string"}'

EmailAdmin

GET/v1/admin/email
Responses
200OK
Example
bash
curl -X GET "$BASE/v1/admin/email" \
  -H "X-Api-Key: $API_KEY"
POST/v1/admin/email/test
Request body
FieldTypeNotes
to requiredstring
json
{
  "to": "string"
}
Responses
200OK
Example
bash
curl -X POST "$BASE/v1/admin/email/test" \
  -H "X-Api-Key: $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"to":"string"}'

Images

GET/v1/images/{imageId}
Parameters
NameInType
imageIdpathstring (uuid)required
wqueryinteger | string (int32)
hqueryinteger | string (int32)
fitquerystring
fmtquerystring
Responses
200OK
Example
bash
curl -X GET "$BASE/v1/images/$imageId" \
  -H "X-Api-Key: $API_KEY"

Imports

POST/v1/imports
Parameters
NameInType
kindqueryinteger
fileNamequerystring
Responses
200OK
Example
bash
curl -X POST "$BASE/v1/imports" \
  -H "X-Api-Key: $API_KEY"
GET/v1/imports
Responses
200OK
Example
bash
curl -X GET "$BASE/v1/imports" \
  -H "X-Api-Key: $API_KEY"
GET/v1/imports/{id}
Parameters
NameInType
idpathstring (uuid)required
Responses
200OK
Example
bash
curl -X GET "$BASE/v1/imports/$id" \
  -H "X-Api-Key: $API_KEY"

Me

GET/v1/me
Responses
200OK
Example
bash
curl -X GET "$BASE/v1/me" \
  -H "X-Api-Key: $API_KEY"

MerchantCatalog

GET/v1/merchants/{merchantId}/categories
Parameters
NameInType
merchantIdpathstring (uuid)required
Responses
200OK
Example
bash
curl -X GET "$BASE/v1/merchants/$merchantId/categories" \
  -H "X-Api-Key: $API_KEY"
POST/v1/merchants/{merchantId}/categories
Parameters
NameInType
merchantIdpathstring (uuid)required
Request body
FieldTypeNotes
name requiredstring
json
{
  "name": "string"
}
Responses
200OK
Example
bash
curl -X POST "$BASE/v1/merchants/$merchantId/categories" \
  -H "X-Api-Key: $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"string"}'
PUT/v1/merchants/{merchantId}/categories/order
Parameters
NameInType
merchantIdpathstring (uuid)required
Request body
FieldTypeNotes
ids requiredarray
json
{
  "ids": [
    "00000000-0000-0000-0000-000000000000"
  ]
}
Responses
200OK
Example
bash
curl -X PUT "$BASE/v1/merchants/$merchantId/categories/order" \
  -H "X-Api-Key: $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"ids":["00000000-0000-0000-0000-000000000000"]}'
PUT/v1/merchants/{merchantId}/categories/{id}
Parameters
NameInType
merchantIdpathstring (uuid)required
idpathstring (uuid)required
Request body
FieldTypeNotes
name requiredstring
isActive requiredboolean
color requiredstring
json
{
  "name": "string",
  "isActive": false,
  "color": "string"
}
Responses
200OK
Example
bash
curl -X PUT "$BASE/v1/merchants/$merchantId/categories/$id" \
  -H "X-Api-Key: $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"string","isActive":false,"color":"string"}'
POST/v1/merchants/{merchantId}/products/{id}/image
Parameters
NameInType
merchantIdpathstring (uuid)required
idpathstring (uuid)required
Request body

Multipart form data. See the guide for the fields.

Responses
200OK
Example
bash
curl -X POST "$BASE/v1/merchants/$merchantId/products/$id/image" \
  -H "X-Api-Key: $API_KEY"
DELETE/v1/merchants/{merchantId}/products/{id}/image
Parameters
NameInType
merchantIdpathstring (uuid)required
idpathstring (uuid)required
Responses
200OK
Example
bash
curl -X DELETE "$BASE/v1/merchants/$merchantId/products/$id/image" \
  -H "X-Api-Key: $API_KEY"
POST/v1/merchants/{merchantId}/branches
Parameters
NameInType
merchantIdpathstring (uuid)required
Request body
FieldTypeNotes
name requiredstring
code requiredstring
json
{
  "name": "string",
  "code": "string"
}
Responses
200OK
Example
bash
curl -X POST "$BASE/v1/merchants/$merchantId/branches" \
  -H "X-Api-Key: $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"string","code":"string"}'
GET/v1/merchants/{merchantId}/branches
Parameters
NameInType
merchantIdpathstring (uuid)required
Responses
200OK
Example
bash
curl -X GET "$BASE/v1/merchants/$merchantId/branches" \
  -H "X-Api-Key: $API_KEY"
PUT/v1/merchants/{merchantId}/branches/{branchId}
Parameters
NameInType
merchantIdpathstring (uuid)required
branchIdpathstring (uuid)required
Request body
FieldTypeNotes
name requiredstring
code requiredstring
isActive requiredboolean
json
{
  "name": "string",
  "code": "string",
  "isActive": false
}
Responses
200OK
Example
bash
curl -X PUT "$BASE/v1/merchants/$merchantId/branches/$branchId" \
  -H "X-Api-Key: $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"string","code":"string","isActive":false}'
GET/v1/merchants/{merchantId}/products
Parameters
NameInType
merchantIdpathstring (uuid)required
qquerystring
categoryIdquerystring (uuid)
includeInactivequeryboolean
pagequeryinteger | string (int32)
pageSizequeryinteger | string (int32)
Responses
200OK
Example
bash
curl -X GET "$BASE/v1/merchants/$merchantId/products" \
  -H "X-Api-Key: $API_KEY"
POST/v1/merchants/{merchantId}/products
Parameters
NameInType
merchantIdpathstring (uuid)required
Request body
FieldTypeNotes
name requiredstring
description requiredstring
categoryId requiredstring (uuid)
unit requiredstring
taxClass requiredany
trackStock requiredboolean
variants requiredarray
json
{
  "name": "string",
  "description": "string",
  "categoryId": "00000000-0000-0000-0000-000000000000",
  "unit": "string",
  "taxClass": 0,
  "trackStock": false,
  "variants": [
    {
      "sku": "string",
      "name": "string",
      "barcode": "string",
      "priceKobo": 0,
      "costKobo": 0
    }
  ]
}
Responses
200OK
Example
bash
curl -X POST "$BASE/v1/merchants/$merchantId/products" \
  -H "X-Api-Key: $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"string","description":"string","categoryId":"00000000-0000-0000-0000-000000000000","unit":"string","taxClass":0,"trackStock":false,"variants":[{"sku":"string","name":"string","barcode":"string","priceKobo":0,"costKobo":0}]}'
GET/v1/merchants/{merchantId}/products/{id}
Parameters
NameInType
merchantIdpathstring (uuid)required
idpathstring (uuid)required
Responses
200OK
Example
bash
curl -X GET "$BASE/v1/merchants/$merchantId/products/$id" \
  -H "X-Api-Key: $API_KEY"
PUT/v1/merchants/{merchantId}/products/{id}
Parameters
NameInType
merchantIdpathstring (uuid)required
idpathstring (uuid)required
Request body
FieldTypeNotes
name requiredstring
description requiredstring
categoryId requiredstring (uuid)
unit requiredstring
taxClass requiredany
trackStock requiredboolean
isActive requiredboolean
isFavourite requiredboolean
json
{
  "name": "string",
  "description": "string",
  "categoryId": "00000000-0000-0000-0000-000000000000",
  "unit": "string",
  "taxClass": 0,
  "trackStock": false,
  "isActive": false,
  "isFavourite": false
}
Responses
200OK
Example
bash
curl -X PUT "$BASE/v1/merchants/$merchantId/products/$id" \
  -H "X-Api-Key: $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"string","description":"string","categoryId":"00000000-0000-0000-0000-000000000000","unit":"string","taxClass":0,"trackStock":false,"isActive":false,"isFavourite":false}'
POST/v1/merchants/{merchantId}/products/import
Parameters
NameInType
merchantIdpathstring (uuid)required
Request body
FieldTypeNotes
csv requiredstring
dryRun requiredboolean
json
{
  "csv": "string",
  "dryRun": false
}
Responses
200OK
Example
bash
curl -X POST "$BASE/v1/merchants/$merchantId/products/import" \
  -H "X-Api-Key: $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"csv":"string","dryRun":false}'
PUT/v1/merchants/{merchantId}/products/order
Parameters
NameInType
merchantIdpathstring (uuid)required
Request body
FieldTypeNotes
ids requiredarray
json
{
  "ids": [
    "00000000-0000-0000-0000-000000000000"
  ]
}
Responses
200OK
Example
bash
curl -X PUT "$BASE/v1/merchants/$merchantId/products/order" \
  -H "X-Api-Key: $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"ids":["00000000-0000-0000-0000-000000000000"]}'
POST/v1/merchants/{merchantId}/products/{id}/variants
Parameters
NameInType
merchantIdpathstring (uuid)required
idpathstring (uuid)required
Request body
FieldTypeNotes
sku requiredstring
name requiredstring
barcode requiredstring
priceKobo requiredinteger | string (int64)
costKobointeger | string (int64)
json
{
  "sku": "string",
  "name": "string",
  "barcode": "string",
  "priceKobo": 0,
  "costKobo": 0
}
Responses
200OK
Example
bash
curl -X POST "$BASE/v1/merchants/$merchantId/products/$id/variants" \
  -H "X-Api-Key: $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"sku":"string","name":"string","barcode":"string","priceKobo":0,"costKobo":0}'
PUT/v1/merchants/{merchantId}/variants/{variantId}
Parameters
NameInType
merchantIdpathstring (uuid)required
variantIdpathstring (uuid)required
Request body
FieldTypeNotes
name requiredstring
barcode requiredstring
priceKobo requiredinteger | string (int64)
costKobo requiredinteger | string (int64)
isActive requiredboolean
json
{
  "name": "string",
  "barcode": "string",
  "priceKobo": 0,
  "costKobo": 0,
  "isActive": false
}
Responses
200OK
Example
bash
curl -X PUT "$BASE/v1/merchants/$merchantId/variants/$variantId" \
  -H "X-Api-Key: $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"string","barcode":"string","priceKobo":0,"costKobo":0,"isActive":false}'
PUT/v1/merchants/{merchantId}/variants/{variantId}/prices/{branchId}
Parameters
NameInType
merchantIdpathstring (uuid)required
variantIdpathstring (uuid)required
branchIdpathstring (uuid)required
Request body
FieldTypeNotes
priceKobo requiredinteger | string (int64)
json
{
  "priceKobo": 0
}
Responses
200OK
Example
bash
curl -X PUT "$BASE/v1/merchants/$merchantId/variants/$variantId/prices/$branchId" \
  -H "X-Api-Key: $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"priceKobo":0}'
DELETE/v1/merchants/{merchantId}/variants/{variantId}/prices/{branchId}
Parameters
NameInType
merchantIdpathstring (uuid)required
variantIdpathstring (uuid)required
branchIdpathstring (uuid)required
Responses
200OK
Example
bash
curl -X DELETE "$BASE/v1/merchants/$merchantId/variants/$variantId/prices/$branchId" \
  -H "X-Api-Key: $API_KEY"
GET/v1/merchants/{merchantId}/catalog
Parameters
NameInType
merchantIdpathstring (uuid)required
branchIdquerystring (uuid)
cursorquerystring
updatedSincequerystring (date-time)
limitqueryinteger | string (int32)
Responses
200OK
Example
bash
curl -X GET "$BASE/v1/merchants/$merchantId/catalog" \
  -H "X-Api-Key: $API_KEY"
GET/v1/merchants/{merchantId}/lookup
Parameters
NameInType
merchantIdpathstring (uuid)required
barcodequerystring
branchIdquerystring (uuid)
Responses
200OK
Example
bash
curl -X GET "$BASE/v1/merchants/$merchantId/lookup" \
  -H "X-Api-Key: $API_KEY"

MerchantInventory

POST/v1/merchants/{merchantId}/inventory/adjustments
Parameters
NameInType
merchantIdpathstring (uuid)required
Request body
FieldTypeNotes
branchId requiredstring (uuid)
variantId requiredstring (uuid)
quantityDelta requirednumber | string (double)
note requiredstring
unitCostKobo requiredinteger | string (int64)
json
{
  "branchId": "00000000-0000-0000-0000-000000000000",
  "variantId": "00000000-0000-0000-0000-000000000000",
  "quantityDelta": 0,
  "note": "string",
  "unitCostKobo": 0
}
Responses
200OK
Example
bash
curl -X POST "$BASE/v1/merchants/$merchantId/inventory/adjustments" \
  -H "X-Api-Key: $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"branchId":"00000000-0000-0000-0000-000000000000","variantId":"00000000-0000-0000-0000-000000000000","quantityDelta":0,"note":"string","unitCostKobo":0}'
POST/v1/merchants/{merchantId}/inventory/receipts
Parameters
NameInType
merchantIdpathstring (uuid)required
Request body
FieldTypeNotes
branchId requiredstring (uuid)
reference requiredstring
supplierName requiredstring
note requiredstring
lines requiredarray
json
{
  "branchId": "00000000-0000-0000-0000-000000000000",
  "reference": "string",
  "supplierName": "string",
  "note": "string",
  "lines": [
    {
      "variantId": "00000000-0000-0000-0000-000000000000",
      "quantity": 0,
      "unitCostKobo": 0
    }
  ]
}
Responses
200OK
Example
bash
curl -X POST "$BASE/v1/merchants/$merchantId/inventory/receipts" \
  -H "X-Api-Key: $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"branchId":"00000000-0000-0000-0000-000000000000","reference":"string","supplierName":"string","note":"string","lines":[{"variantId":"00000000-0000-0000-0000-000000000000","quantity":0,"unitCostKobo":0}]}'
PUT/v1/merchants/{merchantId}/inventory/reorder-levels
Parameters
NameInType
merchantIdpathstring (uuid)required
Request body
FieldTypeNotes
branchId requiredstring (uuid)
variantId requiredstring (uuid)
reorderLevel requirednumber | string (double)
json
{
  "branchId": "00000000-0000-0000-0000-000000000000",
  "variantId": "00000000-0000-0000-0000-000000000000",
  "reorderLevel": 0
}
Responses
200OK
Example
bash
curl -X PUT "$BASE/v1/merchants/$merchantId/inventory/reorder-levels" \
  -H "X-Api-Key: $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"branchId":"00000000-0000-0000-0000-000000000000","variantId":"00000000-0000-0000-0000-000000000000","reorderLevel":0}'
GET/v1/merchants/{merchantId}/inventory/levels
Parameters
NameInType
merchantIdpathstring (uuid)required
branchIdquerystring (uuid)
variantIdquerystring (uuid)
lowOnlyqueryboolean
qquerystring
pagequeryinteger | string (int32)
pageSizequeryinteger | string (int32)
Responses
200OK
Example
bash
curl -X GET "$BASE/v1/merchants/$merchantId/inventory/levels" \
  -H "X-Api-Key: $API_KEY"
GET/v1/merchants/{merchantId}/inventory/movements
Parameters
NameInType
merchantIdpathstring (uuid)required
branchIdquerystring (uuid)
variantIdquerystring (uuid)
reasonqueryinteger
fromquerystring (date-time)
toquerystring (date-time)
pagequeryinteger | string (int32)
pageSizequeryinteger | string (int32)
Responses
200OK
Example
bash
curl -X GET "$BASE/v1/merchants/$merchantId/inventory/movements" \
  -H "X-Api-Key: $API_KEY"
GET/v1/merchants/{merchantId}/inventory/valuation
Parameters
NameInType
merchantIdpathstring (uuid)required
branchIdquerystring (uuid)
detailqueryboolean
Responses
200OK
Example
bash
curl -X GET "$BASE/v1/merchants/$merchantId/inventory/valuation" \
  -H "X-Api-Key: $API_KEY"
POST/v1/merchants/{merchantId}/inventory/transfers
Parameters
NameInType
merchantIdpathstring (uuid)required
Request body
FieldTypeNotes
fromBranchId requiredstring (uuid)
toBranchId requiredstring (uuid)
reference requiredstring
note requiredstring
lines requiredarray
json
{
  "fromBranchId": "00000000-0000-0000-0000-000000000000",
  "toBranchId": "00000000-0000-0000-0000-000000000000",
  "reference": "string",
  "note": "string",
  "lines": [
    {
      "variantId": "00000000-0000-0000-0000-000000000000",
      "quantity": 0
    }
  ]
}
Responses
200OK
Example
bash
curl -X POST "$BASE/v1/merchants/$merchantId/inventory/transfers" \
  -H "X-Api-Key: $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"fromBranchId":"00000000-0000-0000-0000-000000000000","toBranchId":"00000000-0000-0000-0000-000000000000","reference":"string","note":"string","lines":[{"variantId":"00000000-0000-0000-0000-000000000000","quantity":0}]}'
GET/v1/merchants/{merchantId}/inventory/transfers
Parameters
NameInType
merchantIdpathstring (uuid)required
statusqueryinteger
pagequeryinteger | string (int32)
pageSizequeryinteger | string (int32)
Responses
200OK
Example
bash
curl -X GET "$BASE/v1/merchants/$merchantId/inventory/transfers" \
  -H "X-Api-Key: $API_KEY"
GET/v1/merchants/{merchantId}/inventory/transfers/{id}
Parameters
NameInType
merchantIdpathstring (uuid)required
idpathstring (uuid)required
Responses
200OK
Example
bash
curl -X GET "$BASE/v1/merchants/$merchantId/inventory/transfers/$id" \
  -H "X-Api-Key: $API_KEY"
POST/v1/merchants/{merchantId}/inventory/transfers/{id}/receive
Parameters
NameInType
merchantIdpathstring (uuid)required
idpathstring (uuid)required
Request body
FieldTypeNotes
json
{
  "lines": [
    {
      "variantId": null,
      "quantityReceived": null
    }
  ]
}
Responses
200OK
Example
bash
curl -X POST "$BASE/v1/merchants/$merchantId/inventory/transfers/$id/receive" \
  -H "X-Api-Key: $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"lines":[{"variantId":null,"quantityReceived":null}]}'
POST/v1/merchants/{merchantId}/inventory/transfers/{id}/cancel
Parameters
NameInType
merchantIdpathstring (uuid)required
idpathstring (uuid)required
Responses
200OK
Example
bash
curl -X POST "$BASE/v1/merchants/$merchantId/inventory/transfers/$id/cancel" \
  -H "X-Api-Key: $API_KEY"
POST/v1/merchants/{merchantId}/inventory/counts
Parameters
NameInType
merchantIdpathstring (uuid)required
Request body
FieldTypeNotes
branchId requiredstring (uuid)
name requiredstring
variantIds requiredarray
json
{
  "branchId": "00000000-0000-0000-0000-000000000000",
  "name": "string",
  "variantIds": [
    "00000000-0000-0000-0000-000000000000"
  ]
}
Responses
200OK
Example
bash
curl -X POST "$BASE/v1/merchants/$merchantId/inventory/counts" \
  -H "X-Api-Key: $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"branchId":"00000000-0000-0000-0000-000000000000","name":"string","variantIds":["00000000-0000-0000-0000-000000000000"]}'
GET/v1/merchants/{merchantId}/inventory/counts
Parameters
NameInType
merchantIdpathstring (uuid)required
statusqueryinteger
pagequeryinteger | string (int32)
pageSizequeryinteger | string (int32)
Responses
200OK
Example
bash
curl -X GET "$BASE/v1/merchants/$merchantId/inventory/counts" \
  -H "X-Api-Key: $API_KEY"
GET/v1/merchants/{merchantId}/inventory/counts/{id}
Parameters
NameInType
merchantIdpathstring (uuid)required
idpathstring (uuid)required
Responses
200OK
Example
bash
curl -X GET "$BASE/v1/merchants/$merchantId/inventory/counts/$id" \
  -H "X-Api-Key: $API_KEY"
PUT/v1/merchants/{merchantId}/inventory/counts/{id}/lines
Parameters
NameInType
merchantIdpathstring (uuid)required
idpathstring (uuid)required
Request body
FieldTypeNotes
lines requiredarray
json
{
  "lines": [
    {
      "variantId": "00000000-0000-0000-0000-000000000000",
      "countedQty": 0
    }
  ]
}
Responses
200OK
Example
bash
curl -X PUT "$BASE/v1/merchants/$merchantId/inventory/counts/$id/lines" \
  -H "X-Api-Key: $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"lines":[{"variantId":"00000000-0000-0000-0000-000000000000","countedQty":0}]}'
POST/v1/merchants/{merchantId}/inventory/counts/{id}/post
Parameters
NameInType
merchantIdpathstring (uuid)required
idpathstring (uuid)required
Responses
200OK
Example
bash
curl -X POST "$BASE/v1/merchants/$merchantId/inventory/counts/$id/post" \
  -H "X-Api-Key: $API_KEY"
POST/v1/merchants/{merchantId}/inventory/counts/{id}/cancel
Parameters
NameInType
merchantIdpathstring (uuid)required
idpathstring (uuid)required
Responses
200OK
Example
bash
curl -X POST "$BASE/v1/merchants/$merchantId/inventory/counts/$id/cancel" \
  -H "X-Api-Key: $API_KEY"

MerchantReconciliation

GET/v1/merchants/{merchantId}/transactions
Parameters
NameInType
merchantIdpathstring (uuid)required
branchIdquerystring (uuid)
terminalIdquerystring (uuid)
statusqueryinteger
typequeryinteger
fromquerystring (date-time)
toquerystring (date-time)
rrnquerystring
pagequeryinteger | string (int32)
pageSizequeryinteger | string (int32)
Responses
200OK
Example
bash
curl -X GET "$BASE/v1/merchants/$merchantId/transactions" \
  -H "X-Api-Key: $API_KEY"
GET/v1/merchants/{merchantId}/reconciliation/summary
Parameters
NameInType
merchantIdpathstring (uuid)required
branchIdquerystring (uuid)
terminalIdquerystring (uuid)
datequerystring (date)
fromquerystring (date-time)
toquerystring (date-time)
graceMinutesqueryinteger | string (int32)
Responses
200OK
Example
bash
curl -X GET "$BASE/v1/merchants/$merchantId/reconciliation/summary" \
  -H "X-Api-Key: $API_KEY"
GET/v1/merchants/{merchantId}/reconciliation/exceptions
Parameters
NameInType
merchantIdpathstring (uuid)required
kindquerystring
branchIdquerystring (uuid)
terminalIdquerystring (uuid)
datequerystring (date)
fromquerystring (date-time)
toquerystring (date-time)
graceMinutesqueryinteger | string (int32)
pagequeryinteger | string (int32)
pageSizequeryinteger | string (int32)
Responses
200OK
Example
bash
curl -X GET "$BASE/v1/merchants/$merchantId/reconciliation/exceptions" \
  -H "X-Api-Key: $API_KEY"
POST/v1/merchants/{merchantId}/reconciliation/run
Parameters
NameInType
merchantIdpathstring (uuid)required
Responses
200OK
Example
bash
curl -X POST "$BASE/v1/merchants/$merchantId/reconciliation/run" \
  -H "X-Api-Key: $API_KEY"
POST/v1/merchants/{merchantId}/transactions/{transactionId}/match
Parameters
NameInType
merchantIdpathstring (uuid)required
transactionIdpathstring (uuid)required
Request body
FieldTypeNotes
saleTenderId requiredstring (uuid)
note requiredstring
json
{
  "saleTenderId": "00000000-0000-0000-0000-000000000000",
  "note": "string"
}
Responses
200OK
Example
bash
curl -X POST "$BASE/v1/merchants/$merchantId/transactions/$transactionId/match" \
  -H "X-Api-Key: $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"saleTenderId":"00000000-0000-0000-0000-000000000000","note":"string"}'
POST/v1/merchants/{merchantId}/transactions/{transactionId}/ignore
Parameters
NameInType
merchantIdpathstring (uuid)required
transactionIdpathstring (uuid)required
Request body
FieldTypeNotes
json
{
  "note": "string"
}
Responses
200OK
Example
bash
curl -X POST "$BASE/v1/merchants/$merchantId/transactions/$transactionId/ignore" \
  -H "X-Api-Key: $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"note":"string"}'
GET/v1/merchants/{merchantId}/reports/sales
Parameters
NameInType
merchantIdpathstring (uuid)required
groupByqueryinteger
branchIdquerystring (uuid)
terminalIdquerystring (uuid)
datequerystring (date)
fromquerystring (date-time)
toquerystring (date-time)
formatquerystring
Responses
200OK
Example
bash
curl -X GET "$BASE/v1/merchants/$merchantId/reports/sales" \
  -H "X-Api-Key: $API_KEY"

MerchantSales

POST/v1/merchants/{merchantId}/sales
Parameters
NameInType
merchantIdpathstring (uuid)required
Idempotency-Keyheaderstring
Request body
FieldTypeNotes
saleId requiredstring (uuid)
branchId requiredstring (uuid)
tid requiredstring
shiftId requiredstring (uuid)
receiptNo requiredstring
cashierRef requiredstring
occurredAt requiredstring (date-time)
lines requiredarray
tenders requiredarray
expectedTotalKobo requiredinteger | string (int64)
note requiredstring
json
{
  "saleId": "00000000-0000-0000-0000-000000000000",
  "branchId": "00000000-0000-0000-0000-000000000000",
  "tid": "string",
  "shiftId": "00000000-0000-0000-0000-000000000000",
  "receiptNo": "string",
  "cashierRef": "string",
  "occurredAt": "2026-11-16T10:00:00+01:00",
  "lines": [
    {
      "variantId": "00000000-0000-0000-0000-000000000000",
      "quantity": 0,
      "unitPriceKobo": 0,
      "discountKobo": 0
    }
  ],
  "tenders": [
    {
      "type": 0,
      "amountKobo": 0,
      "rrn": "string",
      "stan": "string",
      "tid": "string",
      "maskedPan": "string",
      "authCode": "string",
      "reference": "string"
    }
  ],
  "expectedTotalKobo": 0,
  "note": "string"
}
Responses
200OK
Example
bash
curl -X POST "$BASE/v1/merchants/$merchantId/sales" \
  -H "X-Api-Key: $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"saleId":"00000000-0000-0000-0000-000000000000","branchId":"00000000-0000-0000-0000-000000000000","tid":"string","shiftId":"00000000-0000-0000-0000-000000000000","receiptNo":"string","cashierRef":"string","occurredAt":"2026-11-16T10:00:00+01:00","lines":[{"variantId":"00000000-0000-0000-0000-000000000000","quantity":0,"unitPriceKobo":0,"discountKobo":0}],"tenders":[{"type":0,"amountKobo":0,"rrn":"string","stan":"string","tid":"string","maskedPan":"string","authCode":"string","reference":"string"}],"expectedTotalKobo":0,"note":"string"}'
GET/v1/merchants/{merchantId}/sales
Parameters
NameInType
merchantIdpathstring (uuid)required
branchIdquerystring (uuid)
terminalIdquerystring (uuid)
shiftIdquerystring (uuid)
statusqueryinteger
fromquerystring (date-time)
toquerystring (date-time)
receiptquerystring
pagequeryinteger | string (int32)
pageSizequeryinteger | string (int32)
Responses
200OK
Example
bash
curl -X GET "$BASE/v1/merchants/$merchantId/sales" \
  -H "X-Api-Key: $API_KEY"
GET/v1/merchants/{merchantId}/sales/{saleId}
Parameters
NameInType
merchantIdpathstring (uuid)required
saleIdpathstring (uuid)required
Responses
200OK
Example
bash
curl -X GET "$BASE/v1/merchants/$merchantId/sales/$saleId" \
  -H "X-Api-Key: $API_KEY"
POST/v1/merchants/{merchantId}/sales/{saleId}/returns
Parameters
NameInType
merchantIdpathstring (uuid)required
saleIdpathstring (uuid)required
Request body
FieldTypeNotes
returnId requiredstring (uuid)
occurredAt requiredstring (date-time)
reason requiredstring
cashierRef requiredstring
lines requiredarray
refunds requiredarray
json
{
  "returnId": "00000000-0000-0000-0000-000000000000",
  "occurredAt": "2026-11-16T10:00:00+01:00",
  "reason": "string",
  "cashierRef": "string",
  "lines": [
    {
      "saleLineId": "00000000-0000-0000-0000-000000000000",
      "quantity": 0,
      "restock": false
    }
  ],
  "refunds": [
    {
      "type": 0,
      "amountKobo": 0,
      "rrn": "string",
      "reference": "string"
    }
  ]
}
Responses
200OK
Example
bash
curl -X POST "$BASE/v1/merchants/$merchantId/sales/$saleId/returns" \
  -H "X-Api-Key: $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"returnId":"00000000-0000-0000-0000-000000000000","occurredAt":"2026-11-16T10:00:00+01:00","reason":"string","cashierRef":"string","lines":[{"saleLineId":"00000000-0000-0000-0000-000000000000","quantity":0,"restock":false}],"refunds":[{"type":0,"amountKobo":0,"rrn":"string","reference":"string"}]}'
POST/v1/merchants/{merchantId}/shifts
Parameters
NameInType
merchantIdpathstring (uuid)required
Request body
FieldTypeNotes
shiftId requiredstring (uuid)
branchId requiredstring (uuid)
tid requiredstring
openedAt requiredstring (date-time)
openingFloatKobo requiredinteger | string (int64)
cashierRef requiredstring
json
{
  "shiftId": "00000000-0000-0000-0000-000000000000",
  "branchId": "00000000-0000-0000-0000-000000000000",
  "tid": "string",
  "openedAt": "2026-11-16T10:00:00+01:00",
  "openingFloatKobo": 0,
  "cashierRef": "string"
}
Responses
200OK
Example
bash
curl -X POST "$BASE/v1/merchants/$merchantId/shifts" \
  -H "X-Api-Key: $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"shiftId":"00000000-0000-0000-0000-000000000000","branchId":"00000000-0000-0000-0000-000000000000","tid":"string","openedAt":"2026-11-16T10:00:00+01:00","openingFloatKobo":0,"cashierRef":"string"}'
GET/v1/merchants/{merchantId}/shifts
Parameters
NameInType
merchantIdpathstring (uuid)required
branchIdquerystring (uuid)
terminalIdquerystring (uuid)
statusqueryinteger
pagequeryinteger | string (int32)
pageSizequeryinteger | string (int32)
Responses
200OK
Example
bash
curl -X GET "$BASE/v1/merchants/$merchantId/shifts" \
  -H "X-Api-Key: $API_KEY"
GET/v1/merchants/{merchantId}/shifts/{shiftId}
Parameters
NameInType
merchantIdpathstring (uuid)required
shiftIdpathstring (uuid)required
Responses
200OK
Example
bash
curl -X GET "$BASE/v1/merchants/$merchantId/shifts/$shiftId" \
  -H "X-Api-Key: $API_KEY"
POST/v1/merchants/{merchantId}/shifts/{shiftId}/close
Parameters
NameInType
merchantIdpathstring (uuid)required
shiftIdpathstring (uuid)required
Request body
FieldTypeNotes
countedCashKobo requiredinteger | string (int64)
closedAt requiredstring (date-time)
cashierRef requiredstring
json
{
  "countedCashKobo": 0,
  "closedAt": "2026-11-16T10:00:00+01:00",
  "cashierRef": "string"
}
Responses
200OK
Example
bash
curl -X POST "$BASE/v1/merchants/$merchantId/shifts/$shiftId/close" \
  -H "X-Api-Key: $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"countedCashKobo":0,"closedAt":"2026-11-16T10:00:00+01:00","cashierRef":"string"}'
GET/v1/merchants/{merchantId}/reports/z
Parameters
NameInType
merchantIdpathstring (uuid)required
branchIdquerystring (uuid)
terminalIdquerystring (uuid)
shiftIdquerystring (uuid)
datequerystring (date)
fromquerystring (date-time)
toquerystring (date-time)
Responses
200OK
Example
bash
curl -X GET "$BASE/v1/merchants/$merchantId/reports/z" \
  -H "X-Api-Key: $API_KEY"
GET/v1/merchants/{merchantId}/oversells
Parameters
NameInType
merchantIdpathstring (uuid)required
branchIdquerystring (uuid)
statusqueryinteger
pagequeryinteger | string (int32)
pageSizequeryinteger | string (int32)
Responses
200OK
Example
bash
curl -X GET "$BASE/v1/merchants/$merchantId/oversells" \
  -H "X-Api-Key: $API_KEY"
POST/v1/merchants/{merchantId}/oversells/{alertId}/acknowledge
Parameters
NameInType
merchantIdpathstring (uuid)required
alertIdpathstring (uuid)required
Request body
FieldTypeNotes
json
{
  "note": "string"
}
Responses
200OK
Example
bash
curl -X POST "$BASE/v1/merchants/$merchantId/oversells/$alertId/acknowledge" \
  -H "X-Api-Key: $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"note":"string"}'
GET/v1/merchants/{merchantId}/rejections
Parameters
NameInType
merchantIdpathstring (uuid)required
resolvedqueryboolean
pagequeryinteger | string (int32)
pageSizequeryinteger | string (int32)
Responses
200OK
Example
bash
curl -X GET "$BASE/v1/merchants/$merchantId/rejections" \
  -H "X-Api-Key: $API_KEY"
POST/v1/merchants/{merchantId}/rejections/{rejectionId}/resolve
Parameters
NameInType
merchantIdpathstring (uuid)required
rejectionIdpathstring (uuid)required
Request body
FieldTypeNotes
json
{
  "note": "string"
}
Responses
200OK
Example
bash
curl -X POST "$BASE/v1/merchants/$merchantId/rejections/$rejectionId/resolve" \
  -H "X-Api-Key: $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"note":"string"}'

NetworkReports

GET/v1/reports/network
Parameters
NameInType
groupByqueryinteger
fromquerystring (date)
toquerystring (date)
Responses
200OK
Example
bash
curl -X GET "$BASE/v1/reports/network" \
  -H "X-Api-Key: $API_KEY"
GET/v1/reports/platform
Parameters
NameInType
daysqueryinteger | string (int32)
Responses
200OK
Example
bash
curl -X GET "$BASE/v1/reports/platform" \
  -H "X-Api-Key: $API_KEY"

OrganizationBranding

GET/v1/organizations/{id}/branding
Parameters
NameInType
idpathstring (uuid)required
Responses
200OK
Example
bash
curl -X GET "$BASE/v1/organizations/$id/branding" \
  -H "X-Api-Key: $API_KEY"
PUT/v1/organizations/{id}/branding
Parameters
NameInType
idpathstring (uuid)required
Request body
FieldTypeNotes
brandName requiredstring
logoUrl requiredstring
primaryColor requiredstring
showPoweredByboolean
canOverrideBrandingboolean
json
{
  "brandName": "string",
  "logoUrl": "string",
  "primaryColor": "string",
  "showPoweredBy": false,
  "canOverrideBranding": false
}
Responses
200OK
Example
bash
curl -X PUT "$BASE/v1/organizations/$id/branding" \
  -H "X-Api-Key: $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"brandName":"string","logoUrl":"string","primaryColor":"string","showPoweredBy":false,"canOverrideBranding":false}'
GET/v1/organizations/{id}/domains
Parameters
NameInType
idpathstring (uuid)required
Responses
200OK
Example
bash
curl -X GET "$BASE/v1/organizations/$id/domains" \
  -H "X-Api-Key: $API_KEY"
POST/v1/organizations/{id}/domains
Parameters
NameInType
idpathstring (uuid)required
Request body
FieldTypeNotes
host requiredstring
json
{
  "host": "string"
}
Responses
200OK
Example
bash
curl -X POST "$BASE/v1/organizations/$id/domains" \
  -H "X-Api-Key: $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"host":"string"}'
POST/v1/organizations/{id}/domains/{domainId}/refresh
Parameters
NameInType
idpathstring (uuid)required
domainIdpathstring (uuid)required
Responses
200OK
Example
bash
curl -X POST "$BASE/v1/organizations/$id/domains/$domainId/refresh" \
  -H "X-Api-Key: $API_KEY"
DELETE/v1/organizations/{id}/domains/{domainId}
Parameters
NameInType
idpathstring (uuid)required
domainIdpathstring (uuid)required
Responses
200OK
Example
bash
curl -X DELETE "$BASE/v1/organizations/$id/domains/$domainId" \
  -H "X-Api-Key: $API_KEY"

Organizations

GET/v1/organizations
Parameters
NameInType
typequeryinteger
Responses
200OK
Example
bash
curl -X GET "$BASE/v1/organizations" \
  -H "X-Api-Key: $API_KEY"
POST/v1/organizations
Request body
FieldTypeNotes
type requiredinteger
parentId requiredstring (uuid)
name requiredstring
slug requiredstring
sandboxboolean
midstring
json
{
  "type": 0,
  "parentId": "00000000-0000-0000-0000-000000000000",
  "name": "string",
  "slug": "string",
  "sandbox": false,
  "mid": "string"
}
Responses
200OK
Example
bash
curl -X POST "$BASE/v1/organizations" \
  -H "X-Api-Key: $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"type":0,"parentId":"00000000-0000-0000-0000-000000000000","name":"string","slug":"string","sandbox":false,"mid":"string"}'
PUT/v1/organizations/{id}
Parameters
NameInType
idpathstring (uuid)required
Request body
FieldTypeNotes
name requiredstring
status requiredany
mid requiredstring
json
{
  "name": "string",
  "status": 0,
  "mid": "string"
}
Responses
200OK
Example
bash
curl -X PUT "$BASE/v1/organizations/$id" \
  -H "X-Api-Key: $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"string","status":0,"mid":"string"}'
GET/v1/organizations/{id}/users
Parameters
NameInType
idpathstring (uuid)required
Responses
200OK
Example
bash
curl -X GET "$BASE/v1/organizations/$id/users" \
  -H "X-Api-Key: $API_KEY"
POST/v1/organizations/{id}/users
Parameters
NameInType
idpathstring (uuid)required
Request body
FieldTypeNotes
email requiredstring
fullName requiredstring
password requiredstring
role requiredinteger
inviteboolean
json
{
  "email": "string",
  "fullName": "string",
  "password": "string",
  "role": 0,
  "invite": false
}
Responses
200OK
Example
bash
curl -X POST "$BASE/v1/organizations/$id/users" \
  -H "X-Api-Key: $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"email":"string","fullName":"string","password":"string","role":0,"invite":false}'
GET/v1/organizations/{id}/profile
Parameters
NameInType
idpathstring (uuid)required
Responses
200OK
Example
bash
curl -X GET "$BASE/v1/organizations/$id/profile" \
  -H "X-Api-Key: $API_KEY"
PUT/v1/organizations/{id}/profile
Parameters
NameInType
idpathstring (uuid)required
Request body
FieldTypeNotes
name requiredstring
address requiredstring
phone requiredstring
contactEmail requiredstring
taxId requiredstring
receiptFooter requiredstring
dailySummary requiredboolean
json
{
  "name": "string",
  "address": "string",
  "phone": "string",
  "contactEmail": "string",
  "taxId": "string",
  "receiptFooter": "string",
  "dailySummary": false
}
Responses
200OK
Example
bash
curl -X PUT "$BASE/v1/organizations/$id/profile" \
  -H "X-Api-Key: $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"string","address":"string","phone":"string","contactEmail":"string","taxId":"string","receiptFooter":"string","dailySummary":false}'
PUT/v1/organizations/{id}/users/{userId}
Parameters
NameInType
idpathstring (uuid)required
userIdpathstring (uuid)required
Request body
FieldTypeNotes
fullName requiredstring
role requiredany
isActive requiredboolean
json
{
  "fullName": "string",
  "role": 0,
  "isActive": false
}
Responses
200OK
Example
bash
curl -X PUT "$BASE/v1/organizations/$id/users/$userId" \
  -H "X-Api-Key: $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"fullName":"string","role":0,"isActive":false}'
POST/v1/organizations/{id}/users/{userId}/password
Parameters
NameInType
idpathstring (uuid)required
userIdpathstring (uuid)required
Request body
FieldTypeNotes
password requiredstring
json
{
  "password": "string"
}
Responses
200OK
Example
bash
curl -X POST "$BASE/v1/organizations/$id/users/$userId/password" \
  -H "X-Api-Key: $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"password":"string"}'
POST/v1/organizations/{id}/api-keys
Parameters
NameInType
idpathstring (uuid)required
Request body
FieldTypeNotes
name requiredstring
scopes requiredarray
json
{
  "name": "string",
  "scopes": [
    "string"
  ]
}
Responses
200OK
Example
bash
curl -X POST "$BASE/v1/organizations/$id/api-keys" \
  -H "X-Api-Key: $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"string","scopes":["string"]}'

Public

GET/v1/public/branding
Parameters
NameInType
hostquerystring
Responses
200OK
Example
bash
curl -X GET "$BASE/v1/public/branding" \
  -H "X-Api-Key: $API_KEY"

Sync

PUT/v1/sync/merchants
Request body
FieldTypeNotes
items requiredarray
json
{
  "items": [
    {
      "externalId": "string",
      "name": "string",
      "mid": "string",
      "slug": "string",
      "resellerId": "00000000-0000-0000-0000-000000000000",
      "status": null
    }
  ]
}
Responses
200OK
Example
bash
curl -X PUT "$BASE/v1/sync/merchants" \
  -H "X-Api-Key: $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"items":[{"externalId":"string","name":"string","mid":"string","slug":"string","resellerId":"00000000-0000-0000-0000-000000000000","status":null}]}'
PUT/v1/sync/branches
Request body
FieldTypeNotes
items requiredarray
json
{
  "items": [
    {
      "externalId": "string",
      "merchantExternalId": "string",
      "name": "string",
      "code": "string"
    }
  ]
}
Responses
200OK
Example
bash
curl -X PUT "$BASE/v1/sync/branches" \
  -H "X-Api-Key: $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"items":[{"externalId":"string","merchantExternalId":"string","name":"string","code":"string"}]}'
PUT/v1/sync/terminals
Request body
FieldTypeNotes
items requiredarray
json
{
  "items": [
    {
      "externalId": "string",
      "tid": "string",
      "serialNumber": "string",
      "model": "string",
      "status": null,
      "merchantExternalId": "string",
      "branchExternalId": "string"
    }
  ]
}
Responses
200OK
Example
bash
curl -X PUT "$BASE/v1/sync/terminals" \
  -H "X-Api-Key: $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"items":[{"externalId":"string","tid":"string","serialNumber":"string","model":"string","status":null,"merchantExternalId":"string","branchExternalId":"string"}]}'
POST/v1/sync/webhooks
Request body
FieldTypeNotes
eventId requiredstring
type requiredstring
occurredAt requiredstring (date-time)
data requiredany
json
{
  "eventId": "string",
  "type": "string",
  "occurredAt": "2026-11-16T10:00:00+01:00",
  "data": "string"
}
Responses
200OK
Example
bash
curl -X POST "$BASE/v1/sync/webhooks" \
  -H "X-Api-Key: $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"eventId":"string","type":"string","occurredAt":"2026-11-16T10:00:00+01:00","data":"string"}'

Terminal

GET/v1/terminal/catalog
Parameters
NameInType
cursorquerystring
updatedSincequerystring (date-time)
limitqueryinteger | string (int32)
Responses
200OK
Example
bash
curl -X GET "$BASE/v1/terminal/catalog" \
  -H "X-Api-Key: $API_KEY"
GET/v1/terminal/categories
Responses
200OK
Example
bash
curl -X GET "$BASE/v1/terminal/categories" \
  -H "X-Api-Key: $API_KEY"
GET/v1/terminal/lookup
Parameters
NameInType
barcodequerystring
Responses
200OK
Example
bash
curl -X GET "$BASE/v1/terminal/lookup" \
  -H "X-Api-Key: $API_KEY"
GET/v1/terminal/stock/{variantId}
Parameters
NameInType
variantIdpathstring (uuid)required
Responses
200OK
Example
bash
curl -X GET "$BASE/v1/terminal/stock/$variantId" \
  -H "X-Api-Key: $API_KEY"
POST/v1/terminal/sales
Parameters
NameInType
Idempotency-Keyheaderstring
Request body
FieldTypeNotes
saleId requiredstring (uuid)
receiptNo requiredstring
cashierRef requiredstring
occurredAt requiredstring (date-time)
shiftId requiredstring (uuid)
lines requiredarray
tenders requiredarray
expectedTotalKobo requiredinteger | string (int64)
note requiredstring
json
{
  "saleId": "00000000-0000-0000-0000-000000000000",
  "receiptNo": "string",
  "cashierRef": "string",
  "occurredAt": "2026-11-16T10:00:00+01:00",
  "shiftId": "00000000-0000-0000-0000-000000000000",
  "lines": [
    {
      "variantId": "00000000-0000-0000-0000-000000000000",
      "quantity": 0,
      "unitPriceKobo": 0,
      "discountKobo": 0
    }
  ],
  "tenders": [
    {
      "type": 0,
      "amountKobo": 0,
      "rrn": "string",
      "stan": "string",
      "tid": "string",
      "maskedPan": "string",
      "authCode": "string",
      "reference": "string"
    }
  ],
  "expectedTotalKobo": 0,
  "note": "string"
}
Responses
200OK
Example
bash
curl -X POST "$BASE/v1/terminal/sales" \
  -H "X-Api-Key: $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"saleId":"00000000-0000-0000-0000-000000000000","receiptNo":"string","cashierRef":"string","occurredAt":"2026-11-16T10:00:00+01:00","shiftId":"00000000-0000-0000-0000-000000000000","lines":[{"variantId":"00000000-0000-0000-0000-000000000000","quantity":0,"unitPriceKobo":0,"discountKobo":0}],"tenders":[{"type":0,"amountKobo":0,"rrn":"string","stan":"string","tid":"string","maskedPan":"string","authCode":"string","reference":"string"}],"expectedTotalKobo":0,"note":"string"}'
GET/v1/terminal/sales/{saleId}
Parameters
NameInType
saleIdpathstring (uuid)required
Responses
200OK
Example
bash
curl -X GET "$BASE/v1/terminal/sales/$saleId" \
  -H "X-Api-Key: $API_KEY"
POST/v1/terminal/sales/{saleId}/returns
Parameters
NameInType
saleIdpathstring (uuid)required
Request body
FieldTypeNotes
returnId requiredstring (uuid)
occurredAt requiredstring (date-time)
reason requiredstring
cashierRef requiredstring
lines requiredarray
refunds requiredarray
json
{
  "returnId": "00000000-0000-0000-0000-000000000000",
  "occurredAt": "2026-11-16T10:00:00+01:00",
  "reason": "string",
  "cashierRef": "string",
  "lines": [
    {
      "saleLineId": "00000000-0000-0000-0000-000000000000",
      "quantity": 0,
      "restock": false
    }
  ],
  "refunds": [
    {
      "type": 0,
      "amountKobo": 0,
      "rrn": "string",
      "reference": "string"
    }
  ]
}
Responses
200OK
Example
bash
curl -X POST "$BASE/v1/terminal/sales/$saleId/returns" \
  -H "X-Api-Key: $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"returnId":"00000000-0000-0000-0000-000000000000","occurredAt":"2026-11-16T10:00:00+01:00","reason":"string","cashierRef":"string","lines":[{"saleLineId":"00000000-0000-0000-0000-000000000000","quantity":0,"restock":false}],"refunds":[{"type":0,"amountKobo":0,"rrn":"string","reference":"string"}]}'
POST/v1/terminal/shifts
Request body
FieldTypeNotes
shiftId requiredstring (uuid)
branchId requiredstring (uuid)
tid requiredstring
openedAt requiredstring (date-time)
openingFloatKobo requiredinteger | string (int64)
cashierRef requiredstring
json
{
  "shiftId": "00000000-0000-0000-0000-000000000000",
  "branchId": "00000000-0000-0000-0000-000000000000",
  "tid": "string",
  "openedAt": "2026-11-16T10:00:00+01:00",
  "openingFloatKobo": 0,
  "cashierRef": "string"
}
Responses
200OK
Example
bash
curl -X POST "$BASE/v1/terminal/shifts" \
  -H "X-Api-Key: $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"shiftId":"00000000-0000-0000-0000-000000000000","branchId":"00000000-0000-0000-0000-000000000000","tid":"string","openedAt":"2026-11-16T10:00:00+01:00","openingFloatKobo":0,"cashierRef":"string"}'
POST/v1/terminal/shifts/{shiftId}/close
Parameters
NameInType
shiftIdpathstring (uuid)required
Request body
FieldTypeNotes
countedCashKobo requiredinteger | string (int64)
closedAt requiredstring (date-time)
cashierRef requiredstring
json
{
  "countedCashKobo": 0,
  "closedAt": "2026-11-16T10:00:00+01:00",
  "cashierRef": "string"
}
Responses
200OK
Example
bash
curl -X POST "$BASE/v1/terminal/shifts/$shiftId/close" \
  -H "X-Api-Key: $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"countedCashKobo":0,"closedAt":"2026-11-16T10:00:00+01:00","cashierRef":"string"}'
GET/v1/terminal/shifts/{shiftId}
Parameters
NameInType
shiftIdpathstring (uuid)required
Responses
200OK
Example
bash
curl -X GET "$BASE/v1/terminal/shifts/$shiftId" \
  -H "X-Api-Key: $API_KEY"
GET/v1/terminal/shifts/{shiftId}/report
Parameters
NameInType
shiftIdpathstring (uuid)required
Responses
200OK
Example
bash
curl -X GET "$BASE/v1/terminal/shifts/$shiftId/report" \
  -H "X-Api-Key: $API_KEY"

Terminals

GET/v1/terminals
Parameters
NameInType
merchantIdquerystring (uuid)
unassignedqueryboolean
statusqueryinteger
qquerystring
pagequeryinteger | string (int32)
pageSizequeryinteger | string (int32)
Responses
200OK
Example
bash
curl -X GET "$BASE/v1/terminals" \
  -H "X-Api-Key: $API_KEY"
POST/v1/terminals
Request body
FieldTypeNotes
tid requiredstring
serialNumber requiredstring
model requiredstring
merchantId requiredstring (uuid)
branchId requiredstring (uuid)
operatorId requiredstring (uuid)
json
{
  "tid": "string",
  "serialNumber": "string",
  "model": "string",
  "merchantId": "00000000-0000-0000-0000-000000000000",
  "branchId": "00000000-0000-0000-0000-000000000000",
  "operatorId": "00000000-0000-0000-0000-000000000000"
}
Responses
200OK
Example
bash
curl -X POST "$BASE/v1/terminals" \
  -H "X-Api-Key: $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"tid":"string","serialNumber":"string","model":"string","merchantId":"00000000-0000-0000-0000-000000000000","branchId":"00000000-0000-0000-0000-000000000000","operatorId":"00000000-0000-0000-0000-000000000000"}'
PUT/v1/terminals/{id}
Parameters
NameInType
idpathstring (uuid)required
Request body
FieldTypeNotes
serialNumber requiredstring
model requiredstring
status requiredany
assignment requiredstring
merchantId requiredstring (uuid)
branchId requiredstring (uuid)
json
{
  "serialNumber": "string",
  "model": "string",
  "status": 0,
  "assignment": "string",
  "merchantId": "00000000-0000-0000-0000-000000000000",
  "branchId": "00000000-0000-0000-0000-000000000000"
}
Responses
200OK
Example
bash
curl -X PUT "$BASE/v1/terminals/$id" \
  -H "X-Api-Key: $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"serialNumber":"string","model":"string","status":0,"assignment":"string","merchantId":"00000000-0000-0000-0000-000000000000","branchId":"00000000-0000-0000-0000-000000000000"}'
POST/v1/terminals/{tid}/sessions
Parameters
NameInType
tidpathstringrequired
Responses
200OK
Example
bash
curl -X POST "$BASE/v1/terminals/$tid/sessions" \
  -H "X-Api-Key: $API_KEY"

Transactions

POST/v1/transactions
Request body
FieldTypeNotes
items requiredarray
json
{
  "items": [
    {
      "externalId": "string",
      "tid": "string",
      "mid": "string",
      "type": null,
      "rrn": "string",
      "stan": "string",
      "amountKobo": 0,
      "responseCode": "string",
      "occurredAt": "2026-11-16T10:00:00+01:00",
      "maskedPan": "string",
      "authCode": "string",
      "scheme": "string"
    }
  ]
}
Responses
200OK
Example
bash
curl -X POST "$BASE/v1/transactions" \
  -H "X-Api-Key: $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"items":[{"externalId":"string","tid":"string","mid":"string","type":null,"rrn":"string","stan":"string","amountKobo":0,"responseCode":"string","occurredAt":"2026-11-16T10:00:00+01:00","maskedPan":"string","authCode":"string","scheme":"string"}]}'

Webhooks

GET/v1/organizations/{id}/webhooks/events
Parameters
NameInType
idpathstring (uuid)required
Responses
200OK
Example
bash
curl -X GET "$BASE/v1/organizations/$id/webhooks/events" \
  -H "X-Api-Key: $API_KEY"
GET/v1/organizations/{id}/webhooks
Parameters
NameInType
idpathstring (uuid)required
Responses
200OK
Example
bash
curl -X GET "$BASE/v1/organizations/$id/webhooks" \
  -H "X-Api-Key: $API_KEY"
POST/v1/organizations/{id}/webhooks
Parameters
NameInType
idpathstring (uuid)required
Request body
FieldTypeNotes
url requiredstring
events requiredarray
description requiredstring
json
{
  "url": "string",
  "events": [
    "string"
  ],
  "description": "string"
}
Responses
200OK
Example
bash
curl -X POST "$BASE/v1/organizations/$id/webhooks" \
  -H "X-Api-Key: $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"url":"string","events":["string"],"description":"string"}'
PATCH/v1/organizations/{id}/webhooks/{endpointId}
Parameters
NameInType
idpathstring (uuid)required
endpointIdpathstring (uuid)required
Request body
FieldTypeNotes
url requiredstring
events requiredarray
isActive requiredboolean
json
{
  "url": "string",
  "events": [
    "string"
  ],
  "isActive": false
}
Responses
200OK
Example
bash
curl -X PATCH "$BASE/v1/organizations/$id/webhooks/$endpointId" \
  -H "X-Api-Key: $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"url":"string","events":["string"],"isActive":false}'
DELETE/v1/organizations/{id}/webhooks/{endpointId}
Parameters
NameInType
idpathstring (uuid)required
endpointIdpathstring (uuid)required
Responses
200OK
Example
bash
curl -X DELETE "$BASE/v1/organizations/$id/webhooks/$endpointId" \
  -H "X-Api-Key: $API_KEY"
POST/v1/organizations/{id}/webhooks/{endpointId}/rotate-secret
Parameters
NameInType
idpathstring (uuid)required
endpointIdpathstring (uuid)required
Responses
200OK
Example
bash
curl -X POST "$BASE/v1/organizations/$id/webhooks/$endpointId/rotate-secret" \
  -H "X-Api-Key: $API_KEY"
POST/v1/organizations/{id}/webhooks/{endpointId}/test
Parameters
NameInType
idpathstring (uuid)required
endpointIdpathstring (uuid)required
Responses
200OK
Example
bash
curl -X POST "$BASE/v1/organizations/$id/webhooks/$endpointId/test" \
  -H "X-Api-Key: $API_KEY"
GET/v1/organizations/{id}/webhooks/{endpointId}/deliveries
Parameters
NameInType
idpathstring (uuid)required
endpointIdpathstring (uuid)required
statusqueryinteger
pagequeryinteger | string (int32)
pageSizequeryinteger | string (int32)
Responses
200OK
Example
bash
curl -X GET "$BASE/v1/organizations/$id/webhooks/$endpointId/deliveries" \
  -H "X-Api-Key: $API_KEY"
POST/v1/organizations/{id}/webhooks/{endpointId}/deliveries/{deliveryId}/retry
Parameters
NameInType
idpathstring (uuid)required
endpointIdpathstring (uuid)required
deliveryIdpathstring (uuid)required
Responses
200OK
Example
bash
curl -X POST "$BASE/v1/organizations/$id/webhooks/$endpointId/deliveries/$deliveryId/retry" \
  -H "X-Api-Key: $API_KEY"