BluebulbAPI
    API reference/Conversions
    GET

    Get a conversion

    GET{baseUrl}/api/conversions/{id}

    Returns one conversion. Use it to check whether a conversion has completed.

    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 conversion ID returned when you created it.

    Response

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

    id
    string (uuid)
    Conversion ID.
    userId
    string (uuid)
    ID of the business owner the conversion belongs to.
    fromCurrency
    string
    Currency debited.
    toCurrency
    string
    Currency credited.
    amount
    number
    Amount debited, in fromCurrency.
    convertedAmount
    number
    Amount credited, in toCurrency.
    rate
    number | null
    Raw rate applied (convertedAmount = amount × rate).
    status
    string
    One of processing, pending, completed, failed, refund_pending, expired. See Statuses.
    reference
    string
    Orbita's reference for the conversion.
    proposedCompletionTime
    string (datetime)
    When the conversion is expected to complete, based on the pair's SLA.
    actualCompletionTime
    string (datetime) | null
    When it completed, or null.
    payoutIntentRolling out
    object
    Status of the payout attached to this conversion, if it was created by a cross-currency payout. See below.
    createdAt
    string (datetime)
    When the conversion was created.
    updatedAt
    string (datetime)
    When the conversion last changed.

    payoutIntent

    payoutIntent.requestedRolling out
    boolean
    true when the conversion was created with a payout attached.
    payoutIntent.statusRolling out
    string | null
    pending (waiting for the conversion to complete), created (payout created, see payoutId) or failed (see failureReason). null when requested is false.
    payoutIntent.payoutIdRolling out
    string
    ID of the created payout. Present once status is created.
    payoutIntent.failureReasonRolling out
    string
    Why the payout could not be created. Present when status is failed.

    Errors

    Errors specific to this endpoint:

    400
    Validation failed (uuid is expected)
    id isn't a UUID.
    404
    Conversion not found
    No conversion with this ID belongs to your business.

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