The Crypto Onramp Session object 

Attributes

• idstring

  Unique identifier for the object.

• objectstring

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

• client_secretstring

  A client secret that can be used to drive a single session using our embedded widget.

  Related guide: Set up an onramp integration

• createdtimestamp

  Time at which the object was created. Measured in seconds since the Unix epoch.

• kyc_details_providedboolean

  Has the value true if any user kyc details were provided during the creation of the onramp session. Otherwise, has the value false.

• livemodeboolean

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

• metadatanullable object

  Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.

• redirect_urlnullable string

  Redirect your users to the URL for a prebuilt frontend integration of the crypto onramp on the standalone hosted onramp.

  Related guide: Mint a session with a redirect url

• statusstring

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

• transaction_detailsobject

  A hash representing monetary details of the transaction this session represents.

  Hide child attributes

  • transaction_details.destination_amountnullable string

    The amount of crypto the customer will get deposited into their wallet

  • transaction_details.destination_currenciesnullable array of enums

    If a platform wants to lock the currencies an session will support, they can add supported currencies to this array. If left null, the experience will allow selection of all supported destination currencies.

  • transaction_details.destination_currencynullable enum

    The selected destination_currency to convert the source to. This should be a crypto currency code. If supported_destination_currencies is set, it must be a value in that array.

  • transaction_details.destination_networknullable enum

    The specific crypto network the destination_currency is settled on. If supported_destination_networks is set, it must be a value in that array.

  • transaction_details.destination_networksnullable array of enums

    If a platform wants to lock the supported networks, they can do so through this array. If left null, the experience will allow selection of all supported networks.

  • transaction_details.feesnullable object

    Details about the fees associated with this transaction

    Hide child attributes

    • transaction_details.fees.network_fee_amountnullable string

      The cost associated with moving crypto from Stripe to the end consumer’s wallet. e.g: for ETH, this is called ‘gas fee’, for BTC this is a ‘miner’s fee’.

    • transaction_details.fees.transaction_fee_amountnullable string

      Fee for processing the transaction.

  • transaction_details.lock_wallet_addressnullable boolean

    Whether or not to lock the suggested wallet address.

  • transaction_details.source_amountnullable string

    The amount of fiat we intend to onramp - excluding fees

  • transaction_details.source_currencynullable enum

    A fiat currency code

  • transaction_details.transaction_idnullable string

    The transaction id of the transaction that was sent to the customer’s wallet. This will only be set if the sessions hits the status=fulfillment_complete and we’ve transferred the crypto successfully to the external wallet. e.g: https://etherscan.io/tx/0xc2573af6b3a18e6f7c0e1cccc187a483f61d72cbb421f7166970d3ab45731a95

  • transaction_details.wallet_addressnullable string

    The consumer’s wallet address (where crypto will be sent to)

  • transaction_details.wallet_addressesnullable object

    The end customer’s crypto wallet address (for each network) to use for this transaction.

    Hide child attributes

    • transaction_details.wallet_addresses.base_networknullable stringPreview feature

      A base address

    • transaction_details.wallet_addresses.bitcoinnullable string

      A bitcoin address

    • transaction_details.wallet_addresses.destination_tagsnullable object

      The end customer’s crypto wallet destination tag (for each network) to use for this transaction.

      Hide child attributes

      • transaction_details.wallet_addresses.destination_tags.stellarnullable stringPreview feature

        A stellar destination tag

    • transaction_details.wallet_addresses.ethereumnullable string

      An ethereum address

    • transaction_details.wallet_addresses.optimismnullable stringPreview feature

      An optimism address

    • transaction_details.wallet_addresses.polygonnullable string

      A polygon address

    • transaction_details.wallet_addresses.solananullable string

      A solana address

    • transaction_details.wallet_addresses.stellarnullable stringPreview feature

      A stellar address

    • transaction_details.wallet_addresses.worldchainnullable stringPreview feature

      A worldchain address