API Reference

Get transactions that occurred on your virtual accounts

Response Schema:

{
    "status": boolean,
    "message": string,
    "data": {
      	"transactions": [
            {
                "id": string,
                "transactionAmount": string,
                "fee": string,
                "stampDuty": string,
                "settlementAmount": string,
                "currency": string,
                "type": "credit",
                "status": "successful",
                "narration": string,,
                "details": {
                    "accountName": string,,
                    "accountNumber": string,,
                    "bank": {
                        "name": string,,
                        "code": string,
                    }
                },
                "virtualAccount": {
                    "id": uuid,
                    "accountReference": uuid,
                    "bankAccount": {
                        "accountName": string,
                        "accountNumber": string,
                        "bank": {
                            "code": string,
                            "name": string
                        }
                    },
                    "type": "Static Virtual Account"|"Dynamic Virtual Account",
                    "status": "active"|"expired"|"blacklisted",
                    "createdAt": date-time,
                    "expiresAt": date-time|null,
                    "currency": string,
                    "meta": {
                        "isStatic": boolean,
                        "bvn": string|null,
                        "transactionReference": string|null,
                        "amount": string|null,
                        "minAmount": string|null
                    }
                },
                "accountReference": string,
                "settlementAccountId": string,
                "datetime": date-time,
                "nipSessionId": string,
                "transactionReference": string | null,
                "settlementStatus": "pending" | "settled"
            }
        ],
        "meta": {
            "total": number,
            "pageCount": number,
            "perPage": number,
            "currentPage": number,
        }
    }
}
Language
Credentials
Header