API reference

Cashless, POS & wallets

85 methods. Request fields, an example response, and notes on what comes back in data.

Base https://api.groove.com.na Updated October 2026

GET /api/cashless/admin/outstanding-withdrawals

List or read resources for this path.

Bearer token

Request

No body or query parameters. Path values above, if any, are enough.

Example response

{
  "status": "success",
  "success": true,
  "statusCode": "00000",
  "message": "OK",
  "shortMessage": "SUCCESS",
  "timestamp": "2026-10-10T21:00:00.000Z",
  "requestId": "a1b2c3d4e5f6g7h8",
  "data": {}
}

Response data

Success returns the standard envelope. data holds the payload for this method — confirm the shape in your client when integrating.

GET /api/cashless/admin/overview

List or read resources for this path.

Bearer token

Request

No body or query parameters. Path values above, if any, are enough.

Example response

{
  "status": "success",
  "success": true,
  "statusCode": "00000",
  "message": "OK",
  "shortMessage": "SUCCESS",
  "timestamp": "2026-10-10T21:00:00.000Z",
  "requestId": "a1b2c3d4e5f6g7h8",
  "data": {}
}

Response data

Success returns the standard envelope. data holds the payload for this method — confirm the shape in your client when integrating.

POST /api/cashless/admin/wallets/:walletId/wearables

Create a resource or run this action.

Bearer token

Request

Parameter	In	Req.	Description
`walletId`	path	Y	Cashless wallet identifier for an event.

Example response

{
  "status": "success",
  "success": true,
  "statusCode": "00000",
  "message": "OK",
  "shortMessage": "SUCCESS",
  "timestamp": "2026-10-10T21:00:00.000Z",
  "requestId": "a1b2c3d4e5f6g7h8",
  "data": {}
}

Response data

Success returns the standard envelope. data holds the payload for this method — confirm the shape in your client when integrating.

PATCH /api/cashless/admin/wearables/:wearableId/status

Update selected fields on this resource.

Bearer token

Request

Parameter	In	Req.	Description
`wearableId`	path	Y	NFC wearable / band identifier.

Example response

{
  "status": "success",
  "success": true,
  "statusCode": "00000",
  "message": "OK",
  "shortMessage": "SUCCESS",
  "timestamp": "2026-10-10T21:00:00.000Z",
  "requestId": "a1b2c3d4e5f6g7h8",
  "data": {}
}

Response data

Success returns the standard envelope. data holds the payload for this method — confirm the shape in your client when integrating.

GET /api/cashless/admin/wearables/search

List or read resources for this path.

Bearer token

Request

No body or query parameters. Path values above, if any, are enough.

Example response

{
  "status": "success",
  "success": true,
  "statusCode": "00000",
  "message": "OK",
  "shortMessage": "SUCCESS",
  "timestamp": "2026-10-10T21:00:00.000Z",
  "requestId": "a1b2c3d4e5f6g7h8",
  "data": {}
}

Response data

Success returns the standard envelope. data holds the payload for this method — confirm the shape in your client when integrating.

GET /api/cashless/desk/events/:eventId/shift-stats

List or read resources for this path.

Bearer token

Request

Parameter	In	Req.	Description
`eventId`	path	Y	Mongo ObjectId of the event.

Example response

{
  "status": "success",
  "success": true,
  "statusCode": "00000",
  "message": "OK",
  "shortMessage": "SUCCESS",
  "timestamp": "2026-10-10T21:00:00.000Z",
  "requestId": "a1b2c3d4e5f6g7h8",
  "data": {}
}

Response data

Success returns the standard envelope. data holds the payload for this method — confirm the shape in your client when integrating.

POST /api/cashless/desk/events/:eventId/wearables/balance

Create a resource or run this action.

Bearer token

Request

Parameter	In	Req.	Description
`eventId`	path	Y	Mongo ObjectId of the event.

Example response

{
  "status": "success",
  "success": true,
  "statusCode": "00000",
  "message": "OK",
  "shortMessage": "SUCCESS",
  "timestamp": "2026-10-10T21:00:00.000Z",
  "requestId": "a1b2c3d4e5f6g7h8",
  "data": {}
}

Response data

Success returns the standard envelope. data holds the payload for this method — confirm the shape in your client when integrating.

POST /api/cashless/desk/events/:eventId/wearables/guest

Create a resource or run this action.

Bearer token

Request

Parameter	In	Req.	Description
`eventId`	path	Y	Mongo ObjectId of the event.

Example response

{
  "status": "success",
  "success": true,
  "statusCode": "00000",
  "message": "OK",
  "shortMessage": "SUCCESS",
  "timestamp": "2026-10-10T21:00:00.000Z",
  "requestId": "a1b2c3d4e5f6g7h8",
  "data": {}
}

Response data

Success returns the standard envelope. data holds the payload for this method — confirm the shape in your client when integrating.

POST /api/cashless/desk/events/:eventId/wearables/link

Create a resource or run this action.

Bearer token

Request

Parameter	In	Req.	Description
`eventId`	path	Y	Mongo ObjectId of the event.

Example response

{
  "status": "success",
  "success": true,
  "statusCode": "00000",
  "message": "OK",
  "shortMessage": "SUCCESS",
  "timestamp": "2026-10-10T21:00:00.000Z",
  "requestId": "a1b2c3d4e5f6g7h8",
  "data": {}
}

Response data

Success returns the standard envelope. data holds the payload for this method — confirm the shape in your client when integrating.

POST /api/cashless/desk/events/:eventId/wearables/top-up

Create a resource or run this action.

Bearer token

Request

Parameter	In	Req.	Description
`eventId`	path	Y	Mongo ObjectId of the event.

Example response

{
  "status": "success",
  "success": true,
  "statusCode": "00000",
  "message": "OK",
  "shortMessage": "SUCCESS",
  "timestamp": "2026-10-10T21:00:00.000Z",
  "requestId": "a1b2c3d4e5f6g7h8",
  "data": {}
}

Response data

Success returns the standard envelope. data holds the payload for this method — confirm the shape in your client when integrating.

POST /api/cashless/desk/events/:eventId/wearables/top-up/maris/verify

Confirm a Maris one-time password.

Bearer token

Request

Parameter	In	Req.	Description
`eventId`	path	Y	Mongo ObjectId of the event.

Example response

{
  "status": "success",
  "success": true,
  "statusCode": "00000",
  "message": "OK",
  "shortMessage": "SUCCESS",
  "timestamp": "2026-10-10T21:00:00.000Z",
  "requestId": "a1b2c3d4e5f6g7h8",
  "data": {}
}

Response data

Success returns the standard envelope. data holds the payload for this method — confirm the shape in your client when integrating.

GET /api/cashless/desk/operators

List or read resources for this path.

Bearer token

Request

No body or query parameters. Path values above, if any, are enough.

Example response

{
  "status": "success",
  "success": true,
  "statusCode": "00000",
  "message": "OK",
  "shortMessage": "SUCCESS",
  "timestamp": "2026-10-10T21:00:00.000Z",
  "requestId": "a1b2c3d4e5f6g7h8",
  "data": {}
}

Response data

Success returns the standard envelope. data holds the payload for this method — confirm the shape in your client when integrating.

POST /api/cashless/desk/operators

Create a resource or run this action.

Bearer token

Request

Parameter	In	Req.	Description
`email`	body	Y	Account email address (stored lowercase).
`displayName`	body	Y	Request field. See Zod schema in the route module for constraints.
`phone`	body	Y	Contact mobile number in international or local form.
`accessScope`	body	Y	Request field. See Zod schema in the route module for constraints.

Example body

{
  "email": "desk.op@example.com",
  "displayName": "Desk Operator",
  "phone": "+264813333333",
  "accessScope": "full_time"
}

Example response

{
  "status": "success",
  "success": true,
  "statusCode": "00000",
  "message": "OK",
  "shortMessage": "SUCCESS",
  "timestamp": "2026-10-10T21:00:00.000Z",
  "requestId": "a1b2c3d4e5f6g7h8",
  "data": {}
}

Response data

Success returns the standard envelope. data holds the payload for this method — confirm the shape in your client when integrating.

POST /api/cashless/desk/operators/:operatorId/biometrics/enroll

Create a resource or run this action.

Bearer token

Request

Parameter	In	Req.	Description
`operatorId`	path	Y	Path parameter identifying the resource.

Example response

{
  "status": "success",
  "success": true,
  "statusCode": "00000",
  "message": "OK",
  "shortMessage": "SUCCESS",
  "timestamp": "2026-10-10T21:00:00.000Z",
  "requestId": "a1b2c3d4e5f6g7h8",
  "data": {}
}

Response data

Success returns the standard envelope. data holds the payload for this method — confirm the shape in your client when integrating.

POST /api/cashless/desk/operators/:operatorId/pin/change

Create a resource or run this action.

Bearer token

Request

Parameter	In	Req.	Description
`operatorId`	path	Y	Path parameter identifying the resource.

Example response

{
  "status": "success",
  "success": true,
  "statusCode": "00000",
  "message": "OK",
  "shortMessage": "SUCCESS",
  "timestamp": "2026-10-10T21:00:00.000Z",
  "requestId": "a1b2c3d4e5f6g7h8",
  "data": {}
}

Response data

Success returns the standard envelope. data holds the payload for this method — confirm the shape in your client when integrating.

POST /api/cashless/desk/operators/:operatorId/reset-pin

Create a resource or run this action.

Bearer token

Request

Parameter	In	Req.	Description
`operatorId`	path	Y	Path parameter identifying the resource.

Example response

{
  "status": "success",
  "success": true,
  "statusCode": "00000",
  "message": "OK",
  "shortMessage": "SUCCESS",
  "timestamp": "2026-10-10T21:00:00.000Z",
  "requestId": "a1b2c3d4e5f6g7h8",
  "data": {}
}

Response data

Success returns the standard envelope. data holds the payload for this method — confirm the shape in your client when integrating.

POST /api/cashless/desk/operators/:operatorId/revoke-biometrics

Create a resource or run this action.

Bearer token

Request

Parameter	In	Req.	Description
`operatorId`	path	Y	Path parameter identifying the resource.

Example response

{
  "status": "success",
  "success": true,
  "statusCode": "00000",
  "message": "OK",
  "shortMessage": "SUCCESS",
  "timestamp": "2026-10-10T21:00:00.000Z",
  "requestId": "a1b2c3d4e5f6g7h8",
  "data": {}
}

Response data

Success returns the standard envelope. data holds the payload for this method — confirm the shape in your client when integrating.

PATCH /api/cashless/desk/operators/:operatorId/status

Update selected fields on this resource.

Bearer token

Request

Parameter	In	Req.	Description
`operatorId`	path	Y	Path parameter identifying the resource.

Example response

{
  "status": "success",
  "success": true,
  "statusCode": "00000",
  "message": "OK",
  "shortMessage": "SUCCESS",
  "timestamp": "2026-10-10T21:00:00.000Z",
  "requestId": "a1b2c3d4e5f6g7h8",
  "data": {}
}

Response data

Success returns the standard envelope. data holds the payload for this method — confirm the shape in your client when integrating.

POST /api/cashless/desk/operators/:operatorId/verify

Create a resource or run this action.

Bearer token

Request

Parameter	In	Req.	Description
`operatorId`	path	Y	Path parameter identifying the resource.

Example response

{
  "status": "success",
  "success": true,
  "statusCode": "00000",
  "message": "OK",
  "shortMessage": "SUCCESS",
  "timestamp": "2026-10-10T21:00:00.000Z",
  "requestId": "a1b2c3d4e5f6g7h8",
  "data": {}
}

Response data

Success returns the standard envelope. data holds the payload for this method — confirm the shape in your client when integrating.

POST /api/cashless/desk/session/end

Create a resource or run this action.

Bearer token

Request

No body or query parameters. Path values above, if any, are enough.

Example body

{}

Example response

{
  "status": "success",
  "success": true,
  "statusCode": "00000",
  "message": "OK",
  "shortMessage": "SUCCESS",
  "timestamp": "2026-10-10T21:00:00.000Z",
  "requestId": "a1b2c3d4e5f6g7h8",
  "data": {}
}

Response data

Success returns the standard envelope. data holds the payload for this method — confirm the shape in your client when integrating.

POST /api/cashless/desk/session/start

Create a resource or run this action.

Bearer token

Request

Parameter	In	Req.	Description
`eventId`	body	Y	Mongo ObjectId of the event.

Example body

{
  "eventId": "{{eventId}}"
}

Example response

{
  "status": "success",
  "success": true,
  "statusCode": "00000",
  "message": "OK",
  "shortMessage": "SUCCESS",
  "timestamp": "2026-10-10T21:00:00.000Z",
  "requestId": "a1b2c3d4e5f6g7h8",
  "data": {}
}

Response data

Success returns the standard envelope. data holds the payload for this method — confirm the shape in your client when integrating.

GET /api/cashless/fan/my-events

List or read resources for this path.

Bearer token

Request

No body or query parameters. Path values above, if any, are enough.

Example response

{
  "status": "success",
  "success": true,
  "statusCode": "00000",
  "message": "OK",
  "shortMessage": "SUCCESS",
  "timestamp": "2026-10-10T21:00:00.000Z",
  "requestId": "a1b2c3d4e5f6g7h8",
  "data": {}
}

Response data

Success returns the standard envelope. data holds the payload for this method — confirm the shape in your client when integrating.

GET /api/cashless/fan/my-events/:eventId/menu

List or read resources for this path.

Bearer token

Request

Parameter	In	Req.	Description
`eventId`	path	Y	Mongo ObjectId of the event.

Example response

{
  "status": "success",
  "success": true,
  "statusCode": "00000",
  "message": "OK",
  "shortMessage": "SUCCESS",
  "timestamp": "2026-10-10T21:00:00.000Z",
  "requestId": "a1b2c3d4e5f6g7h8",
  "data": {}
}

Response data

Success returns the standard envelope. data holds the payload for this method — confirm the shape in your client when integrating.

GET /api/cashless/fan/my-events/:eventId/tickets

List or read resources for this path.

Bearer token

Request

Parameter	In	Req.	Description
`eventId`	path	Y	Mongo ObjectId of the event.

Example response

{
  "status": "success",
  "success": true,
  "statusCode": "00000",
  "message": "OK",
  "shortMessage": "SUCCESS",
  "timestamp": "2026-10-10T21:00:00.000Z",
  "requestId": "a1b2c3d4e5f6g7h8",
  "data": {}
}

Response data

Success returns the standard envelope. data holds the payload for this method — confirm the shape in your client when integrating.

GET /api/cashless/fan/my-events/:eventId/vendors

List or read resources for this path.

Bearer token

Request

Parameter	In	Req.	Description
`eventId`	path	Y	Mongo ObjectId of the event.

Example response

{
  "status": "success",
  "success": true,
  "statusCode": "00000",
  "message": "OK",
  "shortMessage": "SUCCESS",
  "timestamp": "2026-10-10T21:00:00.000Z",
  "requestId": "a1b2c3d4e5f6g7h8",
  "data": {}
}

Response data

Success returns the standard envelope. data holds the payload for this method — confirm the shape in your client when integrating.

GET /api/cashless/fan/pos-sessions/:token/context

Read or complete a POS checkout session.

Bearer token

Request

Parameter	In	Req.	Description
`token`	path	Y	Opaque session or activation token.

Example response

{
  "status": "success",
  "success": true,
  "statusCode": "00000",
  "message": "OK",
  "shortMessage": "SUCCESS",
  "timestamp": "2026-10-10T21:00:00.000Z",
  "requestId": "a1b2c3d4e5f6g7h8",
  "data": {}
}

Response data

Success returns the standard envelope. data holds the payload for this method — confirm the shape in your client when integrating.

POST /api/cashless/fan/pos-sessions/:token/external-intent

Open a POS checkout session for the guest to pay.

Public

Request

Parameter	In	Req.	Description
`token`	path	Y	Opaque session or activation token.

Example response

{
  "status": "success",
  "success": true,
  "statusCode": "00000",
  "message": "OK",
  "shortMessage": "SUCCESS",
  "timestamp": "2026-10-10T21:00:00.000Z",
  "requestId": "a1b2c3d4e5f6g7h8",
  "data": {}
}

Response data

Success returns the standard envelope. data holds the payload for this method — confirm the shape in your client when integrating.

POST /api/cashless/fan/pos-sessions/:token/pay-card

Open a POS checkout session for the guest to pay.

Bearer token

Request

Parameter	In	Req.	Description
`token`	path	Y	Opaque session or activation token.

Example response

{
  "status": "success",
  "success": true,
  "statusCode": "00000",
  "message": "OK",
  "shortMessage": "SUCCESS",
  "timestamp": "2026-10-10T21:00:00.000Z",
  "requestId": "a1b2c3d4e5f6g7h8",
  "data": {}
}

Response data

Success returns the standard envelope. data holds the payload for this method — confirm the shape in your client when integrating.

POST /api/cashless/fan/pos-sessions/:token/pay-maris/send-otp

Open a POS checkout session for the guest to pay.

Public

Request

Parameter	In	Req.	Description
`token`	path	Y	Opaque session or activation token.

Example response

{
  "status": "success",
  "success": true,
  "statusCode": "00000",
  "message": "OK",
  "shortMessage": "SUCCESS",
  "timestamp": "2026-10-10T21:00:00.000Z",
  "requestId": "a1b2c3d4e5f6g7h8",
  "data": {}
}

Response data

Success returns the standard envelope. data holds the payload for this method — confirm the shape in your client when integrating.

POST /api/cashless/fan/pos-sessions/:token/pay-maris/verify-otp

Open a POS checkout session for the guest to pay.

Public

Request

Parameter	In	Req.	Description
`token`	path	Y	Opaque session or activation token.

Example response

{
  "status": "success",
  "success": true,
  "statusCode": "00000",
  "message": "OK",
  "shortMessage": "SUCCESS",
  "timestamp": "2026-10-10T21:00:00.000Z",
  "requestId": "a1b2c3d4e5f6g7h8",
  "data": {}
}

Response data

Success returns the standard envelope. data holds the payload for this method — confirm the shape in your client when integrating.

POST /api/cashless/fan/pos-sessions/:token/pay-wallet

Open a POS checkout session for the guest to pay.

Bearer token

Request

Parameter	In	Req.	Description
`token`	path	Y	Opaque session or activation token.

Example response

{
  "status": "success",
  "success": true,
  "statusCode": "00000",
  "message": "OK",
  "shortMessage": "SUCCESS",
  "timestamp": "2026-10-10T21:00:00.000Z",
  "requestId": "a1b2c3d4e5f6g7h8",
  "data": {}
}

Response data

Success returns the standard envelope. data holds the payload for this method — confirm the shape in your client when integrating.

POST /api/cashless/fan/tickets/claim

Create a resource or run this action.

Bearer token

Request

Parameter	In	Req.	Description
`claimToken`	body	Y	Request field. See Zod schema in the route module for constraints.

Example body

{
  "claimToken": "{{claimToken}}"
}

Example response

{
  "status": "success",
  "success": true,
  "statusCode": "00000",
  "message": "OK",
  "shortMessage": "SUCCESS",
  "timestamp": "2026-10-10T21:00:00.000Z",
  "requestId": "a1b2c3d4e5f6g7h8",
  "data": {}
}

Response data

Success returns the standard envelope. data holds the payload for this method — confirm the shape in your client when integrating.

GET /api/cashless/fan/wallets

List or read resources for this path.

Bearer token

Request

No body or query parameters. Path values above, if any, are enough.

Example response

{
  "status": "success",
  "success": true,
  "statusCode": "00000",
  "message": "OK",
  "shortMessage": "SUCCESS",
  "timestamp": "2026-10-10T21:00:00.000Z",
  "requestId": "a1b2c3d4e5f6g7h8",
  "data": {}
}

Response data

Success returns the standard envelope. data holds the payload for this method — confirm the shape in your client when integrating.

GET /api/cashless/fan/wallets/:walletId/detail

List or read resources for this path.

Bearer token

Request

Parameter	In	Req.	Description
`walletId`	path	Y	Cashless wallet identifier for an event.

Example response

{
  "status": "success",
  "success": true,
  "statusCode": "00000",
  "message": "OK",
  "shortMessage": "SUCCESS",
  "timestamp": "2026-10-10T21:00:00.000Z",
  "requestId": "a1b2c3d4e5f6g7h8",
  "data": {}
}

Response data

Success returns the standard envelope. data holds the payload for this method — confirm the shape in your client when integrating.

GET /api/cashless/fan/wallets/:walletId/ledger

List or read resources for this path.

Bearer token

Request

Parameter	In	Req.	Description
`walletId`	path	Y	Cashless wallet identifier for an event.

Example response

{
  "status": "success",
  "success": true,
  "statusCode": "00000",
  "message": "OK",
  "shortMessage": "SUCCESS",
  "timestamp": "2026-10-10T21:00:00.000Z",
  "requestId": "a1b2c3d4e5f6g7h8",
  "data": {}
}

Response data

Success returns the standard envelope. data holds the payload for this method — confirm the shape in your client when integrating.

GET /api/cashless/fan/wallets/:walletId/ledger/:entryId

Fetch one resource by id or token.

Bearer token

Request

Parameter	In	Req.	Description
`walletId`	path	Y	Cashless wallet identifier for an event.
`entryId`	path	Y	Path parameter identifying the resource.

Example response

{
  "status": "success",
  "success": true,
  "statusCode": "00000",
  "message": "OK",
  "shortMessage": "SUCCESS",
  "timestamp": "2026-10-10T21:00:00.000Z",
  "requestId": "a1b2c3d4e5f6g7h8",
  "data": {}
}

Response data

Success returns the standard envelope. data holds the payload for this method — confirm the shape in your client when integrating.

POST /api/cashless/fan/wallets/:walletId/ledger/:entryId/receipt-email

Create a resource or run this action.

Bearer token

Request

Parameter	In	Req.	Description
`walletId`	path	Y	Cashless wallet identifier for an event.
`entryId`	path	Y	Path parameter identifying the resource.

Example response

{
  "status": "success",
  "success": true,
  "statusCode": "00000",
  "message": "OK",
  "shortMessage": "SUCCESS",
  "timestamp": "2026-10-10T21:00:00.000Z",
  "requestId": "a1b2c3d4e5f6g7h8",
  "data": {}
}

Response data

Success returns the standard envelope. data holds the payload for this method — confirm the shape in your client when integrating.

POST /api/cashless/fan/wallets/:walletId/top-up-demo

Create a resource or run this action.

Bearer token

Request

Parameter	In	Req.	Description
`walletId`	path	Y	Cashless wallet identifier for an event.

Example response

{
  "status": "success",
  "success": true,
  "statusCode": "00000",
  "message": "OK",
  "shortMessage": "SUCCESS",
  "timestamp": "2026-10-10T21:00:00.000Z",
  "requestId": "a1b2c3d4e5f6g7h8",
  "data": {}
}

Response data

Success returns the standard envelope. data holds the payload for this method — confirm the shape in your client when integrating.

POST /api/cashless/fan/wallets/:walletId/top-up/sessions

Create a resource or run this action.

Bearer token

Request

Parameter	In	Req.	Description
`walletId`	path	Y	Cashless wallet identifier for an event.

Example response

{
  "status": "success",
  "success": true,
  "statusCode": "00000",
  "message": "OK",
  "shortMessage": "SUCCESS",
  "timestamp": "2026-10-10T21:00:00.000Z",
  "requestId": "a1b2c3d4e5f6g7h8",
  "data": {
    "token": "chk_9a2f...",
    "amountMinor": 75000,
    "currency": "NAD",
    "paymentOptionSlug": "maris",
    "expiresAt": "2026-10-10T22:30:00.000Z",
    "lines": [
      {
        "name": "General \u00b7 Early bird",
        "qty": 2,
        "unitPriceMinor": 37500
      }
    ]
  }
}

Response data

Wrapped in the standard envelope (status, success, data, …). See the introduction for envelope fields.

Field	Description
`data.token`	Opaque session token for follow-up calls.
`data.amountMinor`	Money amount in minor units (cents).
`data.currency`	ISO currency code.
`data.paymentOptionSlug`	Selected payment rail.
`data.expiresAt`	When the session or token stops being valid (ISO 8601).
`data.lines`	Array. Element shape shown when sample includes objects.
`data.lines[].name`	Human-readable name.
`data.lines[].qty`	Quantity.
`data.lines[].unitPriceMinor`	Unit price in minor units.

PATCH /api/cashless/fan/wallets/:walletId/wearable-auth

Update selected fields on this resource.

Bearer token

Request

Parameter	In	Req.	Description
`walletId`	path	Y	Cashless wallet identifier for an event.

Example response

{
  "status": "success",
  "success": true,
  "statusCode": "00000",
  "message": "OK",
  "shortMessage": "SUCCESS",
  "timestamp": "2026-10-10T21:00:00.000Z",
  "requestId": "a1b2c3d4e5f6g7h8",
  "data": {}
}

Response data

Success returns the standard envelope. data holds the payload for this method — confirm the shape in your client when integrating.

GET /api/cashless/fan/wallets/:walletId/wearables

List or read resources for this path.

Bearer token

Request

Parameter	In	Req.	Description
`walletId`	path	Y	Cashless wallet identifier for an event.

Example response

{
  "status": "success",
  "success": true,
  "statusCode": "00000",
  "message": "OK",
  "shortMessage": "SUCCESS",
  "timestamp": "2026-10-10T21:00:00.000Z",
  "requestId": "a1b2c3d4e5f6g7h8",
  "data": {}
}

Response data

Success returns the standard envelope. data holds the payload for this method — confirm the shape in your client when integrating.

POST /api/cashless/fan/wallets/:walletId/wearables

Create a resource or run this action.

Bearer token

Request

Parameter	In	Req.	Description
`walletId`	path	Y	Cashless wallet identifier for an event.

Example response

{
  "status": "success",
  "success": true,
  "statusCode": "00000",
  "message": "OK",
  "shortMessage": "SUCCESS",
  "timestamp": "2026-10-10T21:00:00.000Z",
  "requestId": "a1b2c3d4e5f6g7h8",
  "data": {}
}

Response data

Success returns the standard envelope. data holds the payload for this method — confirm the shape in your client when integrating.

DELETE /api/cashless/fan/wallets/:walletId/wearables/:wearableId

Remove or deactivate this resource.

Bearer token

Request

Parameter	In	Req.	Description
`walletId`	path	Y	Cashless wallet identifier for an event.
`wearableId`	path	Y	NFC wearable / band identifier.

Example response

{
  "status": "success",
  "success": true,
  "statusCode": "00000",
  "message": "OK",
  "shortMessage": "SUCCESS",
  "timestamp": "2026-10-10T21:00:00.000Z",
  "requestId": "a1b2c3d4e5f6g7h8",
  "data": {}
}

Response data

Success returns the standard envelope. data holds the payload for this method — confirm the shape in your client when integrating.

POST /api/cashless/fan/wallets/:walletId/withdraw-maris

Create a resource or run this action.

Bearer token

Request

Parameter	In	Req.	Description
`walletId`	path	Y	Cashless wallet identifier for an event.

Example response

{
  "status": "success",
  "success": true,
  "statusCode": "00000",
  "message": "OK",
  "shortMessage": "SUCCESS",
  "timestamp": "2026-10-10T21:00:00.000Z",
  "requestId": "a1b2c3d4e5f6g7h8",
  "data": {}
}

Response data

Success returns the standard envelope. data holds the payload for this method — confirm the shape in your client when integrating.

POST /api/cashless/fan/wallets/ensure

Create a resource or run this action.

Bearer token

Request

Parameter	In	Req.	Description
`eventId`	body	Y	Mongo ObjectId of the event.

Example body

{
  "eventId": "{{eventId}}"
}

Example response

{
  "status": "success",
  "success": true,
  "statusCode": "00000",
  "message": "OK",
  "shortMessage": "SUCCESS",
  "timestamp": "2026-10-10T21:00:00.000Z",
  "requestId": "a1b2c3d4e5f6g7h8",
  "data": {}
}

Response data

Success returns the standard envelope. data holds the payload for this method — confirm the shape in your client when integrating.

POST /api/cashless/fan/wallets/ensure/:eventId

Create a resource or run this action.

Bearer token

Request

Parameter	In	Req.	Description
`eventId`	path	Y	Mongo ObjectId of the event.

Example response

{
  "status": "success",
  "success": true,
  "statusCode": "00000",
  "message": "OK",
  "shortMessage": "SUCCESS",
  "timestamp": "2026-10-10T21:00:00.000Z",
  "requestId": "a1b2c3d4e5f6g7h8",
  "data": {}
}

Response data

Success returns the standard envelope. data holds the payload for this method — confirm the shape in your client when integrating.

GET /api/cashless/fan/wallets/home-summary

List or read resources for this path.

Bearer token

Request

No body or query parameters. Path values above, if any, are enough.

Example response

{
  "status": "success",
  "success": true,
  "statusCode": "00000",
  "message": "OK",
  "shortMessage": "SUCCESS",
  "timestamp": "2026-10-10T21:00:00.000Z",
  "requestId": "a1b2c3d4e5f6g7h8",
  "data": {}
}

Response data

Success returns the standard envelope. data holds the payload for this method — confirm the shape in your client when integrating.

GET /api/cashless/fan/wallets/top-up/dpo/callback

List or read resources for this path.

Public

Request

No body or query parameters. Path values above, if any, are enough.

Example response

{
  "status": "success",
  "success": true,
  "statusCode": "00000",
  "message": "OK",
  "shortMessage": "SUCCESS",
  "timestamp": "2026-10-10T21:00:00.000Z",
  "requestId": "a1b2c3d4e5f6g7h8",
  "data": {}
}

Response data

Success returns the standard envelope. data holds the payload for this method — confirm the shape in your client when integrating.

POST /api/cashless/fan/wallets/top-up/sessions/:token/maris/verify-otp

Confirm a Maris one-time password.

Bearer token

Request

Parameter	In	Req.	Description
`token`	path	Y	Opaque session or activation token.

Example response

{
  "status": "success",
  "success": true,
  "statusCode": "00000",
  "message": "OK",
  "shortMessage": "SUCCESS",
  "timestamp": "2026-10-10T21:00:00.000Z",
  "requestId": "a1b2c3d4e5f6g7h8",
  "data": {}
}

Response data

Success returns the standard envelope. data holds the payload for this method — confirm the shape in your client when integrating.

POST /api/cashless/fan/wallets/top-up/sessions/:token/pay

Create a resource or run this action.

Bearer token

Request

Parameter	In	Req.	Description
`token`	path	Y	Opaque session or activation token.

Example response

{
  "status": "success",
  "success": true,
  "statusCode": "00000",
  "message": "OK",
  "shortMessage": "SUCCESS",
  "timestamp": "2026-10-10T21:00:00.000Z",
  "requestId": "a1b2c3d4e5f6g7h8",
  "data": {}
}

Response data

Success returns the standard envelope. data holds the payload for this method — confirm the shape in your client when integrating.

POST /api/cashless/fan/wearable-authorizations/:authorizationId/decision

Create a resource or run this action.

Bearer token

Request

Parameter	In	Req.	Description
`authorizationId`	path	Y	Path parameter identifying the resource.

Example response

{
  "status": "success",
  "success": true,
  "statusCode": "00000",
  "message": "OK",
  "shortMessage": "SUCCESS",
  "timestamp": "2026-10-10T21:00:00.000Z",
  "requestId": "a1b2c3d4e5f6g7h8",
  "data": {}
}

Response data

Success returns the standard envelope. data holds the payload for this method — confirm the shape in your client when integrating.

GET /api/cashless/fan/wearable-authorizations/pending

List or read resources for this path.

Bearer token

Request

No body or query parameters. Path values above, if any, are enough.

Example response

{
  "status": "success",
  "success": true,
  "statusCode": "00000",
  "message": "OK",
  "shortMessage": "SUCCESS",
  "timestamp": "2026-10-10T21:00:00.000Z",
  "requestId": "a1b2c3d4e5f6g7h8",
  "data": {}
}

Response data

Success returns the standard envelope. data holds the payload for this method — confirm the shape in your client when integrating.

POST /api/cashless/merchant/charge

Charge an event wallet or wearable at the stall.

Bearer token

Request

Parameter	In	Req.	Description
`walletCode`	body	Y	Request field. See Zod schema in the route module for constraints.
`amountMinor`	body	Y	Amount in the smallest currency unit (NAD cents).
`eventId`	body	Y	Mongo ObjectId of the event.

Example body

{
  "walletCode": "ABC123",
  "amountMinor": 2500,
  "eventId": "{{eventId}}"
}

Example response

{
  "status": "success",
  "success": true,
  "statusCode": "00000",
  "message": "OK",
  "shortMessage": "SUCCESS",
  "timestamp": "2026-10-10T21:00:00.000Z",
  "requestId": "a1b2c3d4e5f6g7h8",
  "data": {
    "entryId": "led_7c21",
    "amountMinor": 18500,
    "currency": "NAD",
    "walletId": "wlt_88aa",
    "displayCode": "SUN-4821",
    "balanceMinor": 431500
  }
}

Response data

Wrapped in the standard envelope (status, success, data, …). See the introduction for envelope fields.

Field	Description
`data.entryId`	Ledger entry id for this charge.
`data.amountMinor`	Money amount in minor units (cents).
`data.currency`	ISO currency code.
`data.walletId`	Returned str value.
`data.displayCode`	Guest-facing wallet / wrist display code.
`data.balanceMinor`	Wallet balance remaining after the operation, in minor units.

GET /api/cashless/merchant/ledger

List or read resources for this path.

Bearer token

Request

No body or query parameters. Path values above, if any, are enough.

Example response

{
  "status": "success",
  "success": true,
  "statusCode": "00000",
  "message": "OK",
  "shortMessage": "SUCCESS",
  "timestamp": "2026-10-10T21:00:00.000Z",
  "requestId": "a1b2c3d4e5f6g7h8",
  "data": {}
}

Response data

Success returns the standard envelope. data holds the payload for this method — confirm the shape in your client when integrating.

GET /api/cashless/merchant/ledger/:entryId

Fetch one resource by id or token.

Bearer token

Request

Parameter	In	Req.	Description
`entryId`	path	Y	Path parameter identifying the resource.

Example response

{
  "status": "success",
  "success": true,
  "statusCode": "00000",
  "message": "OK",
  "shortMessage": "SUCCESS",
  "timestamp": "2026-10-10T21:00:00.000Z",
  "requestId": "a1b2c3d4e5f6g7h8",
  "data": {}
}

Response data

Success returns the standard envelope. data holds the payload for this method — confirm the shape in your client when integrating.

GET /api/cashless/merchant/pos-sessions

Read or complete a POS checkout session.

Bearer token

Request

No body or query parameters. Path values above, if any, are enough.

Example response

{
  "status": "success",
  "success": true,
  "statusCode": "00000",
  "message": "OK",
  "shortMessage": "SUCCESS",
  "timestamp": "2026-10-10T21:00:00.000Z",
  "requestId": "a1b2c3d4e5f6g7h8",
  "data": {}
}

Response data

Success returns the standard envelope. data holds the payload for this method — confirm the shape in your client when integrating.

POST /api/cashless/merchant/pos-sessions

Open a POS checkout session for the guest to pay.

Bearer token

Request

Parameter	In	Req.	Description
`eventId`	body	Y	Mongo ObjectId of the event.
`amountMinor`	body	Y	Amount in the smallest currency unit (NAD cents).
`currency`	body	Y	ISO 4217 currency code. Groove uses NAD.

Example body

{
  "eventId": "{{eventId}}",
  "amountMinor": 5000,
  "currency": "NAD"
}

Example response

{
  "status": "success",
  "success": true,
  "statusCode": "00000",
  "message": "OK",
  "shortMessage": "SUCCESS",
  "timestamp": "2026-10-10T21:00:00.000Z",
  "requestId": "a1b2c3d4e5f6g7h8",
  "data": {
    "token": "POS-7K2M",
    "shortCode": "7K2M",
    "amountMinor": 18500,
    "currency": "NAD",
    "payUrl": "https://groove.com.na/pay/pos/POS-7K2M",
    "expiresAt": "2026-10-10T23:00:00.000Z"
  }
}

Response data

Wrapped in the standard envelope (status, success, data, …). See the introduction for envelope fields.

Field	Description
`data.token`	Opaque session token for follow-up calls.
`data.shortCode`	Short code a guest can type instead of the full token.
`data.amountMinor`	Money amount in minor units (cents).
`data.currency`	ISO currency code.
`data.payUrl`	HTTPS URL or deep link for the guest to complete payment.
`data.expiresAt`	When the session or token stops being valid (ISO 8601).

POST /api/cashless/merchant/pos-sessions/:token/cancel

Open a POS checkout session for the guest to pay.

Bearer token

Request

Parameter	In	Req.	Description
`token`	path	Y	Opaque session or activation token.

Example response

{
  "status": "success",
  "success": true,
  "statusCode": "00000",
  "message": "OK",
  "shortMessage": "SUCCESS",
  "timestamp": "2026-10-10T21:00:00.000Z",
  "requestId": "a1b2c3d4e5f6g7h8",
  "data": {
    "token": "POS-7K2M",
    "shortCode": "7K2M",
    "amountMinor": 18500,
    "currency": "NAD",
    "payUrl": "https://groove.com.na/pay/pos/POS-7K2M",
    "expiresAt": "2026-10-10T23:00:00.000Z"
  }
}

Response data

Wrapped in the standard envelope (status, success, data, …). See the introduction for envelope fields.

Field	Description
`data.token`	Opaque session token for follow-up calls.
`data.shortCode`	Short code a guest can type instead of the full token.
`data.amountMinor`	Money amount in minor units (cents).
`data.currency`	ISO currency code.
`data.payUrl`	HTTPS URL or deep link for the guest to complete payment.
`data.expiresAt`	When the session or token stops being valid (ISO 8601).

POST /api/cashless/merchant/pos-sessions/:token/confirm-external

Open a POS checkout session for the guest to pay.

Bearer token

Request

Parameter	In	Req.	Description
`token`	path	Y	Opaque session or activation token.

Example response

{
  "status": "success",
  "success": true,
  "statusCode": "00000",
  "message": "OK",
  "shortMessage": "SUCCESS",
  "timestamp": "2026-10-10T21:00:00.000Z",
  "requestId": "a1b2c3d4e5f6g7h8",
  "data": {
    "token": "POS-7K2M",
    "shortCode": "7K2M",
    "amountMinor": 18500,
    "currency": "NAD",
    "payUrl": "https://groove.com.na/pay/pos/POS-7K2M",
    "expiresAt": "2026-10-10T23:00:00.000Z"
  }
}

Response data

Wrapped in the standard envelope (status, success, data, …). See the introduction for envelope fields.

Field	Description
`data.token`	Opaque session token for follow-up calls.
`data.shortCode`	Short code a guest can type instead of the full token.
`data.amountMinor`	Money amount in minor units (cents).
`data.currency`	ISO currency code.
`data.payUrl`	HTTPS URL or deep link for the guest to complete payment.
`data.expiresAt`	When the session or token stops being valid (ISO 8601).

POST /api/cashless/merchant/pos-sessions/:token/maris/send-otp

Open a POS checkout session for the guest to pay.

Bearer token

Request

Parameter	In	Req.	Description
`token`	path	Y	Opaque session or activation token.

Example response

{
  "status": "success",
  "success": true,
  "statusCode": "00000",
  "message": "OK",
  "shortMessage": "SUCCESS",
  "timestamp": "2026-10-10T21:00:00.000Z",
  "requestId": "a1b2c3d4e5f6g7h8",
  "data": {
    "token": "POS-7K2M",
    "shortCode": "7K2M",
    "amountMinor": 18500,
    "currency": "NAD",
    "payUrl": "https://groove.com.na/pay/pos/POS-7K2M",
    "expiresAt": "2026-10-10T23:00:00.000Z"
  }
}

Response data

Wrapped in the standard envelope (status, success, data, …). See the introduction for envelope fields.

Field	Description
`data.token`	Opaque session token for follow-up calls.
`data.shortCode`	Short code a guest can type instead of the full token.
`data.amountMinor`	Money amount in minor units (cents).
`data.currency`	ISO currency code.
`data.payUrl`	HTTPS URL or deep link for the guest to complete payment.
`data.expiresAt`	When the session or token stops being valid (ISO 8601).

POST /api/cashless/merchant/pos-sessions/:token/maris/verify-otp

Open a POS checkout session for the guest to pay.

Bearer token

Request

Parameter	In	Req.	Description
`token`	path	Y	Opaque session or activation token.

Example response

{
  "status": "success",
  "success": true,
  "statusCode": "00000",
  "message": "OK",
  "shortMessage": "SUCCESS",
  "timestamp": "2026-10-10T21:00:00.000Z",
  "requestId": "a1b2c3d4e5f6g7h8",
  "data": {
    "token": "POS-7K2M",
    "shortCode": "7K2M",
    "amountMinor": 18500,
    "currency": "NAD",
    "payUrl": "https://groove.com.na/pay/pos/POS-7K2M",
    "expiresAt": "2026-10-10T23:00:00.000Z"
  }
}

Response data

Wrapped in the standard envelope (status, success, data, …). See the introduction for envelope fields.

Field	Description
`data.token`	Opaque session token for follow-up calls.
`data.shortCode`	Short code a guest can type instead of the full token.
`data.amountMinor`	Money amount in minor units (cents).
`data.currency`	ISO currency code.
`data.payUrl`	HTTPS URL or deep link for the guest to complete payment.
`data.expiresAt`	When the session or token stops being valid (ISO 8601).

GET /api/cashless/merchant/pos-sessions/:token/sale-detail

Read or complete a POS checkout session.

Bearer token

Request

Parameter	In	Req.	Description
`token`	path	Y	Opaque session or activation token.

Example response

{
  "status": "success",
  "success": true,
  "statusCode": "00000",
  "message": "OK",
  "shortMessage": "SUCCESS",
  "timestamp": "2026-10-10T21:00:00.000Z",
  "requestId": "a1b2c3d4e5f6g7h8",
  "data": {}
}

Response data

Success returns the standard envelope. data holds the payload for this method — confirm the shape in your client when integrating.

GET /api/cashless/merchant/pos-sessions/:token/status

Read or complete a POS checkout session.

Bearer token

Request

Parameter	In	Req.	Description
`token`	path	Y	Opaque session or activation token.

Example response

{
  "status": "success",
  "success": true,
  "statusCode": "00000",
  "message": "OK",
  "shortMessage": "SUCCESS",
  "timestamp": "2026-10-10T21:00:00.000Z",
  "requestId": "a1b2c3d4e5f6g7h8",
  "data": {}
}

Response data

Success returns the standard envelope. data holds the payload for this method — confirm the shape in your client when integrating.

GET /api/cashless/merchant/tabs

List or read resources for this path.

Bearer token

Request

No body or query parameters. Path values above, if any, are enough.

Example response

{
  "status": "success",
  "success": true,
  "statusCode": "00000",
  "message": "OK",
  "shortMessage": "SUCCESS",
  "timestamp": "2026-10-10T21:00:00.000Z",
  "requestId": "a1b2c3d4e5f6g7h8",
  "data": {}
}

Response data

Success returns the standard envelope. data holds the payload for this method — confirm the shape in your client when integrating.

POST /api/cashless/merchant/tabs

Create a resource or run this action.

Bearer token

Request

No body or query parameters. Path values above, if any, are enough.

Example response

{
  "status": "success",
  "success": true,
  "statusCode": "00000",
  "message": "OK",
  "shortMessage": "SUCCESS",
  "timestamp": "2026-10-10T21:00:00.000Z",
  "requestId": "a1b2c3d4e5f6g7h8",
  "data": {}
}

Response data

Success returns the standard envelope. data holds the payload for this method — confirm the shape in your client when integrating.

GET /api/cashless/merchant/tabs/:tabId

Fetch one resource by id or token.

Bearer token

Request

Parameter	In	Req.	Description
`tabId`	path	Y	Path parameter identifying the resource.

Example response

{
  "status": "success",
  "success": true,
  "statusCode": "00000",
  "message": "OK",
  "shortMessage": "SUCCESS",
  "timestamp": "2026-10-10T21:00:00.000Z",
  "requestId": "a1b2c3d4e5f6g7h8",
  "data": {}
}

Response data

Success returns the standard envelope. data holds the payload for this method — confirm the shape in your client when integrating.

POST /api/cashless/merchant/tabs/:tabId/orders

Create a resource or run this action.

Bearer token

Request

Parameter	In	Req.	Description
`tabId`	path	Y	Path parameter identifying the resource.

Example response

{
  "status": "success",
  "success": true,
  "statusCode": "00000",
  "message": "OK",
  "shortMessage": "SUCCESS",
  "timestamp": "2026-10-10T21:00:00.000Z",
  "requestId": "a1b2c3d4e5f6g7h8",
  "data": {}
}

Response data

Success returns the standard envelope. data holds the payload for this method — confirm the shape in your client when integrating.

POST /api/cashless/merchant/tabs/:tabId/settle

Create a resource or run this action.

Bearer token

Request

Parameter	In	Req.	Description
`tabId`	path	Y	Path parameter identifying the resource.

Example response

{
  "status": "success",
  "success": true,
  "statusCode": "00000",
  "message": "OK",
  "shortMessage": "SUCCESS",
  "timestamp": "2026-10-10T21:00:00.000Z",
  "requestId": "a1b2c3d4e5f6g7h8",
  "data": {}
}

Response data

Success returns the standard envelope. data holds the payload for this method — confirm the shape in your client when integrating.

POST /api/cashless/merchant/tabs/:tabId/void

Create a resource or run this action.

Bearer token

Request

Parameter	In	Req.	Description
`tabId`	path	Y	Path parameter identifying the resource.

Example response

{
  "status": "success",
  "success": true,
  "statusCode": "00000",
  "message": "OK",
  "shortMessage": "SUCCESS",
  "timestamp": "2026-10-10T21:00:00.000Z",
  "requestId": "a1b2c3d4e5f6g7h8",
  "data": {}
}

Response data

Success returns the standard envelope. data holds the payload for this method — confirm the shape in your client when integrating.

POST /api/cashless/merchant/tabs/ticket-lookup

Create a resource or run this action.

Bearer token

Request

No body or query parameters. Path values above, if any, are enough.

Example response

{
  "status": "success",
  "success": true,
  "statusCode": "00000",
  "message": "OK",
  "shortMessage": "SUCCESS",
  "timestamp": "2026-10-10T21:00:00.000Z",
  "requestId": "a1b2c3d4e5f6g7h8",
  "data": {}
}

Response data

Success returns the standard envelope. data holds the payload for this method — confirm the shape in your client when integrating.

GET /api/cashless/merchant/wearable-authorizations/:authorizationId

Fetch one resource by id or token.

Bearer token

Request

Parameter	In	Req.	Description
`authorizationId`	path	Y	Path parameter identifying the resource.

Example response

{
  "status": "success",
  "success": true,
  "statusCode": "00000",
  "message": "OK",
  "shortMessage": "SUCCESS",
  "timestamp": "2026-10-10T21:00:00.000Z",
  "requestId": "a1b2c3d4e5f6g7h8",
  "data": {}
}

Response data

Success returns the standard envelope. data holds the payload for this method — confirm the shape in your client when integrating.

POST /api/cashless/merchant/wearables/check-balance

Create a resource or run this action.

Bearer token

Request

No body or query parameters. Path values above, if any, are enough.

Example response

{
  "status": "success",
  "success": true,
  "statusCode": "00000",
  "message": "OK",
  "shortMessage": "SUCCESS",
  "timestamp": "2026-10-10T21:00:00.000Z",
  "requestId": "a1b2c3d4e5f6g7h8",
  "data": {}
}

Response data

Success returns the standard envelope. data holds the payload for this method — confirm the shape in your client when integrating.

GET /api/cashless/organiser/events/:eventId/analytics

List or read resources for this path.

Bearer token

Request

Parameter	In	Req.	Description
`eventId`	path	Y	Mongo ObjectId of the event.

Example response

{
  "status": "success",
  "success": true,
  "statusCode": "00000",
  "message": "OK",
  "shortMessage": "SUCCESS",
  "timestamp": "2026-10-10T21:00:00.000Z",
  "requestId": "a1b2c3d4e5f6g7h8",
  "data": {}
}

Response data

Success returns the standard envelope. data holds the payload for this method — confirm the shape in your client when integrating.

GET /api/cashless/organiser/events/:eventId/settings

List or read resources for this path.

Bearer token

Request

Parameter	In	Req.	Description
`eventId`	path	Y	Mongo ObjectId of the event.

Example response

{
  "status": "success",
  "success": true,
  "statusCode": "00000",
  "message": "OK",
  "shortMessage": "SUCCESS",
  "timestamp": "2026-10-10T21:00:00.000Z",
  "requestId": "a1b2c3d4e5f6g7h8",
  "data": {}
}

Response data

Success returns the standard envelope. data holds the payload for this method — confirm the shape in your client when integrating.

PUT /api/cashless/organiser/events/:eventId/settings

Replace or upsert this resource.

Bearer token

Request

Parameter	In	Req.	Description
`eventId`	path	Y	Mongo ObjectId of the event.

Example response

{
  "status": "success",
  "success": true,
  "statusCode": "00000",
  "message": "OK",
  "shortMessage": "SUCCESS",
  "timestamp": "2026-10-10T21:00:00.000Z",
  "requestId": "a1b2c3d4e5f6g7h8",
  "data": {}
}

Response data

Success returns the standard envelope. data holds the payload for this method — confirm the shape in your client when integrating.

GET /api/cashless/organiser/events/:eventId/wallets

List or read resources for this path.

Bearer token

Request

Parameter	In	Req.	Description
`eventId`	path	Y	Mongo ObjectId of the event.

Example response

{
  "status": "success",
  "success": true,
  "statusCode": "00000",
  "message": "OK",
  "shortMessage": "SUCCESS",
  "timestamp": "2026-10-10T21:00:00.000Z",
  "requestId": "a1b2c3d4e5f6g7h8",
  "data": {}
}

Response data

Success returns the standard envelope. data holds the payload for this method — confirm the shape in your client when integrating.

POST /api/cashless/organiser/events/:eventId/wallets/:walletId/credit

Create a resource or run this action.

Bearer token

Request

Parameter	In	Req.	Description
`eventId`	path	Y	Mongo ObjectId of the event.
`walletId`	path	Y	Cashless wallet identifier for an event.

Example response

{
  "status": "success",
  "success": true,
  "statusCode": "00000",
  "message": "OK",
  "shortMessage": "SUCCESS",
  "timestamp": "2026-10-10T21:00:00.000Z",
  "requestId": "a1b2c3d4e5f6g7h8",
  "data": {}
}

Response data

Success returns the standard envelope. data holds the payload for this method — confirm the shape in your client when integrating.

POST /api/cashless/organiser/events/:eventId/wallets/:walletId/freeze

Create a resource or run this action.

Bearer token

Request

Parameter	In	Req.	Description
`eventId`	path	Y	Mongo ObjectId of the event.
`walletId`	path	Y	Cashless wallet identifier for an event.

Example response

{
  "status": "success",
  "success": true,
  "statusCode": "00000",
  "message": "OK",
  "shortMessage": "SUCCESS",
  "timestamp": "2026-10-10T21:00:00.000Z",
  "requestId": "a1b2c3d4e5f6g7h8",
  "data": {}
}

Response data

Success returns the standard envelope. data holds the payload for this method — confirm the shape in your client when integrating.

POST /api/cashless/organiser/events/:eventId/wallets/:walletId/unfreeze

Create a resource or run this action.

Bearer token

Request

Parameter	In	Req.	Description
`eventId`	path	Y	Mongo ObjectId of the event.
`walletId`	path	Y	Cashless wallet identifier for an event.

Example response

{
  "status": "success",
  "success": true,
  "statusCode": "00000",
  "message": "OK",
  "shortMessage": "SUCCESS",
  "timestamp": "2026-10-10T21:00:00.000Z",
  "requestId": "a1b2c3d4e5f6g7h8",
  "data": {}
}

Response data

Success returns the standard envelope. data holds the payload for this method — confirm the shape in your client when integrating.

POST /api/cashless/organiser/events/:eventId/wearables/check-balance

Create a resource or run this action.

Bearer token

Request

Parameter	In	Req.	Description
`eventId`	path	Y	Mongo ObjectId of the event.

Example response

{
  "status": "success",
  "success": true,
  "statusCode": "00000",
  "message": "OK",
  "shortMessage": "SUCCESS",
  "timestamp": "2026-10-10T21:00:00.000Z",
  "requestId": "a1b2c3d4e5f6g7h8",
  "data": {}
}

Response data

Success returns the standard envelope. data holds the payload for this method — confirm the shape in your client when integrating.

POST /api/cashless/organiser/events/:eventId/wearables/guest-wallet

Create a resource or run this action.

Bearer token

Request

Parameter	In	Req.	Description
`eventId`	path	Y	Mongo ObjectId of the event.

Example response

{
  "status": "success",
  "success": true,
  "statusCode": "00000",
  "message": "OK",
  "shortMessage": "SUCCESS",
  "timestamp": "2026-10-10T21:00:00.000Z",
  "requestId": "a1b2c3d4e5f6g7h8",
  "data": {}
}

Response data

Success returns the standard envelope. data holds the payload for this method — confirm the shape in your client when integrating.

POST /api/cashless/organiser/events/:eventId/wearables/link-wallet

Create a resource or run this action.

Bearer token

Request

Parameter	In	Req.	Description
`eventId`	path	Y	Mongo ObjectId of the event.

Example response

{
  "status": "success",
  "success": true,
  "statusCode": "00000",
  "message": "OK",
  "shortMessage": "SUCCESS",
  "timestamp": "2026-10-10T21:00:00.000Z",
  "requestId": "a1b2c3d4e5f6g7h8",
  "data": {}
}

Response data

Success returns the standard envelope. data holds the payload for this method — confirm the shape in your client when integrating.

POST /api/cashless/organiser/events/:eventId/wearables/top-up

Create a resource or run this action.

Bearer token

Request

Parameter	In	Req.	Description
`eventId`	path	Y	Mongo ObjectId of the event.

Example response

{
  "status": "success",
  "success": true,
  "statusCode": "00000",
  "message": "OK",
  "shortMessage": "SUCCESS",
  "timestamp": "2026-10-10T21:00:00.000Z",
  "requestId": "a1b2c3d4e5f6g7h8",
  "data": {}
}

Response data

Success returns the standard envelope. data holds the payload for this method — confirm the shape in your client when integrating.

GET /api/cashless/pos-sessions/public/:token

Read or complete a POS checkout session.

Public

Request

Parameter	In	Req.	Description
`token`	path	Y	Opaque session or activation token.

Example response

{
  "status": "success",
  "success": true,
  "statusCode": "00000",
  "message": "OK",
  "shortMessage": "SUCCESS",
  "timestamp": "2026-10-10T21:00:00.000Z",
  "requestId": "a1b2c3d4e5f6g7h8",
  "data": {}
}

Response data

Success returns the standard envelope. data holds the payload for this method — confirm the shape in your client when integrating.

GET /api/cashless/pos-sessions/public/by-code/:code

Read or complete a POS checkout session.

Public

Request

Parameter	In	Req.	Description
`code`	path	Y	One-time verification or OTP code.

Example response

{
  "status": "success",
  "success": true,
  "statusCode": "00000",
  "message": "OK",
  "shortMessage": "SUCCESS",
  "timestamp": "2026-10-10T21:00:00.000Z",
  "requestId": "a1b2c3d4e5f6g7h8",
  "data": {}
}

Response data

Success returns the standard envelope. data holds the payload for this method — confirm the shape in your client when integrating.

Lock this page again

Cashless, POS & wallets · 85 methods · October 2026

Resolve this before you come in.

Request

Example response

Response data

Request

Example response

Response data

Request

Example response

Response data

Request

Example response

Response data

Request

Example response

Response data

Request

Example response

Response data

Request

Example response

Response data

Request

Example response

Response data

Request

Example response

Response data

Request

Example response

Response data

Request

Example response

Response data

Request

Example response

Response data

Request

Example body

Example response

Response data

Request

Example response

Response data

Request

Example response

Response data

Request

Example response

Response data

Request

Example response

Response data

Request

Example response

Response data

Request

Example response

Response data

Request

Example body

Example response

Response data

Request

Example body

Example response

Response data

Request

Example response

Response data

Request

Example response

Response data

Request

Example response

Response data

Request

Example response

Response data

Request