Assign a terminal to a sub account

curl --request POST \
  --url https://api.nomba.com/v1/terminals/assign/{subAccountId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'accountId: <accountid>' \
  --data '
{
  "serialNumber": "55555555",
  "terminalLabel": "Testing"
}
'

import requests

url = "https://api.nomba.com/v1/terminals/assign/{subAccountId}"

payload = {
    "serialNumber": "55555555",
    "terminalLabel": "Testing"
}
headers = {
    "accountId": "<accountid>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    accountId: '<accountid>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({serialNumber: '55555555', terminalLabel: 'Testing'})
};

fetch('https://api.nomba.com/v1/terminals/assign/{subAccountId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.nomba.com/v1/terminals/assign/{subAccountId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'serialNumber' => '55555555',
    'terminalLabel' => 'Testing'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json",
    "accountId: <accountid>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.nomba.com/v1/terminals/assign/{subAccountId}"

	payload := strings.NewReader("{\n  \"serialNumber\": \"55555555\",\n  \"terminalLabel\": \"Testing\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("accountId", "<accountid>")
	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.nomba.com/v1/terminals/assign/{subAccountId}")
  .header("accountId", "<accountid>")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"serialNumber\": \"55555555\",\n  \"terminalLabel\": \"Testing\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.nomba.com/v1/terminals/assign/{subAccountId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["accountId"] = '<accountid>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"serialNumber\": \"55555555\",\n  \"terminalLabel\": \"Testing\"\n}"

response = http.request(request)
puts response.read_body

{
  "code": "00",
  "description": "Success",
  "data": {
    "terminalId": "201124LM",
    "serialNumber": "55555555",
    "accountId": "01a10aeb-d989-460a-bbde-9842f2b4320f",
    "parentAccountId": "",
    "merchantName": "trident and rees",
    "terminalLabel": "Testing",
    "createdAt": "2020-09-23T10:21:48.789Z",
    "updatedAt": "2023-09-04T15:23:55.173Z"
  }
}

{
  "code": "400",
  "description": "Request failed."
}

{
  "code": "401",
  "description": "Unauthorized"
}

{
  "code": "403",
  "description": "Forbidden"
}

{
  "code": "404",
  "description": "Record not found"
}

{
  "code": "429",
  "description": "Too many requests"
}

{
  "code": "500",
  "description": "Server error"
}

POST

terminals

assign

{subAccountId}

Assign a terminal to a sub account

curl --request POST \
  --url https://api.nomba.com/v1/terminals/assign/{subAccountId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'accountId: <accountid>' \
  --data '
{
  "serialNumber": "55555555",
  "terminalLabel": "Testing"
}
'

import requests

url = "https://api.nomba.com/v1/terminals/assign/{subAccountId}"

payload = {
    "serialNumber": "55555555",
    "terminalLabel": "Testing"
}
headers = {
    "accountId": "<accountid>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    accountId: '<accountid>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({serialNumber: '55555555', terminalLabel: 'Testing'})
};

fetch('https://api.nomba.com/v1/terminals/assign/{subAccountId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.nomba.com/v1/terminals/assign/{subAccountId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'serialNumber' => '55555555',
    'terminalLabel' => 'Testing'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json",
    "accountId: <accountid>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.nomba.com/v1/terminals/assign/{subAccountId}"

	payload := strings.NewReader("{\n  \"serialNumber\": \"55555555\",\n  \"terminalLabel\": \"Testing\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("accountId", "<accountid>")
	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.nomba.com/v1/terminals/assign/{subAccountId}")
  .header("accountId", "<accountid>")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"serialNumber\": \"55555555\",\n  \"terminalLabel\": \"Testing\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.nomba.com/v1/terminals/assign/{subAccountId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["accountId"] = '<accountid>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"serialNumber\": \"55555555\",\n  \"terminalLabel\": \"Testing\"\n}"

response = http.request(request)
puts response.read_body

{
  "code": "00",
  "description": "Success",
  "data": {
    "terminalId": "201124LM",
    "serialNumber": "55555555",
    "accountId": "01a10aeb-d989-460a-bbde-9842f2b4320f",
    "parentAccountId": "",
    "merchantName": "trident and rees",
    "terminalLabel": "Testing",
    "createdAt": "2020-09-23T10:21:48.789Z",
    "updatedAt": "2023-09-04T15:23:55.173Z"
  }
}

{
  "code": "400",
  "description": "Request failed."
}

{
  "code": "401",
  "description": "Unauthorized"
}

{
  "code": "403",
  "description": "Forbidden"
}

{
  "code": "404",
  "description": "Record not found"
}

{
  "code": "429",
  "description": "Too many requests"
}

{
  "code": "500",
  "description": "Server error"
}

For a complete guide on response codes and transaction statuses, see Response Codes.

Authorizations

Authorization

string

header

required

Nomba authenticates API calls with OAuth2 HTTP bearer tokens. There are two methods of authentication; Client-Credentials method and PKCE (Proof Key for Code Exchange) method. In each of the methods, You will get an ACCESS_TOKEN. You need to use an "Authorization" HTTP header to provide your ACCESS_TOKEN. For example: Authorization: {ACCESS_TOKEN}.

Headers

accountId

string<uuid>

required

The parent accountId of the business.

Example:

"890022ce-bae0-45c1-9b9d-ee7872e6ca27"

Path Parameters

subAccountId

string

required

The sub accountId whose terminals are to be fetched.

Body

application/json

The request payload required to assign a terminal to an account.

serialNumber

string

required

Serial number

Example:

"55555555"

terminalLabel

string

Terminal label

Example:

"Testing"

Response

OK - your request was successful.

code

string

required

Response Code

Example:

"00"

description

string

required

Response description

Example:

"Success"

data

object

required

Show child attributes

API Documentation

Authenticate

Accounts

Virtual Accounts

Online Checkout

Charge

Direct Debits

Transfers

Terminals

Transactions

Requery

Global Payout

DRC Collection

Airtime & Data Vending

Cable & Bill Payments

Betting

Assign a terminal to a sub account

Authorizations

Headers

Path Parameters

Body

Response