---
title: "Create Off-ramp Intent"
method: POST
path: "/off-ramp/intents"
tags: ["off-ramp"]
---

# Create Off-ramp Intent

`POST /off-ramp/intents`

## Headers

- `Authorization-Signature` string, required

## Request body

- CreateWithdrawalRequest
  - `src` CurrencyBase, required
    - `address` string, nullable
    - `chain_id` 1 | 10 | 56 | 137 | 4663 | 8453 | 42161 | 20000000000001 | 30000000000001 | 30000000000002, required
  - `amount` number, required
  - `bank_account_id` string, required
  - `withdraw_currency` string, required
  - `payment_rail` 'ach' | 'wire' | 'ach_push' | 'ach_same_day' | 'sepa' | 'spei' | 'pix' | 'swift' | 'faster_payments' | 'fiat_deposit_return', required — Bridge fiat payment rail used for off-ramp withdrawal settlement
  - `sender_address` string, nullable
  - `slippage_bps` integer, nullable

## Response `201`

Off-ramp intent created with execution steps

- WithdrawalResponse
  - `id` string, required
  - `organization_id` string, required
  - `type` 'OFF_RAMP' | 'ON_RAMP', required
  - `status` 'PENDING' | 'FUNDS_RECEIVED' | 'KYC_PENDING' | 'COMPLETED' | 'FAILED', required
  - `source_transaction_hash` string, nullable
  - `data` WithdrawalData, required
    - `source` CurrencyWithAmount, required
      - `id` string, required
      - `chain_id` 1 | 10 | 56 | 137 | 4663 | 8453 | 42161 | 20000000000001 | 30000000000001 | 30000000000002, required
      - `address` string, nullable
      - `symbol` string, required
      - `name` string
      - `decimals` integer, required
      - `image_uri` string, nullable
      - `chain_image_uri` string, nullable
      - `price_usd` number, nullable
      - `amount` Amount, required
        - `ui` string, required
        - `raw` string, required — A big integer represented as a string to preserve precision
        - `value_usd` number, nullable
      - `ticker` string — Deprecated alias for symbol; use symbol instead.
    - `destination` WithdrawalDestination, required
      - `bank_account_details` BankAccountDetails, required
        - `id` string, required
        - `account_name` string, nullable
        - `bank_name` string, nullable
        - `account_type` 'us' | 'iban' | 'swift' | 'clabe' | 'pix' | 'gb', required — Bank account rail: us (ACH), iban, swift, clabe, pix, or gb (FPS)
        - `account_owner_type` 'individual' | 'business' — Whether the bank account owner is an individual or business
        - `account_details` AccountDetails, required
          - `bank_name` string, nullable
          - `routing_number` string, nullable
          - `sort_code` string, nullable
          - `account_number` string, required
          - `checking_or_savings` string, nullable
          - `bic` string, nullable
          - `pix_key` string, nullable
        - `currency` 'usd' | 'eur' | 'mxn' | 'brl' | 'gbp', required — Currency used by the external bank account
        - `active` boolean, required
        - `beneficiary_address_valid` boolean, nullable
        - `deactivation_reason` string, nullable
        - `deactivation_details` string, nullable
      - `withdraw_currency` string, required
    - `payment_rail` 'ach' | 'wire' | 'ach_push' | 'ach_same_day' | 'sepa' | 'spei' | 'pix' | 'swift' | 'faster_payments' | 'fiat_deposit_return', required — Bridge fiat payment rail used for off-ramp withdrawal settlement
    - `liquidation_address_id` string
    - `swap` WithdrawalSwap
      - `required` boolean, required
      - `order_id` string
      - `status` 'PENDING' | 'EXPIRED' | 'FAILED' | 'AWAITING_PAYMENT' | 'OPTIMISTIC_CONFIRMED' | 'AWAITING_CONFIRMATION' | 'EXECUTING_ORDER' | 'COMPLETED' | 'REFUNDED' | 'PARTIAL_PAYMENT'
      - `receiving_address` string
      - `deposit_address` string
      - `refund_address` string
      - `source_transaction_hash` string
      - `destination_transaction_hash` string
      - `fee_amount_usd` number
    - `drain` LiquidationTransaction
      - `id` string, required
      - `amount` string, required
      - `customer_id` string, required
      - `liquidation_address_id` string, required
      - `currency` string, required
      - `state` 'awaiting_funds' | 'funds_received' | 'payment_submitted' | 'payment_processed' | 'in_review' | 'kyc_required' | 'kyc_in_review' | 'developer_kyb_required' | 'canceled' | 'error' | 'undeliverable' | 'refunded', required — Bridge liquidation drain lifecycle state
      - `created_at` string, required
      - `updated_at` string, required
      - `deposit_tx_hash` string
      - `from_address` string
      - `source_payment_rail` string
      - `destination` LiquidationDestinationDetails
        - `payment_rail` string, required
        - `currency` string, required
        - `to_address` string
        - `blockchain_memo` string
        - `external_account_id` string
        - `wire_message` string
        - `sepa_reference` string
        - `spei_reference` string
        - `reference` string
        - `ach_reference` string
        - `imad` string
        - `trace_number` string
        - `tracking_number` string
        - `transaction_id` string
        - `sending_institution_name` string
        - `uetr` string
      - `destination_tx_hash` string
      - `receipt` LiquidationReceipt
        - `initial_amount` string, required
        - `developer_fee` string, required
        - `subtotal_amount` string, required
        - `converted_amount` string, required
        - `exchange_rate` string, required
        - `outgoing_amount` string, required
        - `destination_currency` string, required
        - `gas_fee` string
        - `url` string
      - `refund_tx_hash` string
      - `return_details` LiquidationReturnDetails
        - `reason` string
        - `risk_rejection_reason` string
  - `execution` PaymentView
    - `payment_rail` 'CRYPTO' | 'FIAT', required
    - `input` QuoteInput, required
      - `currency` Currency, required
        - `id` string, required
        - `chain_id` 1 | 10 | 56 | 137 | 4663 | 8453 | 42161 | 20000000000001 | 30000000000001 | 30000000000002, required
        - `address` string, nullable
        - `symbol` string, required
        - `name` string
        - `decimals` integer, required
        - `image_uri` string, nullable
        - `chain_image_uri` string, nullable
        - `price_usd` number, nullable
      - `amount` Amount, required
        - `ui` string, required
        - `raw` string, required — A big integer represented as a string to preserve precision
        - `value_usd` number, nullable
      - `balance` Amount
        - `ui` string, required
        - `raw` string, required — A big integer represented as a string to preserve precision
        - `value_usd` number, nullable
      - `breakdown` QuoteBreakdown
        - `total` Amount, required
          - `ui` string, required
          - `raw` string, required — A big integer represented as a string to preserve precision
          - `value_usd` number, nullable
        - `base` Amount, required
          - `ui` string, required
          - `raw` string, required — A big integer represented as a string to preserve precision
          - `value_usd` number, nullable
        - `fees` QuoteFees
          - `total_fee` Amount, required
            - `ui` string, required
            - `raw` string, required — A big integer represented as a string to preserve precision
            - `value_usd` number, nullable
          - `protocol_fee` Amount
            - `ui` string, required
            - `raw` string, required — A big integer represented as a string to preserve precision
            - `value_usd` number, nullable
          - `custom_fee` Amount
            - `ui` string, required
            - `raw` string, required — A big integer represented as a string to preserve precision
            - `value_usd` number, nullable
          - `relayer_fee` Amount
            - `ui` string, required
            - `raw` string, required — A big integer represented as a string to preserve precision
            - `value_usd` number, nullable
        - `gas` Amount
          - `ui` string, required
          - `raw` string, required — A big integer represented as a string to preserve precision
          - `value_usd` number, nullable
    - `output` QuoteOutput, required
      - `currency` Currency, required
        - `id` string, required
        - `chain_id` 1 | 10 | 56 | 137 | 4663 | 8453 | 42161 | 20000000000001 | 30000000000001 | 30000000000002, required
        - `address` string, nullable
        - `symbol` string, required
        - `name` string
        - `decimals` integer, required
        - `image_uri` string, nullable
        - `chain_image_uri` string, nullable
        - `price_usd` number, nullable
      - `amount` Amount, required
        - `ui` string, required
        - `raw` string, required — A big integer represented as a string to preserve precision
        - `value_usd` number, nullable
      - `amount_out_minimum` Amount
        - `ui` string, required
        - `raw` string, required — A big integer represented as a string to preserve precision
        - `value_usd` number, nullable
    - `funding` PaymentFunding
      - `required_amount` Amount, required
        - `ui` string, required
        - `raw` string, required — A big integer represented as a string to preserve precision
        - `value_usd` number, nullable
      - `received_amount` Amount, required
        - `ui` string, required
        - `raw` string, required — A big integer represented as a string to preserve precision
        - `value_usd` number, nullable
      - `remaining_amount` Amount, required
        - `ui` string, required
        - `raw` string, required — A big integer represented as a string to preserve precision
        - `value_usd` number, nullable
      - `transactions` PaymentFundingTransaction[], required
        - `tx_hash` string, required
        - `amount` Amount, required
          - `ui` string, required
          - `raw` string, required — A big integer represented as a string to preserve precision
          - `value_usd` number, nullable
    - `recipient` string, required
    - `steps` PaymentStep[], required
      - `id` string
      - `purpose` string
      - `status` string
      - `expires_at` string, nullable
      - `rail` 'CRYPTO' | 'FIAT', required
      - `kind` 'deposit' | 'transaction' | 'stripe_onramp', required
      - `action` string
      - `description` string
      - `data` union
        - DepositStepData
          - `deposit_address` string, required
          - `currency` CurrencyBase, required
            - `address` string, nullable
            - `chain_id` 1 | 10 | 56 | 137 | 4663 | 8453 | 42161 | 20000000000001 | 30000000000001 | 30000000000002, required
          - `amount` string, required — A big integer represented as a string to preserve precision
        - union
          - EVMPaymentData
            - `from` string, required
            - `to` string, required
            - `data` string, required
            - `value` string, required
            - `chainId` 1 | 10 | 56 | 137 | 4663 | 8453 | 42161 | 20000000000001 | 30000000000001 | 30000000000002, required
            - `maxFeePerGas` string
            - `maxPriorityFeePerGas` string
          - BitcoinPaymentData
            - `transaction` string, required — Serialized Bitcoin transaction.
          - SolanaPaymentData
            - `transaction` string, required — Serialized Solana transaction.
          - SuiPaymentData
            - `transaction` string, required — Base64 BCS transaction kind.
        - StripeOnrampPaymentData
          - `session_id` string
          - `stripe_publishable_key` string, required
          - `status` string, required
          - `source_currency` 'usd' | 'eur' — Fiat source currency for Stripe embedded onramp intents
          - `destination_currency` 'usdc' | 'usdb' | 'usdsui' | 'usdt' | 'phantom_cash', required
          - `destination_network` 'arbitrum' | 'base' | 'bitcoin' | 'ethereum' | 'polygon' | 'solana' | 'sui' | 'tempo' | 'worldchain', required
          - `destination_amount` string, required
          - `wallet_address` string, required
    - `expires_at` string, date-time, required
    - `estimated_duration_seconds` number, nullable
    - `source_tx_hash` string, nullable
    - `destination_tx_hash` string, nullable
    - `fee_tx_hash` string, nullable
    - `refund` PaymentRefund
      - `address` string, nullable
      - `tx_hash` string, nullable
      - `reason` string, nullable
  - `created_at` string, date-time, required
  - `updated_at` string, date-time, required
  - `processed_at` string, nullable

## Other responses

- `401` — Unauthorized
- `404` — Organization verification not found
- `422` — Invalid request body or validation failed

---

[API](https://skmtc.net/coinvoyage/apis/coinvoyage-api-v3.md) · [All operations](https://skmtc.net/coinvoyage/apis/coinvoyage-api-v3/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/coinvoyage/coinvoyage-api-v3/revisions/f3a3056f2c83/schema)