Sign in

v1

latestOpenAPI 3.1.02026-07-1325128129.5 KB
off-ramping

Create Withdrawal

Create an off-ramp withdrawal, start backend deposit monitoring, and return wallet execution steps. Direct withdrawals return a Bridge liquidation deposit step. Swap-backed withdrawals prepare the backend swap and return the resulting execution steps.

post/withdrawals

Headers

Authorization-Signaturestring required

Authorization header format: 'APIKey=<api_key>,signature=<signature>,timestamp=<unix_timestamp>'

Request body

requires_swapboolean
sender_addressstring nullable
slippage_bpsinteger nullable

Example request

{
  "data": {
    "dst": {
      "currency_amount": {
        "unit": "usd"
      }
    },
    "payment_rail": "ach",
    "src": {
      "address": "0x833589fcd6edb6e08f4c7c32d4f71b54bda02913",
      "chain_id": 8453,
      "currency_amount": {
        "fiat": {
          "amount": 100,
          "unit": "USD"
        },
        "token": {
          "raw_amount": "100000000",
          "ui_amount": 100
        }
      },
      "decimals": 6,
      "id": "usdc-base",
      "name": "USD Coin",
      "ticker": "USDC"
    }
  },
  "sender_address": "0x1234...abcd",
  "slippage_bps": 50
}

Response

Withdrawal created with execution steps

idstring required
organization_idstring required
type'OFF_RAMP' | 'ON_RAMP' required
status'PENDING' | 'FUNDS_RECEIVED' | 'KYC_PENDING' | 'COMPLETED' | 'FAILED' required
source_transaction_hashstring nullable
created_atstring date-time required
updated_atstring date-time required
processed_atstring nullable

Example response

{
  "data": {
    "dst": {
      "currency_amount": {
        "unit": "usd"
      }
    },
    "payment_rail": "ach",
    "src": {
      "address": "0x833589fcd6edb6e08f4c7c32d4f71b54bda02913",
      "chain_id": 8453,
      "currency_amount": {
        "fiat": {
          "amount": 100,
          "unit": "USD"
        },
        "token": {
          "raw_amount": "100000000",
          "ui_amount": 100
        }
      },
      "decimals": 6,
      "id": "usdc-base",
      "name": "USD Coin",
      "ticker": "USDC"
    }
  },
  "execution": {
    "destination_tx_hash": "0x5678...efgh",
    "dst": {
      "address": "EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v",
      "amount_out_minimum": {
        "raw_amount": "2400000",
        "ui_amount": 2.4,
        "ui_amount_display": "2.4",
        "value_usd": 123.45
      },
      "chain_id": 30000000000001,
      "currency_amount": {
        "raw_amount": "2400000",
        "ui_amount": 2.4,
        "ui_amount_display": "2.4",
        "value_usd": 123.45
      },
      "decimals": 6,
      "id": "EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v",
      "image_uri": "https://raw.githubusercontent.com/solana-labs/token-list/main/assets/mainnet/EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v/logo.png",
      "name": "USD Coin",
      "price_usd": 1,
      "ticker": "USDC"
    },
    "estimated_duration_seconds": 120,
    "expires_at": "2025-11-03T12:30:00Z",
    "fee_tx_hash": "0xfee1...fee2",
    "payment_rail": "CRYPTO",
    "receiving_address": "9WzDXwBbmkg8ZTbNMqUxvQRAyrZzDsGYdLVL9zYtAWWM",
    "refund_address": "7xVt9ovu6g6E4gvz9K9eV4kxY7yQZ8h3kZ2vY8xZ7xVt",
    "refund_tx_hash": "0x9abc...ijkl",
    "refunded_reason": "execution failed: provider error",
    "source_tx_hash": "0x1234...abcd",
    "src": {
      "address": "EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v",
      "amount_out_minimum": {
        "raw_amount": "2400000",
        "ui_amount": 2.4,
        "ui_amount_display": "2.4",
        "value_usd": 123.45
      },
      "base": {
        "raw_amount": "2400000",
        "ui_amount": 2.4,
        "ui_amount_display": "2.4",
        "value_usd": 123.45
      },
      "chain_id": 30000000000001,
      "currency_amount": {
        "raw_amount": "2400000",
        "ui_amount": 2.4,
        "ui_amount_display": "2.4",
        "value_usd": 123.45
      },
      "decimals": 6,
      "fees": {
        "custom_fee": {
          "raw_amount": "2400000",
          "ui_amount": 2.4,
          "ui_amount_display": "2.4",
          "value_usd": 123.45
        },
        "protocol_fee": {
          "raw_amount": "2400000",
          "ui_amount": 2.4,
          "ui_amount_display": "2.4",
          "value_usd": 123.45
        },
        "relayer_fee": {
          "raw_amount": "2400000",
          "ui_amount": 2.4,
          "ui_amount_display": "2.4",
          "value_usd": 123.45
        },
        "total_fee": {
          "raw_amount": "2400000",
          "ui_amount": 2.4,
          "ui_amount_display": "2.4",
          "value_usd": 123.45
        }
      },
      "gas": {
        "raw_amount": "2400000",
        "ui_amount": 2.4,
        "ui_amount_display": "2.4",
        "value_usd": 123.45
      },
      "id": "EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v",
      "image_uri": "https://raw.githubusercontent.com/solana-labs/token-list/main/assets/mainnet/EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v/logo.png",
      "name": "USD Coin",
      "price_usd": 1,
      "ticker": "USDC",
      "total": {
        "raw_amount": "2400000",
        "ui_amount": 2.4,
        "ui_amount_display": "2.4",
        "value_usd": 123.45
      }
    },
    "steps": [
      {
        "deposit_address": "5xVt9ovu6g6E4gvz9K9eV4kxY7yQZ8h3kZ2vY8xZ5xVt",
        "kind": "deposit",
        "rail": "CRYPTO"
      }
    ]
  }
}