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
cURL
curl -G https://api.stripe.com/v1/crypto/onramp_sessions \
-u "sk_test_4eC39Hq...arjtT1zdp7dcsk_test_4eC39HqLyjWDarjtT1zdp7dc:" \
-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 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

Orders represent your intent to purchase a particular Climate product. When you create an order, the payment is deducted from your merchant balance.

A Climate product represents a type of carbon removal unit available for reservation. You can retrieve it to see the current price and availability.

Instructs Stripe to make a request on your behalf using the destination URL. The destination URL is activated by Stripe at the time of onboarding. Stripe verifies requests with your credentials provided during onboarding, and injects card details from the payment_method into the request.

Stripe redacts all sensitive fields and headers, including authentication credentials and card numbers, before storing the request and response data in the forwarding Request object, which are subject to a 30-day retention period.

You can provide a Stripe idempotency key to make sure that requests with the same key result in only one outbound request. The Stripe idempotency key provided should be unique and different from any idempotency keys provided on the underlying third-party request.

Forwarding Requests are synchronous requests that return a response or time out according to Stripe’s limits.

Related guide: Forward card details to third-party API endpoints.

You can configure webhook endpoints via the API to be notified about events that happen in your Stripe account or connected accounts.

Most users configure webhooks from the dashboard, which provides a user interface for registering and testing your webhook endpoints.

Related guide: Setting up webhooks