Skip to main content

Report off-ramp deposit

POST 
/order/:token/deposit

Tells the API which Arkade transaction paid an off-ramp order. All off-ramp orders share one deposit address, so this report is how a payment is matched to its order: until it is reported, the order is not credited automatically. Call it as soon as the transfer to the deposit address has been sent.

The transaction is verified before anything is credited. It must be an offchain Arkade transfer that pays the deposit address exactly the order's crypto_amount of its asset, it must not be older than the order, and it must not have been credited to another order. The order then moves to DEPOSIT_RECEIVED and the payout follows.

Reporting the same transaction again returns the order unchanged, so retries are safe. On 502, retry later with the same txid.

Request​

Path Parameters

    token stringrequired

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

Body

required
    txid stringrequired

    Possible values: Value must match regular expression ^[0-9a-f]{64}$

    Arkade transaction id (lowercase hex)

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...