BluebulbAPI
    API reference/Banks
    GET

    List banks

    Rolling out
    GET{baseUrl}/api/banks

    Returns the banks you can pay out to in a currency, with the bankCode to send as destinationBankCode when you create a payout.

    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

    currency
    optional
    string
    Payout currency. Defaults to ngn. Lowercase currency code, e.g. ngn, usd, gbp.

    Behaviour

    Bank codes come from the payment provider your payouts in that currency are routed through, so they can differ from other bank-code lists — always use the bankCode from here. The list can change if Orbita changes provider, so refresh any copy you keep rather than storing it forever.

    Not every currency has a bank list; see the errors below.

    Response

    data is an array of banks. Every response is wrapped in the standard envelope.

    data[].bankName
    string
    Bank name.
    data[].bankCode
    string
    Code to send as destinationBankCode on Create a payout.
    data[].logo
    string
    The bank's logo, when the provider supplies one. Omitted otherwise.

    Errors

    Errors specific to this endpoint:

    400
    Validation failed
    currency isn't a recognised currency code (codes must be lowercase).
    400
    No active payout provider found for currency: kes
    Payouts aren't currently available in this currency.
    400
    Not Implemented
    The payment provider for this currency doesn't offer a bank list.
    400
    Error getting banks
    The payment provider couldn't return its list right now (wording varies by provider). Retry later.

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