API Reference

Get transactions that occurred on your bank accounts

Response Schema:

{ "status": boolean, "message": string, "data": { "transactions": [ { "id": string, "amount": string, "fee": string, "narration": string, "type": "credit" | "debit", "initiatedAt": date-time | null, "completedAt": date-time | null, "accountId": string, "details": { "accountName": string, "accountNumber": string, "bank": { "code": string, "name": string, } } | null, "status": "pending" | "successful" | "failed" | "declined", "failedAt": date-time | null, "reasonForFailure": string | null, "clientReference": string | null, "transactionReference": string, "nipSessionId": string | null }, ], "meta": { "total": number, "pageCount": number, "perPage": number, "currentPage": number, } } }
Query Params
int32
Defaults to 1

Specify exactly what page you want to retrieve. If not specify we use a default value of 1.

string

"pending" | "successful" | "failed" | "declined"

string

"credit" | "debit"

date

Earliest initiatedAt or completedAt date to filter for. Format: YYYY-MM-DD

date

Latest initiatedAt or completedAt date to filter for. Format: YYYY-MM-DD

string

Search term to look for.

accountIds
array of strings

Your 36-character account uuid to filter transactions.

accountIds
Response

Language
Credentials
Choose an example:
application/json