Create Off-ramp Intent

curl --request POST \
  --url https://api.coinvoyage.io/v3/off-ramp/intents \
  --header 'Authorization: <api-key>' \
  --header 'Authorization-Signature: <authorization-signature>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "amount": 10.5,
  "bank_account_id": "external_123",
  "destination_reference": "invoice-123",
  "payment_rail": "ach",
  "sender_address": "0x1234...abcd",
  "slippage_bps": 50,
  "src": {
    "address": "EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v",
    "chain_id": 30000000000001
  },
  "withdraw_currency": "usd"
}
'

import requests

url = "https://api.coinvoyage.io/v3/off-ramp/intents"

payload = {
    "amount": 10.5,
    "bank_account_id": "external_123",
    "destination_reference": "invoice-123",
    "payment_rail": "ach",
    "sender_address": "0x1234...abcd",
    "slippage_bps": 50,
    "src": {
        "address": "EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v",
        "chain_id": 30000000000001
    },
    "withdraw_currency": "usd"
}
headers = {
    "Authorization-Signature": "<authorization-signature>",
    "Authorization": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'Authorization-Signature': '<authorization-signature>',
    Authorization: '<api-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    amount: 10.5,
    bank_account_id: 'external_123',
    destination_reference: 'invoice-123',
    payment_rail: 'ach',
    sender_address: '0x1234...abcd',
    slippage_bps: 50,
    src: {
      address: 'EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v',
      chain_id: 30000000000001
    },
    withdraw_currency: 'usd'
  })
};

fetch('https://api.coinvoyage.io/v3/off-ramp/intents', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.coinvoyage.io/v3/off-ramp/intents",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'amount' => 10.5,
    'bank_account_id' => 'external_123',
    'destination_reference' => 'invoice-123',
    'payment_rail' => 'ach',
    'sender_address' => '0x1234...abcd',
    'slippage_bps' => 50,
    'src' => [
        'address' => 'EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v',
        'chain_id' => 30000000000001
    ],
    'withdraw_currency' => 'usd'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>",
    "Authorization-Signature: <authorization-signature>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.coinvoyage.io/v3/off-ramp/intents"

	payload := strings.NewReader("{\n  \"amount\": 10.5,\n  \"bank_account_id\": \"external_123\",\n  \"destination_reference\": \"invoice-123\",\n  \"payment_rail\": \"ach\",\n  \"sender_address\": \"0x1234...abcd\",\n  \"slippage_bps\": 50,\n  \"src\": {\n    \"address\": \"EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v\",\n    \"chain_id\": 30000000000001\n  },\n  \"withdraw_currency\": \"usd\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization-Signature", "<authorization-signature>")
	req.Header.Add("Authorization", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.coinvoyage.io/v3/off-ramp/intents")
  .header("Authorization-Signature", "<authorization-signature>")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"amount\": 10.5,\n  \"bank_account_id\": \"external_123\",\n  \"destination_reference\": \"invoice-123\",\n  \"payment_rail\": \"ach\",\n  \"sender_address\": \"0x1234...abcd\",\n  \"slippage_bps\": 50,\n  \"src\": {\n    \"address\": \"EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v\",\n    \"chain_id\": 30000000000001\n  },\n  \"withdraw_currency\": \"usd\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.coinvoyage.io/v3/off-ramp/intents")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization-Signature"] = '<authorization-signature>'
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"amount\": 10.5,\n  \"bank_account_id\": \"external_123\",\n  \"destination_reference\": \"invoice-123\",\n  \"payment_rail\": \"ach\",\n  \"sender_address\": \"0x1234...abcd\",\n  \"slippage_bps\": 50,\n  \"src\": {\n    \"address\": \"EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v\",\n    \"chain_id\": 30000000000001\n  },\n  \"withdraw_currency\": \"usd\"\n}"

response = http.request(request)
puts response.read_body

{
  "data": {
    "destination_reference": "invoice-123",
    "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",
    "funding": {
      "received_amount": {
        "raw": "100000000",
        "ui": "100.0",
        "value_usd": 100
      },
      "remaining_amount": {
        "raw": "100000000",
        "ui": "100.0",
        "value_usd": 100
      },
      "required_amount": {
        "raw": "100000000",
        "ui": "100.0",
        "value_usd": 100
      },
      "transactions": [
        {
          "amount": {
            "raw": "100000000",
            "ui": "100.0",
            "value_usd": 100
          },
          "tx_hash": "0x1234...abcd"
        }
      ]
    },
    "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"
}

{
  "code": 400,
  "error": "Bad Request",
  "message": "Invalid request parameters"
}

{
  "code": 400,
  "error": "Bad Request",
  "message": "Invalid request parameters"
}

{
  "code": 400,
  "error": "Bad Request",
  "message": "Invalid request parameters"
}

POST

off-ramp

intents

Create Off-ramp Intent

curl --request POST \
  --url https://api.coinvoyage.io/v3/off-ramp/intents \
  --header 'Authorization: <api-key>' \
  --header 'Authorization-Signature: <authorization-signature>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "amount": 10.5,
  "bank_account_id": "external_123",
  "destination_reference": "invoice-123",
  "payment_rail": "ach",
  "sender_address": "0x1234...abcd",
  "slippage_bps": 50,
  "src": {
    "address": "EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v",
    "chain_id": 30000000000001
  },
  "withdraw_currency": "usd"
}
'

import requests

url = "https://api.coinvoyage.io/v3/off-ramp/intents"

payload = {
    "amount": 10.5,
    "bank_account_id": "external_123",
    "destination_reference": "invoice-123",
    "payment_rail": "ach",
    "sender_address": "0x1234...abcd",
    "slippage_bps": 50,
    "src": {
        "address": "EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v",
        "chain_id": 30000000000001
    },
    "withdraw_currency": "usd"
}
headers = {
    "Authorization-Signature": "<authorization-signature>",
    "Authorization": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'Authorization-Signature': '<authorization-signature>',
    Authorization: '<api-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    amount: 10.5,
    bank_account_id: 'external_123',
    destination_reference: 'invoice-123',
    payment_rail: 'ach',
    sender_address: '0x1234...abcd',
    slippage_bps: 50,
    src: {
      address: 'EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v',
      chain_id: 30000000000001
    },
    withdraw_currency: 'usd'
  })
};

fetch('https://api.coinvoyage.io/v3/off-ramp/intents', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.coinvoyage.io/v3/off-ramp/intents",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'amount' => 10.5,
    'bank_account_id' => 'external_123',
    'destination_reference' => 'invoice-123',
    'payment_rail' => 'ach',
    'sender_address' => '0x1234...abcd',
    'slippage_bps' => 50,
    'src' => [
        'address' => 'EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v',
        'chain_id' => 30000000000001
    ],
    'withdraw_currency' => 'usd'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>",
    "Authorization-Signature: <authorization-signature>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.coinvoyage.io/v3/off-ramp/intents"

	payload := strings.NewReader("{\n  \"amount\": 10.5,\n  \"bank_account_id\": \"external_123\",\n  \"destination_reference\": \"invoice-123\",\n  \"payment_rail\": \"ach\",\n  \"sender_address\": \"0x1234...abcd\",\n  \"slippage_bps\": 50,\n  \"src\": {\n    \"address\": \"EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v\",\n    \"chain_id\": 30000000000001\n  },\n  \"withdraw_currency\": \"usd\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization-Signature", "<authorization-signature>")
	req.Header.Add("Authorization", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.coinvoyage.io/v3/off-ramp/intents")
  .header("Authorization-Signature", "<authorization-signature>")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"amount\": 10.5,\n  \"bank_account_id\": \"external_123\",\n  \"destination_reference\": \"invoice-123\",\n  \"payment_rail\": \"ach\",\n  \"sender_address\": \"0x1234...abcd\",\n  \"slippage_bps\": 50,\n  \"src\": {\n    \"address\": \"EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v\",\n    \"chain_id\": 30000000000001\n  },\n  \"withdraw_currency\": \"usd\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.coinvoyage.io/v3/off-ramp/intents")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization-Signature"] = '<authorization-signature>'
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"amount\": 10.5,\n  \"bank_account_id\": \"external_123\",\n  \"destination_reference\": \"invoice-123\",\n  \"payment_rail\": \"ach\",\n  \"sender_address\": \"0x1234...abcd\",\n  \"slippage_bps\": 50,\n  \"src\": {\n    \"address\": \"EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v\",\n    \"chain_id\": 30000000000001\n  },\n  \"withdraw_currency\": \"usd\"\n}"

response = http.request(request)
puts response.read_body

{
  "data": {
    "destination_reference": "invoice-123",
    "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",
    "funding": {
      "received_amount": {
        "raw": "100000000",
        "ui": "100.0",
        "value_usd": 100
      },
      "remaining_amount": {
        "raw": "100000000",
        "ui": "100.0",
        "value_usd": 100
      },
      "required_amount": {
        "raw": "100000000",
        "ui": "100.0",
        "value_usd": 100
      },
      "transactions": [
        {
          "amount": {
            "raw": "100000000",
            "ui": "100.0",
            "value_usd": 100
          },
          "tx_hash": "0x1234...abcd"
        }
      ]
    },
    "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"
}

{
  "code": 400,
  "error": "Bad Request",
  "message": "Invalid request parameters"
}

{
  "code": 400,
  "error": "Bad Request",
  "message": "Invalid request parameters"
}

{
  "code": 400,
  "error": "Bad Request",
  "message": "Invalid request parameters"
}

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

Show child attributes

Example:

{
  "address": "EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v",
  "chain_id": 30000000000001
}

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 settlement

Available options:

ach,

wire,

ach_push,

ach_same_day,

sepa,

spei,

pix,

swift,

faster_payments,

bre_b,

co_bank_transfer,

fiat_deposit_return

Example:

"ach"

destination_reference

string | null

Example:

"invoice-123"

sender_address

string | null

Example:

"0x1234...abcd"

slippage_bps

integer | null

Example:

50

Response

Off-ramp intent created with execution steps

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

Lifecycle of an off-ramp intent

Available options:

PENDING,

FUNDS_RECEIVED,

KYC_PENDING,

COMPLETED,

FAILED

data

object

required

Show child attributes

Example:

{
  "destination_reference": "invoice-123",
  "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"
  }
}

created_at

string<date-time>

required

updated_at

string<date-time>

required

source_transaction_hash

string | null

Example:

"0xabc123..."

execution

object | null

Show child attributes

Example:

{
  "destination_tx_hash": "0x5678...efgh",
  "estimated_duration_seconds": 120,
  "expires_at": "2023-01-01T00:00:00Z",
  "fee_tx_hash": "0xfee1...fee2",
  "funding": {
    "received_amount": {
      "raw": "100000000",
      "ui": "100.0",
      "value_usd": 100
    },
    "remaining_amount": {
      "raw": "100000000",
      "ui": "100.0",
      "value_usd": 100
    },
    "required_amount": {
      "raw": "100000000",
      "ui": "100.0",
      "value_usd": 100
    },
    "transactions": [
      {
        "amount": {
          "raw": "100000000",
          "ui": "100.0",
          "value_usd": 100
        },
        "tx_hash": "0x1234...abcd"
      }
    ]
  },
  "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"
    }
  ]
}

processed_at

string | null

api-keys

fees

invoices

off-ramp

onramp

onramps

orders

x402

search

swap

wallet

webhooks

websocket

Create Off-ramp Intent

Authorizations

Headers

Body

Response