Retrieve a CryptoOnrampSession

Retrieves the details of a CryptoOnrampSession that was previously created.

Parameters

No parameters.

Returns

Returns a CryptoOnrampSession object

GET /v1/crypto/onramp_sessions/:id

Server-side language

curl https://api.stripe.com/v1/crypto/onramp_sessions/cos_1NamBL2eZvKYlo2CP38sZVEW \
  -u "sk_test_BQokikJ...2HlWgH4olfQ2sk_test_BQokikJOvBiI2HlWgH4olfQ2:"

Response

{
  "id": "cos_1NamBL2eZvKYlo2CP38sZVEW",
  "object": "crypto.onramp_session",
  "client_secret": "cos_1NamBL2eZvKYlo2CP38sZVEW_secret_B5faamUkzHbcpjy6NndGq1mMZGGCo8FhK2P",
  "created": 1691010131,
  "kyc_details_provided": false,
  "livemode": true,
  "metadata": {},
  "redirect_url": null,
  "status": "initialized",
  "transaction_details": {
    "destination_amount": null,
    "destination_currencies": [
      "btc",
      "eth",
      "matic",
      "sol",
      "xlm",
      "avax",
      "usdc"
    ],
    "destination_currency": null,
    "destination_network": null,
    "destination_networks": [
      "bitcoin",
      "ethereum",
      "base",
      "polygon",
      "solana",
      "stellar",
      "avalanche"
    ],
    "fees": null,
    "lock_wallet_address": false,
    "source_amount": null,
    "source_currency": null,
    "transaction_id": null,
    "wallet_address": null,
    "wallet_addresses": null
  }
}

List CryptoOnrampSessions

Returns a list of onramp sessions that match the filter criteria. The onramp sessions are returned in sorted order, with the most recent onramp sessions appearing first.

Parameters

createdobject
Only return onramp sessions that were created during the given date interval.

destination_currencyenum
The destination cryptocurrency to filter by.

destination_networkenum
The destination blockchain network to filter by.

ending_beforestring
An object ID cursor for use in pagination.

limitinteger
A limit ranging from 1 to 100 (defaults to 10).

starting_afterstring
An object ID cursor for use in pagination.

statusenum
The status of the Onramp Session. One of = {initialized, rejected, requires_payment, fulfillment_processing, fulfillment_complete}

Returns

A dictionary with a data property that contains an array of up to limit onramp sessions, starting after onramp session starting_after. Each entry in the array is a separate onramp session object. If no more onramp sessions are available, the resulting array will be empty.

GET /v1/crypto/onramp_sessions

Server-side language

curl -G https://api.stripe.com/v1/crypto/onramp_sessions \
  -u "sk_test_BQokikJ...2HlWgH4olfQ2sk_test_BQokikJOvBiI2HlWgH4olfQ2:" \
  -d limit=3

Response

{
  "object": "list",
  "url": "/v1/crypto/onramp_sessions",
  "has_more": false,
  "data": [
    {
      "id": "cos_1NamBL2eZvKYlo2CP38sZVEW",
      "object": "crypto.onramp_session",
      "client_secret": "cos_1NamBL2eZvKYlo2CP38sZVEW_secret_B5faamUkzHbcpjy6NndGq1mMZGGCo8FhK2P",
      "created": 1691010131,
      "kyc_details_provided": false,
      "livemode": true,
      "metadata": {},
      "redirect_url": null,
      "status": "initialized",
      "transaction_details": {
        "destination_amount": null,
        "destination_currencies": [
          "btc",
          "eth",
          "matic",
          "sol",
          "xlm",
          "avax",
          "usdc"
        ],
        "destination_currency": null,
        "destination_network": null,
        "destination_networks": [
          "bitcoin",
          "ethereum",
          "base",
          "polygon",
          "solana",
          "stellar",
          "avalanche"
        ],
        "fees": null,
        "lock_wallet_address": false,
        "source_amount": null,
        "source_currency": null,
        "transaction_id": null,
        "wallet_address": null,
        "wallet_addresses": null
      }
    }
  ]
}

Crypto Onramp Quotes

Crypto Onramp Quotes are estimated quotes for onramp conversions into all the different cryptocurrencies on different networks. The Quotes API allows you to display quotes in your product UI before directing the user to the onramp widget.

Related guide: Quotes API

Endpoints

GET/v1/crypto/onramp/quotes