Skip to main content
POST
/
v1
/
terminals
/
payment-request
/
{terminalId}
Send payment request to terminal
curl --request POST \
  --url https://api.nomba.com/v1/terminals/payment-request/{terminalId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "merchantTxRef": "55555555",
  "amount": "1000",
  "currency": "NGN"
}
'
import requests

url = "https://api.nomba.com/v1/terminals/payment-request/{terminalId}"

payload = {
"merchantTxRef": "55555555",
"amount": "1000",
"currency": "NGN"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}

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

print(response.text)
const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({merchantTxRef: '55555555', amount: '1000', currency: 'NGN'})
};

fetch('https://api.nomba.com/v1/terminals/payment-request/{terminalId}', 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/payment-request/{terminalId}",
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([
'merchantTxRef' => '55555555',
'amount' => '1000',
'currency' => 'NGN'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);

$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/payment-request/{terminalId}"

payload := strings.NewReader("{\n \"merchantTxRef\": \"55555555\",\n \"amount\": \"1000\",\n \"currency\": \"NGN\"\n}")

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

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/payment-request/{terminalId}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"merchantTxRef\": \"55555555\",\n \"amount\": \"1000\",\n \"currency\": \"NGN\"\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.nomba.com/v1/terminals/payment-request/{terminalId}")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"merchantTxRef\": \"55555555\",\n \"amount\": \"1000\",\n \"currency\": \"NGN\"\n}"

response = http.request(request)
puts response.read_body
{
  "code": "00",
  "description": "Success",
  "data": {
    "paymentId": "890022ce-bae0-45c1-9b9d-ee7872e6ca27",
    "status": "pending",
    "amount": 1000,
    "currency": "NGN",
    "createdAt": "2023-08-30T14:56:59.000Z"
  }
}
{
"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"
}

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}.

Body

application/json

The request payload required to send payment request to a nomba terminal

Represents a request to initiate a payment on a physical payment terminal.

merchantTxRef
string
required

The unique identifier for the order associated with the payment.

Example:

"55555555"

amount
number
required

The total amount to be charged on the terminal, in the smallest currency unit (e.g., cents, kobo).

Example:

"1000"

currency
enum<string>
required

Currency code based on the ISO4217 standard

Available options:
NGN,
USD,
CDF
Required string length: 3
Example:

"NGN"

Response

OK - your request was successful.

code
string
required

Response Code

Example:

"00"

description
string
required

Response description

Example:

"Success"

data
object
required

Represents a response to payment initialization request