The Crypto Onramp Quote object

Attributes

  • idstring

    Unique identifier for the object.

  • objectstring

    String representing the object’s type. Objects of the same type share the same value.

  • destination_network_quotesobject

    A list of destination cryptocurrency networks we can generate quotes for current as of created. We currently support: {ethereum, solana, polygon, bitcoin}

  • livemodeboolean

    Has the value true if the object exists in live mode or the value false if the object exists in test mode.

  • rate_fetched_atfloat

    The time at which this quote was created (when the prices in quotes are applicable)

  • source_amountstring

    The amount of fiat we intend to onramp

  • source_currencyenum

    A fiat currency code

The Crypto Onramp Quote object
{
"id": "daedac668e8555a2122974117110bf51e9327a0f30a40fe4bca9caf7c627a72f",
"object": "crypto.onramp.quotes",
"destination_network_quotes": {
"bitcoin": [
{
"destination_amount": "0.00371071",
"destination_currency": "btc",
"destination_network": "bitcoin",
"fees": {
"network_fee_monetary": "1.36",
"transaction_fee_monetary": "7.03"
},
"source_total_amount": "108.39"
}
],
"ethereum": [
{
"destination_amount": "0.057593733801762368",
"destination_currency": "eth",
"destination_network": "ethereum",
"fees": {
"network_fee_monetary": "0.63",
"transaction_fee_monetary": "7.02"
},
"source_total_amount": "107.65"
},
{
"destination_amount": "100.00",
"destination_currency": "usdc",
"destination_network": "ethereum",
"fees": {
"network_fee_monetary": "1.36",
"transaction_fee_monetary": "7.03"
},
"source_total_amount": "108.39"
}
],
"polygon": [
{
"destination_amount": "161.290322600000000000",
"destination_currency": "matic",
"destination_network": "polygon",
"fees": {
"network_fee_monetary": "0.01",
"transaction_fee_monetary": "7.02"
},
"source_total_amount": "107.03"
},
{
"destination_amount": "100.00",
"destination_currency": "usdc",
"destination_network": "polygon",
"fees": {
"network_fee_monetary": "0.01",
"transaction_fee_monetary": "7.02"
},
"source_total_amount": "107.03"
}
],
"solana": [
{
"destination_amount": "6.203473945",
"destination_currency": "sol",
"destination_network": "solana",
"fees": {
"network_fee_monetary": "0.01",
"transaction_fee_monetary": "7.02"
},
"source_total_amount": "107.03"
},
{
"destination_amount": "100.00",
"destination_currency": "usdc",
"destination_network": "solana",
"fees": {
"network_fee_monetary": "0.01",
"transaction_fee_monetary": "7.02"
},
"source_total_amount": "107.03"
}
]
},
"livemode": false,
"rate_fetched_at": 1691186843.8762703,
"source_amount": "100.00",
"source_currency": "usd"
}

Retrieve CryptoOnrampQuotes

Retrieves CryptoOnrampQuotes.

Related guide: Quotes API

Parameters

  • destination_amountstring

    A string representation of the amount of destination_currency to be purchased. If destination_amount is set, source_amount must be null. When specifying this field, you must also set a single value for destination_currencies and a single value for destination_networks (so we know what cryptocurrency to quote).

  • destination_currenciesarray of enums

    The list of cryptocurrencies you want to generate quotes for. If left null, we retrieve quotes for all destination_currencies that destination_networks supports.

    Currencies: btc, eth, sol, matic, usdc

  • destination_networksarray of enums

    The list of cryptocurrency networks you want to generate quotes for. If left null, we retrieve quotes for destination_currencies in all networks.

    Networks: bitcoin, ethereum, solana, polygon

  • source_amountstring

    A string representation of the fiat amount that you need to onramp. If source_amount is set, destination_amount must be null (they’re mutually exclusive because you can only set a fixed amount for one end of the trade).

  • source_currencyenum

    The ISO-4217 Currency code. We only support usd currently.

Returns

Returns the CryptoOnrampQuotes object

GET /v1/crypto/onramp/quotes
cURL
curl https://api.stripe.com/v1/crypto/onramp/quotes \
-u "sk_test_4eC39Hq...arjtT1zdp7dcsk_test_4eC39HqLyjWDarjtT1zdp7dc:"
Response
{
"id": "daedac668e8555a2122974117110bf51e9327a0f30a40fe4bca9caf7c627a72f",
"object": "crypto.onramp.quotes",
"destination_network_quotes": {
"bitcoin": [
{
"destination_amount": "0.00371071",
"destination_currency": "btc",
"destination_network": "bitcoin",
"fees": {
"network_fee_monetary": "1.36",
"transaction_fee_monetary": "7.03"
},
"source_total_amount": "108.39"
}
],
"ethereum": [
{
"destination_amount": "0.057593733801762368",
"destination_currency": "eth",
"destination_network": "ethereum",
"fees": {
"network_fee_monetary": "0.63",
"transaction_fee_monetary": "7.02"
},
"source_total_amount": "107.65"
},
{
"destination_amount": "100.00",
"destination_currency": "usdc",
"destination_network": "ethereum",
"fees": {
"network_fee_monetary": "1.36",
"transaction_fee_monetary": "7.03"
},
"source_total_amount": "108.39"
}
],
"polygon": [
{
"destination_amount": "161.290322600000000000",
"destination_currency": "matic",
"destination_network": "polygon",
"fees": {
"network_fee_monetary": "0.01",
"transaction_fee_monetary": "7.02"
},
"source_total_amount": "107.03"
},
{
"destination_amount": "100.00",
"destination_currency": "usdc",
"destination_network": "polygon",
"fees": {
"network_fee_monetary": "0.01",
"transaction_fee_monetary": "7.02"
},
"source_total_amount": "107.03"
}
],
"solana": [
{
"destination_amount": "6.203473945",
"destination_currency": "sol",
"destination_network": "solana",
"fees": {
"network_fee_monetary": "0.01",
"transaction_fee_monetary": "7.02"
},
"source_total_amount": "107.03"
},
{
"destination_amount": "100.00",
"destination_currency": "usdc",
"destination_network": "solana",
"fees": {
"network_fee_monetary": "0.01",
"transaction_fee_monetary": "7.02"
},
"source_total_amount": "107.03"
}
]
},
"livemode": false,
"rate_fetched_at": 1691186843.8762703,
"source_amount": "100.00",
"source_currency": "usd"
}

Climate Order

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

Climate Product

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

Forwarding Request

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.

Webhook 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

Stripe Shell
Test mode
Welcome to the Stripe Shell! Stripe Shell is a browser-based shell with the Stripe CLI pre-installed. Log in to your Stripe account and press Control + Backtick (`) on your keyboard to start managing your Stripe resources in test mode. - View supported Stripe commands: - Find webhook events: - Listen for webhook events: - Call Stripe APIs: stripe [api resource] [operation] (e.g., )
The Stripe Shell is best experienced on desktop.
$