Sign in

v1

latestOpenAPI 3.0.12026-07-2679100267.2 KB
Terminals

Send payment request to terminal

You can use this endpoint to trigger a payment request on a nomba terminal

post/v1/terminals/payment-request/{terminalId}

Request body

merchantTxRefstring required

The unique identifier for the order associated with the payment.

amountnumber required

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

currency'NGN' | 'USD' | 'CDF' required

Currency code based on the ISO4217 standard

Example request

{
  "merchantTxRef": "55555555",
  "currency": "NGN"
}

Response

OK - your request was successful.

codestring required

Response Code

descriptionstring required

Response description

Example response

{
  "code": "00",
  "description": "Success",
  "data": {
    "paymentId": "890022ce-bae0-45c1-9b9d-ee7872e6ca27",
    "status": "pending",
    "amount": 1000,
    "currency": "NGN",
    "createdAt": "2023-08-30T14:56:59.000Z"
  }
}