API Reference

Retrieve information about a specific transaction that occurred on a virtual account

Response Schema:

{
    "status": boolean,
    "message": string,
    "data": {
        "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"
    }
}
Language
Credentials
Header