Skip to main content
POST
Create Off-ramp Intent

Authorizations

Authorization
string
header
required

HMAC-SHA256 signature. See the Authorization-Signature header parameter on signed operations.

Headers

Authorization-Signature
string
required

HMAC-SHA256 signature header: 'APIKey=<api_key>,signature=,timestamp=<unix_timestamp>'. The signature is computed over METHOD + path (with the /v3 prefix stripped) + timestamp.

Body

application/json
src
object
required
Example:
amount
number
required
Example:

10.5

bank_account_id
string
required
Example:

"external_123"

withdraw_currency
string
required
Example:

"usd"

payment_rail
enum<string>
required

Bridge fiat payment rail used for off-ramp withdrawal settlement

Available options:
ach,
wire,
ach_push,
ach_same_day,
sepa,
spei,
pix,
swift,
faster_payments,
fiat_deposit_return
Example:

"ach"

sender_address
string | null
Example:

"0x1234...abcd"

slippage_bps
integer | null
Example:

50

Response

Off-ramp intent created with execution steps

id
string
required
Example:

"withdrawal_123"

organization_id
string
required
Example:

"org_123"

type
enum<string>
required
Available options:
OFF_RAMP,
ON_RAMP
Example:

"OFF_RAMP"

status
enum<string>
required
Available options:
PENDING,
FUNDS_RECEIVED,
KYC_PENDING,
COMPLETED,
FAILED
Example:

"PENDING"

data
object
required
Example:
created_at
string<date-time>
required
updated_at
string<date-time>
required
source_transaction_hash
string | null
Example:

"0xabc123..."

processed_at
string | null