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

You can easily filter transctions using the merchantTxRef which is the reference you pass in upon creating transactions via the Nomba API. This is a quick way to reconcile on your end.

POST /v1/transactions/accounts

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. For more information, please see Pagination

dateFrom
string

This starting date. (in UTC)

dateTo
string

This ending date. (in UTC)

Request body

transactionRef
string

The transaction ID/Reference.

status
string

The transaction status.

source
string

The transaction source.

type
string

The transaction type.

terminalId
string

The terminal ID that carried out the transaction.

rrn
string

The RRN (Retrieval Reference Number) of the transaction.

merchantTxRef
string

The merchant transaction reference of the transaction.

Response body

code
string
required

Response code

description
string
required

Response description

data
object
required
cursor
string

Cursor for pagination. It will be empty if there is no more page to scroll to.

results
object[]
id
string
required

The transaction ID.

status
string
required

The transaction status.

amount
number
required

The transaction amount.

fixedCharge
number

The transaction fixed charge.

source
string
required

The transaction source.

type
string
required

The transaction type.

gatewayMessage
string
required

The gateway message.

customerBillerId
string

The customer biller ID.

timeCreated
string
required

The creation timestamp.

posTid
string

The POS terminal ID.

terminalId
string

The terminal ID.

providerTerminalId
string

The provider terminal ID.

rrn
string

The RRN (Retrieval Reference Number).

posSerialNumber
string

The POS serial number.

posTerminalLabel
string

The POS terminal label.

stan
string

The STAN (System Trace Audit Number).

paymentVendorReference
string

The Payment vendor reference.

userId
string

The User ID.

posRrn
string

The POS RRN (Retrieval Reference Number).

merchantTxRef
string

The merchant transaction reference.