Skip to main content

Order status

GET 
/order/:token

Returns an order by the short public token returned as order.id when it was created. No authentication required.

There are no webhooks: poll this endpoint for status changes, for example every 30–60 seconds while the customer is waiting and less often afterwards. Bank transfers can take several days.

Request​

Path Parameters

    token stringrequired

    Short public order token (order.id from the create response)

Responses​

OK

Schema
    order object
    id string

    Short public token (shown to customer)

    code string

    Human-readable order reference. Quote it when contacting support.

    email string
    direction string

    Possible values: [onramp, offramp]

    asset stringnullable

    Null for gift card purchases — no crypto asset involved

    fiat_currency string
    fiat_amount stringnullable

    Null until settlement for off-ramp orders — see status

    crypto_amount stringnullable

    Null until settlement for on-ramp orders — see status

    status string

    Possible values: [WAITING_FOR_DEPOSIT, DEPOSIT_RECEIVED, PROCESSING, COMPLETED, FAILED, PENDING_MANUAL, REJECTED, EXPIRED, REFUNDED]

    transfer_code string

    Bank payment reference the customer must include in their transfer

    destination_type string

    Possible values: [crypto, sepa, swift, us, gift_card]

    destination_crypto_address stringnullable
    deposit_txid stringnullable

    Off-ramp: the Arkade transaction credited as the deposit

    deposit_iban stringnullable
    deposit_bic stringnullable
    deposit_beneficiary stringnullable
    deposit_bank_name stringnullable
    deposit_payment_type stringnullable
    kyc_verified boolean
    created_at date-time
    expires_at date-timenullable
    completed_at date-timenullable
Loading...