For the complete documentation index, see llms.txt. This page is also available as Markdown.

Update Status

The "Update Status" endpoint allows customers to activate or deactivate a terminal, controlling whether it can currently be used to process transactions.

PUT /api/terminal/v1/update-status

To update a terminal's status, provide the id of the terminal along with isActive , set to true to activate the terminal, or false to deactivate it.

Headers

Name
Value

Content-Type*

application/json

Authorization*

bearer {token}

Request-Reference

{unique_reference}

Params

Name
Data Type
Required
Description

id

string

The ID of the terminal record to update.

isActive

boolean

Whether the terminal should be active.

Here is an example request and response with a sample payload sent to the endpoint in Curl format.

Sample Request
curl --location -g --request PUT '{{baseurl}}/api/terminal/v1/update-status' \
--header 'Authorization: bearer {token}' \
--header 'request-reference: {unique_reference}' \
--header 'Content-Type: application/json' \
--data '{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "isActive": true
}'
Response: 200
{
  "status": true,
  "message": "string"
}

Last updated