Skip to main content
POST
Create an exchange order

Authorizations

X-API-Key
string
header
required

Partner API key issued in the dashboard. Use pk_live_... in production, pk_test_... against sandbox.

Body

application/json
quote_id
string
required
address
string
required

Payout address.

extra_id
string | null

Memo for XRP/XLM/TON.

refund_address
string | null
refund_extra_id
string | null
refund_preference
object
partner_order_ref
string

Your internal id. Returned back in webhooks. Used for logical-dupe detection.

Response

Created

order_id
string
Example:

"prv-9f0e..."

provider_order_id
string
from
string
to
string
amount_from
string
amount_to_expected
string
amount_to_actual
string | null
deposit_address
string
deposit_extra_id
string | null
payout_address
string
status
enum<string>
Available options:
waiting_deposit,
confirming,
exchanging,
sending,
completed,
failed,
expired,
refund_required,
refunded,
manual_review
failed_reason_code
enum<string> | null
Available options:
kyt_block,
amount_out_of_range,
rate_changed,
provider_timeout,
provider_internal,
underpayment,
overpayment,
network_congestion,
unknown
failed_reason_message
string | null
refund_capability
enum<string>
Available options:
programmatic,
ticket,
none
refund_window_hours
integer | null
refund_sla_hours
integer | null
tx_in_hash
string | null
tx_out_hash
string | null
expires_at
string<date-time>
created_at
string<date-time>
tracking_url
string<uri>

Signed URL with embedded HMAC token. Do not modify.

timeline
object[]