BluebulbAPI
    API reference/Sub-wallets
    GET

    List sub-wallets

    Rolling out
    GET{baseUrl}/api/sub-wallets

    Returns your sub-wallets with how much each has received.

    This endpoint is part of an API release that is still rolling out. Fields and endpoints marked Rolling out may not be available on your account yet.

    Authentication

    Send your API key and a request signature on every call. Requests must also come from an IP address on your allowlist — see Authentication.

    Headers

    x-api-key
    required
    string
    Your API key, <appId>.<secret>. See Authentication.
    X-Signature
    required
    string
    Base64 RSA-SHA256 signature of the request. See Request signing.
    X-Signature-Timestamp
    required
    string
    Unix time in milliseconds used in the signature. Must be within 5 minutes of Orbita's clock.

    Query parameters

    page
    optional
    integer
    Page number, starting at 1. Defaults to 1.
    limit
    optional
    integer
    Items per page. Defaults to 10.

    Behaviour

    Results come in a fixed order, but not by creation date. There's no sorting, date range or filtering.

    Response

    data.items is an array of sub-wallets, each with its payment totals; data.meta describes the page. Every response is wrapped in the standard envelope.

    items[].id
    string (uuid)
    Sub-wallet ID.
    items[].accountNumber
    string
    Bank account number your customer pays into.
    items[].accountName
    string
    Account name payers see, taken from the label you sent.
    items[].bankName
    string
    Bank the account is held at.
    items[].bankCode
    string
    Bank code of that bank.
    items[].currency
    string
    Always ngn.
    items[].status
    string
    pending, active, inactive or deactivated. Only active sub-wallets credit payments. See Statuses.
    items[].customerReference
    string | null
    Your reference for this customer, or null if you didn't send one.
    items[].createdAt
    string (datetime)
    When the sub-wallet was created.
    items[].totalReceived
    number
    Total of completed payments into this sub-wallet, in NGN.
    items[].lastPaymentAt
    string (datetime) | null
    When the latest completed payment arrived, or null if none has.
    meta.totalItems
    integer
    Total records matching the filters.
    meta.itemsPerPage
    integer
    The limit applied.
    meta.totalPages
    integer
    Total pages available.
    meta.currentPage
    integer
    The page returned.

    Errors

    No endpoint-specific errors. See Responses & errors for errors every endpoint can return.