Skip to main content
POST
/
onramp
/
intents
Create Onramp Intent
curl --request POST \
  --url https://api.coinvoyage.io/v3/onramp/intents \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '
{
  "destination_amount": "100.00",
  "destination_currency": {
    "address": "EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v",
    "chain_id": 30000000000001
  },
  "order_id": "cuidjkhg3e289y74u5t6v123",
  "source_amount": "125.00",
  "source_currency": "usd",
  "wallet_address": "0xabc123..."
}
'
{
  "destination_currency": {
    "address": "EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v",
    "chain_id": 30000000000001
  },
  "expires_at": "2024-01-01T00:00:00Z",
  "id": "oi_123456789",
  "order_id": "cuidjkhg3e289y74u5t6v123",
  "session_id": "cos_test_123",
  "source_amount": "125.00",
  "source_currency": "usd",
  "status": "requires_link_auth",
  "stripe_publishable_key": "pk_test_123",
  "wallet_address": "0xabc123..."
}

Authorizations

​
X-API-KEY
string
header
required

Headers

​
X-API-KEY
string
required

API key for authentication

Body

application/json
​
destination_currency
object
required

CoinVoyage destination currency. Use chain_id to select the destination chain and address to select a token; omit address for native assets where supported.

Example:
{
  "address": "EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v",
  "chain_id": 30000000000001
}
​
order_id
string

CoinVoyage Order ID. When set, amount, currency, and wallet fields are derived server-side and must not be included.

Example:

"cuidjkhg3e289y74u5t6v123"

​
destination_amount
string

Crypto destination amount for a standalone onramp intent. Mutually exclusive with source_amount.

Example:

"100.00"

​
source_amount
string

Fiat source amount for a standalone onramp intent. Mutually exclusive with destination_amount.

Example:

"125.00"

​
source_currency
enum<string>

Fiat source currency for Stripe embedded onramp intents

Available options:
usd,
eur
Example:

"usd"

​
wallet_address
string
Example:

"0xabc123..."

Response

Onramp intent created

​
id
string
required
Example:

"oi_123456789"

​
status
enum<string>
required
Available options:
requires_link_auth,
requires_kyc,
requires_identity_verification,
requires_document_verification,
identity_verification_pending,
session_created
Example:

"requires_link_auth"

​
source_currency
enum<string>
required

Fiat source currency for Stripe embedded onramp intents

Available options:
usd,
eur
Example:

"usd"

​
stripe_publishable_key
string
required
Example:

"pk_test_123"

​
destination_currency
object
required
Example:
{
  "address": "EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v",
  "chain_id": 30000000000001
}
​
wallet_address
string
required
Example:

"0xabc123..."

​
expires_at
string<date-time>
required
Example:

"2024-01-01T00:00:00Z"

​
order_id
string
Example:

"cuidjkhg3e289y74u5t6v123"

​
session_id
string
Example:

"cos_test_123"

​
source_amount
string
Example:

"125.00"

​
destination_amount
string