COcoinvoyage
onramp

Create Onramp Session

Changed on

Create a headless Stripe embedded onramp session from a server-held onramp intent using the server-held Link OAuth access token. If Stripe identity or KYC action is required, this endpoint returns 422 with action fields in error.details, including status, reason, kyc_next_step, kyc_status, kyc_required, identity_verification_required, and identity_verification_status.

post/onramp/intents/{intent_id}/session

Request

Path parameters

intent_idstring required

Headers

X-API-KEYstring required

API key for authentication

Request body

auth_intent_idstring required

Stripe Link auth intent ID returned by /onramp/auth/intent

crypto_customer_idstring required

Crypto customer ID returned by the Stripe embedded component after Link authentication

payment_tokenstring required

cryptoPaymentToken returned by the Stripe embedded component payment method collection step

Example request

{
  "auth_intent_id": "lai_test_123",
  "crypto_customer_id": "ccus_test_123",
  "payment_token": "cpt_test_123"
}

Response

Headless onramp session created

idstring required
quote_expires_atinteger nullable

Example response

{
  "quote": {
    "network_fee_amount": "0.07",
    "source_amount": "100.00",
    "source_currency": "usd",
    "source_total_amount": "104.11",
    "transaction_fee_amount": "4.04"
  }
}

Changes