Real-time data

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

a. Account Details

Endpoint: GET: https://api.withmono.com/v1/accounts/{id}

Response

{
    "status": "successful",
    "message": "Successfully fetched account",
    "data": {
        "id": "65203b27f6323a96a4a",
        "name": "Samuel Olamide",
        "type": "SAVINGS_ACCOUNT",
        "account_number": "1234567890",
        "balance": 206119,
        "currency": "ngn",
        "data_status": "available",
        "institution": {
            "name": "Zenith Bank",
            "type": "personal_banking",
            "bank_code": "057",
            "auth_method": "mobile_banking"
        },
        "created_at": "2023-10-06T16:51:51.818Z",
        "updated_at": "2023-10-09T01:41:21.558Z"
    }
}

b. Account Transactions

Endpoint: GET: https://api.withmono.com/v1/accounts/{id}/transactions

Response

{
    "status": "successful",
    "message": "Successfully fetched transactions",
    "data": {
        "paging": {
            "page": 1,
            "total": 35,
            "previous": null,
            "next": "https://api.withmono.com/accounts/65203b27f6323a96a4a83779/transactions?page=2"
        },
        "transactions": [
            {
                "id": "652052349d3a9e0484891f28",
                "type": "credit",
                "amount": 9000,
                "narration": "NIP/KUDA/KING KENWAYDAVIDSON/TRANSFER 1",
                "date": "2023-10-06T18:08:50.000Z",
                "balance": 0,
                "currency": "NGN"
            }
        ]
    }
}

c. Account Statements

Endpoint: GET: https://api.withmono.com/v1/accounts/{id}/statement

Response

{
    "status": "successful",
    "message": "Successfully fetched transactions",
    "data": {
        "paging": {
            "page": 1,
            "total": 35,
            "previous": null,
            "next": "https://api.withmono.com/accounts/65203b27f6323a96a4a83779/transactions?page=2"
        },
        "transactions": [
            {
                "id": "652052349d3a9e0484891f28",
                "type": "credit",
                "amount": 9000,
                "narration": "NIP/KUDA/KING KENWAYDAVIDSON/TRANSFER 1",
                "date": "2023-10-06T18:08:50.000Z",
                "balance": 0,
                "currency": "NGN"
            }
        ]
    }
}