BluebulbAPI
    API reference/Payouts
    GET

    Get a payout

    GET{baseUrl}/api/payouts/{idOrReference}

    Returns one payout, looked up by Orbita's payout ID or your customerReference. Use it to requery a payout's status — including after a request that timed out.

    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

    idOrReference
    required
    string
    The payout id, or the customerReference you sent when creating it. URL-encode references containing reserved characters.

    Response

    data is a payout object. Every response is wrapped in the standard envelope.

    id
    string (uuid)
    Payout ID.
    customerReference
    string
    Your reference for the payout.
    status
    string
    queued, pending, successful or failed. See Statuses.
    sourceCurrency
    string
    Currency debited.
    destinationCurrency
    string
    Currency the beneficiary receives.
    amount
    number
    Payout amount (2 decimal places).
    fee
    number
    Fee charged for the payout. 0 when no fee applies — same-currency payouts only carry a fee when they are offshore.
    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.
    destinationAmount
    number
    Payout amount in destinationCurrency, before any deducted fee.
    exchangeRate
    number
    Exchange rate recorded on the payout (up to 8 decimal places).
    destinationAccountNumber
    string
    Beneficiary account number.
    destinationAccountName
    string
    Beneficiary account name.
    destinationBankCode
    string
    Beneficiary bank code.
    destinationBankName
    string
    Beneficiary bank name.
    narration
    string
    Narration sent with the payout.
    refundStatus
    string | null
    refunded once a failed payout's funds have been returned to your balance, otherwise null.
    isGreylisted
    boolean
    true when the payout has been flagged for additional compliance review.
    conversionIdRolling out
    string | null
    ID of the conversion linked to this payout, or null.
    createdAt
    string (datetime)
    When the payout was created.
    updatedAt
    string (datetime)
    When the payout last changed.

    Errors

    Errors specific to this endpoint:

    404
    Payout not found
    No payout with this ID or reference belongs to your business.

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