API Reference

Retrieve information about a bulk transfer using the reference

Response Schema:

{ "status": boolean, "message": string, "data": { "id": string, "reference": string | null, "stats": { "total": number, "successful": number, "failed": number, "pending": number }, "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, } } }
Path Params
string
required

The reference (passed by the client) of the bulk transfer

Responses

Language
Credentials
Choose an example:
application/json