Update Terminal

The "Update Terminal" endpoint allows customers to update an existing terminal's settings.

PUT /api/terminal/v1/Update

Provide the id of the terminal, its serialNumber, override flags (overrideParentAccount, overrideParentFee), and the fee configuration to update (useFlatFee, flatFee, percFee, percFeeCap).

Headers

Name	Value
Content-Type*	application/json
Authorization*	bearer {token}
Request-Reference	{unique_reference}

Params

Required

Name	Data Type	Required	Description
id	string		The ID of the terminal record to update.
serialNumber	string		The terminal's serial number.
overrideParentAccount	boolean		Whether to override the terminal's parent account.
overrideParentFee	boolean		Whether to override the terminal's parent fee configuration.
useFlatFee	boolean		Whether to charge a flat fee instead of a percentage fee.
flatFee	number		The flat fee amount, used when useFlatFee is true.
percFee	number		The percentage fee, used when useFlatFee is false.
percFeeCap	number		The maximum fee amount a percentage-based fee can reach.

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' \
--header 'Authorization: bearer {token}' \
--header 'request-reference: {unique_reference}' \
--header 'Content-Type: application/json' \
--data '{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "serialNumber": "string",
  "overrideParentAccount": true,
  "overrideParentFee": true,
  "useFlatFee": true,
  "flatFee": 20000,
  "percFee": 100,
  "percFeeCap": 10000
}'

Response: 200

{
  "status": true,
  "message": "string"
}