POST
/
v1
/
transactions
/
accounts
curl --request POST \
  --url https://api.nomba.com/v1/transactions/accounts \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'accountId: <accountid>' \
  --data '{
  "merchantTxRef": "c90d-4b25-ad0f",
  "orderId": "285e4ad2-665f-453b-8795-e854cab5757b",
  "orderReference": "693cd007-cd1e-4ea6-8b79-5f5c4d7a83ea",
  "rrn": "230908202632",
  "source": "pos",
  "status": "SUCCESS",
  "terminalId": "2KUD4AKB",
  "transactionRef": "POS-WITHDRAW-DFC05-693cd007-cd1e-4ea6-8b79-5f5c4d7a83ea",
  "type": "withdrawal"
}'
{
  "code": "00",
  "data": {
    "cursor": "xchbaVFsjdsbaADddd",
    "results": [
      {
        "amount": 4000,
        "customerBillerId": "539983 **** **** 5118",
        "fixedCharge": 123,
        "gatewayMessage": "Insufficient funds",
        "id": "POS-WITHDRAW-DFC05-693cd007-cd1e-4ea6-8b79-5f5c4d7a83ea",
        "merchantTxRef": "c90d-4b25-ad0f",
        "paymentVendorReference": "2KUD4AKB230908202632",
        "posRrn": "230908202632",
        "posSerialNumber": "91230309116826",
        "posTerminalLabel": "KEB MUSA ABUBAKAR",
        "posTid": "2KUD4AKB",
        "providerTerminalId": "2KUD4AKB",
        "rrn": "230908202632",
        "source": "pos",
        "stan": "556734",
        "status": "PAYMENT_FAILED",
        "terminalId": "2KUD4AKB",
        "timeCreated": "2023-09-08T19:26:34.657000Z",
        "type": "withdrawal",
        "userId": "dfc05ca1-4e75-41dd-8e41-2d362d565893"
      }
    ]
  },
  "description": "Success"
}

Authorizations

Authorization
string
headerrequired

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
required

The parent accountId of the business.

Query Parameters

limit
integer

This endpoint is paginated. limit describes the size of the page you are querying

cursor
string

The cursor is used to scroll to the next page. When making the first call to list all accounts, there is no need to pass in any cursor since the API has not returned any cursor back to you. Only use cursor when the API provides it

dateFrom
string

This starting date (UTC)

dateTo
string

This ending date

Body

application/json
merchantTxRef
string

Merchant transaction reference

orderId
string

Online checkout order id

orderReference
string

Online checkout order reference

rrn
string

RRN (Retrieval Reference Number)

source
enum<string>

Transaction source

Available options:
api,
pos,
web,
android_app,
ios_app
status
enum<string>

Transaction status

Available options:
NEW,
PENDING_PAYMENT,
PAYMENT_SUCCESSFUL,
PAYMENT_FAILED,
PENDING_BILLING,
SUCCESS,
REFUND
terminalId
string

Terminal ID

transactionRef
string

Transaction ID/Reference

type
enum<string>

Transaction type

Available options:
withdrawal,
purchase,
transfer,
p2p,
online_checkout,
qrt_credit,
qrt_debit

Response

200 - application/json
code
string
required

Response Code

data
object
required
description
string
required

Response description