Overview

This feature allows you to retrieve real-time financial data from your customer's linked account. We silently fetch data from the bank if persistence access is available; otherwise, re-authorization is requested from the user.

How It Works

• Partners add x-realtime in their API header for endpoints like accounts, transactions, and statements.
• We silently fetch data from the bank if persistence access is available for the linked account; otherwise, re-authorization is requested from the user.
• A cost of 10N or 0.0013 cents in USD per real-time API call, with a 5N re-authorization fee.

Authentication

Requests to the Real-time Data API must include the following in the header:

• Mono Security Key: mono-sec-key: live_sk_example
• x-realtime: true

API Response Headers

The responses in the endpoints below will include the following headers:

• x-reauth-required: true|false - Indicates if reauthorization by the end-user is required.
• x-has-new-data: true | false - Indicates if new data was fetched.

API Endpoints

{
    "status": "successful",
    "message": "Request was succesfully completed",
    "timestamp": "2024-04-12T06:31:02.289Z",
    "data": {
        "account": {
            "id": "64779d900000000000b3de23aeb8",
            "name": "Samuel Olamide Nomo",
            "currency": "NGN",
            "type": "Digital Savings Account",
            "account_number": "1234567890",
            "balance": 333064,
            "bvn": "0065",
            "institution": {
                "name": "GTBank",
                "bank_code": "058",
                "type": "PERSONAL_BANKING"
            }
        },
        "meta": {
            "data_status": "AVAILABLE",
            "auth_method": "internet_banking"
            "subscribed_to_data_sync": true
        }
    }
}