Create Terminal

The "Create Terminal" endpoint allows customers to register a new payment terminal, configuring its settlement account and fee structure.

POST /api/terminal/v1/Create

To create a terminal, provide the terminalID, the settlementAccountNumber and settlementAccountName funds should settle to, and the terminal's fee configuration (useFlatFee, flatFee, percFee, percFeeCap), along with any override flags (overrideParentAccount, overrideParentFee).

Headers

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

Params

Required/Optional

Name	Data Type	Required/Optional	Description
terminalID	string		The ID of the terminal being created.
serialNumber	string		The terminal's serial number, where available.
settlementAccountNumber	string		The account number funds should settle to.
settlementAccountName	string		The name on the settlement account.
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 '{{baseurl}}/api/terminal/v1/Create' \
--header 'Authorization: bearer {token}' \
--header 'request-reference: {unique_reference}' \
--header 'Content-Type: application/json' \
--data '{
  "terminalID": "TIDSXCWY",
  "serialNumber": null,
  "settlementAccountNumber": "123456781",
  "settlementAccountName": "Test Name",
  "overrideParentAccount": false,
  "overrideParentFee": false,
  "useFlatFee": true,
  "flatFee": 20,
  "percFee": 10,
  "percFeeCap": 200
}'

Response: 200

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