Update Settlement Account

The "Update Settlement Account" endpoint allows customers to link a new settlement account to a terminal, or delink its existing one, controlling where funds collected on that terminal settle to.

PUT /api/terminal/v1/update-settlement-account

To update a terminal's settlement account, provide the id of the terminal, the action to perform (1 to link, 2 to delink), and the accountNumber to link, accountNumber is ignored when delinking.

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.
action	Enum (Link = 1, DeLink = 2)		The action to perform on the settlement account.
accountNumber	string		The account number to link. Will be ignored if action = 2 (DeLink).

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-settlement-account' \
--header 'Authorization: bearer {token}' \
--header 'request-reference: {unique_reference}' \
--header 'Content-Type: application/json' \
--data '{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "action": 2, //Link = 1, DeLink = 2
  "accountNumber": "string" //Will be ignored if Action = 2
}'

Response: 200

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