Sign in

v1

latestOpenAPI 3.0.12026-07-2679100267.2 KB
Transactions

Filter parent account transactions

You can use this endpoint to filter transactions on the parent account.

post/v1/transactions/accounts

Query parameters

limitinteger

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

cursorstring

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

dateFromstring

This starting date (UTC). Sample date: 2023-01-01T00:00:00

dateTostring

This ending date (UTC). Sample date: 2024-09-30T23:59:59

Headers

accountIdstring uuid required
Example:890022ce-bae0-45c1-9b9d-ee7872e6ca27

The parent accountId of the business.

Request body

transactionRefstring

Transaction ID/Reference

status'NEW' | 'PENDING_PAYMENT' | 'PAYMENT_SUCCESSFUL' | 'PAYMENT_FAILED' | 'PENDING_BILLING' | 'SUCCESS' | 'REFUND'

Transaction status

source'api' | 'pos' | 'web' | 'android_app' | 'ios_app'

Transaction source

type'withdrawal' | 'purchase' | 'transfer' | 'p2p' | 'online_checkout' | 'qrt_credit' | 'qrt_debit'

Transaction type

terminalIdstring

Terminal ID

rrnstring

RRN (Retrieval Reference Number)

merchantTxRefstring

Merchant transaction reference

orderReferencestring

Online checkout order reference

orderIdstring

Online checkout order id

Example request

{
  "transactionRef": "POS-WITHDRAW-DFC05-693cd007-cd1e-4ea6-8b79-5f5c4d7a83ea",
  "status": "SUCCESS",
  "source": "pos",
  "type": "withdrawal",
  "terminalId": "2KUD4AKB",
  "rrn": "230908202632",
  "merchantTxRef": "c90d-4b25-ad0f",
  "orderReference": "693cd007-cd1e-4ea6-8b79-5f5c4d7a83ea",
  "orderId": "285e4ad2-665f-453b-8795-e854cab5757b"
}

Response

OK - your request was successful.

codestring required

Response Code

descriptionstring required

Response description

Example response

{
  "code": "00",
  "description": "Success",
  "data": {
    "results": [
      {
        "id": "POS-WITHDRAW-DFC05-693cd007-cd1e-4ea6-8b79-5f5c4d7a83ea",
        "status": "SUCCESS",
        "amount": 4000,
        "source": "pos",
        "type": "withdrawal",
        "gatewayMessage": "SUCCESS",
        "customerBillerId": "539983 **** **** 5118",
        "timeCreated": "2026-03-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"
  }
}