Create Bulk Terminal

The "Create Bulk Terminal" endpoint allows customers to register multiple payment terminals in a single call.

POST /api/terminal/v1/create-bulk

Pass a terminals array, where each item includes the terminal's ID, settlement account details, and fee configuration.

Headers

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

Params

Required/Optional

Name	Data Type	Required/Optional	Description
terminals	array		A list of terminal objects to create, see fields below for each item's shape
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-bulk' \
--header 'Authorization: bearer {token}' \
--header 'request-reference: {unique_reference}' \
--header 'Content-Type: application/json' \
--data '{
  "terminals": [
    {
        "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"
}