Skip to main content
POST
Send payment request to terminal
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}.

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