COcoinvoyage
onramp

Create Onramp Intent

Changed on

Create a reusable onramp intent. For Orders, amount, destination currency, and wallet fields are derived server-side from the Order and cannot be overridden by the client.

post/onramp/intents

Request

Headers

X-API-KEYstring required

API key for authentication

Request body

order_idstring

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

destination_amountstring

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

source_amountstring

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

source_currency'usd' | 'eur'

Fiat source currency for Stripe embedded onramp intents

wallet_addressstring

Example request

{
  "destination_amount": "100.00",
  "destination_currency": {
    "address": "EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v",
    "chain_id": 30000000000001
  },
  "order_id": "cuidjkhg3e289y74u5t6v123",
  "source_amount": "125.00",
  "source_currency": "usd",
  "wallet_address": "0xabc123..."
}

Response

Onramp intent created

idstring required
order_idstring
session_idstring
status'requires_link_auth' | 'requires_kyc' | 'requires_identity_verification' | 'requires_document_verification' | 'identity_verification_pending' | 'session_created' required
source_amountstring
source_currency'usd' | 'eur' required

Fiat source currency for Stripe embedded onramp intents

stripe_publishable_keystring required
destination_amountstring
wallet_addressstring required
expires_atstring date-time required

Example response

{
  "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..."
}

Changes

  • 9b0a781499e3Revision changes
    • warning

      added the new 20000000000002.00 enum value to the / response property for the response status

    • info

      added the new 20000000000002.00 enum value to the request property /

  • 9bac53bd1da7Revision changes
    • warning

      added the new 4663.00 enum value to the / response property for the response status

    • info

      added the new 4663.00 enum value to the request property /