BluebulbAPI
    API reference/Payouts
    GET

    List payouts

    GET{baseUrl}/api/payouts

    Returns your payouts, newest first.

    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.
    sort
    optional
    JSON string
    A single-key JSON object, e.g. {"createdAt":"ASC"} (URL-encoded). Sortable on createdAt, updatedAt, amount, status. Defaults to {"createdAt":"DESC"}.
    startDate
    optional
    date
    Only include records created on or after this date, e.g. 2026-09-01. Use together with endDate.
    endDate
    optional
    date
    Only include records created on or before the end of this date. Use together with startDate.
    status
    optional
    string
    Only payouts with this status. pending currently matches only payouts already sent to the payment provider, not those still in review — leave status out to see every payout.
    sourceCurrency
    optional
    string
    Only payouts debited in this currency.
    destinationCurrency
    optional
    string
    Only payouts paid out in this currency.
    refundStatus
    optional
    string
    refunded to list refunded payouts.
    isGreylisted
    optional
    boolean
    Only payouts flagged (true) or not flagged (false) for additional review.
    search
    optional
    string
    Matches a payout ID, the provider's reference, or part of the beneficiary account name or number.
    conversionId
    optionalRolling out
    string (uuid)
    Only the payout linked to this conversion.

    Behaviour

    Any other query parameter is rejected with 400.

    Response

    data.items is an array of payout objects; data.meta describes the page. Every response is wrapped in the standard envelope.

    items[].id
    string (uuid)
    Payout ID.
    items[].customerReference
    string
    Your reference for the payout.
    items[].status
    string
    queued, pending, successful or failed. See Statuses.
    items[].sourceCurrency
    string
    Currency debited.
    items[].destinationCurrency
    string
    Currency the beneficiary receives.
    items[].amount
    number
    Payout amount (2 decimal places).
    items[].fee
    number
    Fee charged for the payout. 0 when no fee applies — same-currency payouts only carry a fee when they are offshore.
    items[].amountSent
    number
    Amount the beneficiary receives. amount minus fee when the fee is deducted from the payout; equal to amount when the fee is charged on top or there is no fee.
    items[].destinationAmount
    number
    Payout amount in destinationCurrency, before any deducted fee.
    items[].exchangeRate
    number
    Exchange rate recorded on the payout (up to 8 decimal places).
    items[].destinationAccountNumber
    string
    Beneficiary account number.
    items[].destinationAccountName
    string
    Beneficiary account name.
    items[].destinationBankCode
    string
    Beneficiary bank code.
    items[].destinationBankName
    string
    Beneficiary bank name.
    items[].narration
    string
    Narration sent with the payout.
    items[].refundStatus
    string | null
    refunded once a failed payout's funds have been returned to your balance, otherwise null.
    items[].isGreylisted
    boolean
    true when the payout has been flagged for additional compliance review.
    items[].conversionIdRolling out
    string | null
    ID of the conversion linked to this payout, or null.
    items[].createdAt
    string (datetime)
    When the payout was created.
    items[].updatedAt
    string (datetime)
    When the payout last changed.
    meta.totalItems
    integer
    Total records matching the filters.
    meta.itemCount
    integer
    Records on this page.
    meta.itemsPerPage
    integer
    The limit applied.
    meta.totalPages
    integer
    Total pages available.
    meta.currentPage
    integer
    The page returned.

    Errors

    Errors specific to this endpoint:

    400
    Unsupported filter field(s): beneficiaryName
    A query parameter isn't one of those listed above.
    400
    Unsupported sort field(s): fee
    sort uses a field that can't be sorted on.
    400
    Invalid startDate
    startDate or endDate isn't a valid date.

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