BluebulbAPI
    API reference/Sub-wallets
    GET

    Get a sub-wallet

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

    Returns one sub-wallet with its payment totals.

    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.

    Path parameters

    id
    required
    string (uuid)
    The sub-wallet ID returned when you created it.

    Response

    data is a sub-wallet with its payment totals. Every response is wrapped in the standard envelope.

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

    Errors

    Errors specific to this endpoint:

    404
    Sub-wallet not found
    No sub-wallet with this ID belongs to your business.

    Plus the errors every endpoint can return — authentication, signing, rate limiting and server errors. See Responses & errors.