Sign in

v2

OpenAPI 3.1.02026-07-3139137119.0 KB
off-ramp

Create Off-ramp Intent

post/off-ramp/intents

Headers

Authorization-Signaturestring required

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

Request body

amountnumber required
bank_account_idstring required
withdraw_currencystring 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_addressstring nullable
slippage_bpsinteger nullable

Example request

{
  "amount": 10.5,
  "bank_account_id": "external_123",
  "payment_rail": "ach",
  "sender_address": "0x1234...abcd",
  "slippage_bps": 50,
  "src": {
    "address": "EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v",
    "chain_id": 30000000000001
  },
  "withdraw_currency": "usd"
}

Response

Off-ramp intent 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": {
    "payment_rail": "ach",
    "source": {
      "address": "0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48",
      "amount": {
        "raw": "100000000",
        "ui": "100.0",
        "value_usd": 100
      },
      "chain_id": 1,
      "decimals": 6,
      "id": "0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48-1",
      "name": "USD Coin",
      "price_usd": 1,
      "symbol": "USDC"
    }
  },
  "execution": {
    "destination_tx_hash": "0x5678...efgh",
    "estimated_duration_seconds": 120,
    "expires_at": "2023-01-01T00:00:00Z",
    "fee_tx_hash": "0xfee1...fee2",
    "input": {
      "amount": {
        "raw": "100000000",
        "ui": "100.0",
        "value_usd": 100
      },
      "balance": {
        "raw": "100000000",
        "ui": "100.0",
        "value_usd": 100
      },
      "breakdown": {
        "base": {
          "raw": "100000000",
          "ui": "100.0",
          "value_usd": 100
        },
        "fees": {
          "custom_fee": {
            "raw": "100000000",
            "ui": "100.0",
            "value_usd": 100
          },
          "protocol_fee": {
            "raw": "100000000",
            "ui": "100.0",
            "value_usd": 100
          },
          "relayer_fee": {
            "raw": "100000000",
            "ui": "100.0",
            "value_usd": 100
          },
          "total_fee": {
            "raw": "100000000",
            "ui": "100.0",
            "value_usd": 100
          }
        },
        "gas": {
          "raw": "100000000",
          "ui": "100.0",
          "value_usd": 100
        },
        "total": {
          "raw": "100000000",
          "ui": "100.0",
          "value_usd": 100
        }
      },
      "currency": {
        "address": "0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48",
        "chain_id": 1,
        "decimals": 6,
        "id": "0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48-1",
        "name": "USD Coin",
        "price_usd": 1,
        "symbol": "USDC"
      }
    },
    "output": {
      "amount": {
        "raw": "100000000",
        "ui": "100.0",
        "value_usd": 100
      },
      "amount_out_minimum": {
        "raw": "100000000",
        "ui": "100.0",
        "value_usd": 100
      },
      "currency": {
        "address": "0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48",
        "chain_id": 1,
        "decimals": 6,
        "id": "0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48-1",
        "name": "USD Coin",
        "price_usd": 1,
        "symbol": "USDC"
      }
    },
    "payment_rail": "CRYPTO",
    "recipient": "0x1234...abcd",
    "refund": {
      "address": "0x1234...abcd",
      "reason": "execution failed: provider error",
      "tx_hash": "0x9abc...ijkl"
    },
    "source_tx_hash": "0x1234...abcd",
    "steps": [
      {
        "action": "swap",
        "kind": "deposit",
        "rail": "CRYPTO"
      }
    ]
  },
  "id": "withdrawal_123",
  "organization_id": "org_123",
  "source_transaction_hash": "0xabc123...",
  "status": "PENDING",
  "type": "OFF_RAMP"
}