Core Resources
Payment Methods
Products
Checkout
Payment Links
Billing
Capital
Connect
Reserves
Fraud
Issuing
Terminal
Treasury
Entitlements
Sigma
Reporting
Financial Connections
Tax
Identity
Crypto
Climate
Forwarding
Privacy
Webhooks

List CryptoOnrampSessions 

Crypto
Crypto Onramp Session
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.

    • created.gtinteger

      Minimum value to filter by (exclusive)

    • created.gteinteger

      Minimum value to filter by (inclusive)

    • created.ltinteger

      Maximum value to filter by (exclusive)

    • created.lteinteger

      Maximum value to filter by (inclusive)

  • 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 -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
      }
    }
  ]
}