Mettre à niveau votre intégration de rampe d'accèsBêta

Découvrez les changements de l'API lors de la mise à niveau de votre intégration bêta de la rampe d'accès.

Mise en garde

Suivez ce guide si vous avez intégré l’API de la rampe d’accès avant le 2023-06-21.

Nous avons apporté des modifications à l’API de la rampe d’accès à la cryptomonnaie Stripe dans le cadre de notre version publique. Si vous avez intégré onramp avant le 2023-06-21, vous avez intégré la version bêta de l’API de la rampe d’accès.

Ce guide décrit les modifications apportées, leur impact sur les intégrations existantes et les instructions de migration vers cette dernière version.

Modifications par rapport à la version bêta de la rampe d’accès

Réduction de transaction_details dans le corps de requête POST /v1/crypto/onramp_sessions de niveau supérieur
Les champs suivants ont été renommés dans les requêtes et les ressources de l’API Onramp
- supported_destination_currencies est désormais destination_currencies
- supported_destination_networks est désormais destination_networks
- source_exchange_amount est désormais source_amount
- destination_exchange_amount est désormais destination_amount
Modification du chemin d’accès aux devis de rampe d’accès de /v1/crypto/onramp/quotes en /v1/crypto/onramp_quotes

Voici des exemples de changements apportés dans les requêtes et les réponses de la rampe d’accès :

Récupérer un devis de rampe d’accès

Pour récupérer un devis de rampe d’accès, exécutez une commande comme celle-ci :

Command Line
curl -G https://api.stripe.com/v1/crypto/onramp_quotes \
curl -G https://api.stripe.com/v1/crypto/onramp/quotes \
  -usk_test_4eC39HqLyjWDarjtT1zdp7dc
: \
  -H "Stripe-Version: 2024-11-20.acacia;crypto_onramp_beta=v2" \
  -d "source_amount"="200" \
  -d "source_exchange_amount"="200" \

Vous recevez une réponse semblable à ce qui suit :

{
  "id": "2e5818944df6a2325c7e9c1e72d27174b9bedfc8e64ace47c081370a5b982a7b",
  "rate_fetched_at": 1674265506.3408287,
  "destination_network_quotes": {
    "ethereum": [
      {
        "id": "d160a80828eabb6b6d4aeafac585eee62d95425c7fb7577866ab04b9a786df00",
        "destination_currency": "eth",
        "destination_amount": "0.253568242640499553",
        "destination_exchange_amount": "0.253568242640499553",
        "destination_network": "ethereum",
        "fees": {
          "network_fee_monetary": "1.45",
          "transaction_fee_monetary": "12.71"
        },
        "source_total_amount": "214.20"
      },
      {
        "id": "53f864cb28a42f11e1d9d5aff7e43ac96b056406f74cbf618399c6fa40f3d275",
        "destination_currency": "usdc",
        "destination_amount": "200.00",
        "destination_exchange_amount": "200.00",
        "destination_network": "ethereum",
        "fees": {
          "network_fee_monetary": "5.80",
          "transaction_fee_monetary": "12.76"
        },
        "source_total_amount": "218.56"
      }
    ],
    ...
  },
  "livemode": true,
  "source_currency": "usd",
  "source_amount": "200.00",
  "source_exchange_amount": "200.00"
}

Création d’une session de rampe d’accès

Pour créer une session de rampe d’accès, exécutez une commande comme celle-ci :

Command Line
curl -X POST https://api.stripe.com/v1/crypto/onramp_sessions \
  -usk_test_4eC39HqLyjWDarjtT1zdp7dc
: \
  -H "Stripe-Version: 2024-11-20.acacia;crypto_onramp_beta=v2" \
  -d "wallet_addresses[ethereum]"="0xB00F0759DbeeF5E543Cc3E3B07A6442F5f3928a2" \
  -d "source_currency"="usd" \
  -d "destination_amount"="0.1" \
  -d "destination_currency"="eth" \
  -d "destination_network"="ethereum" \
  -d "destination_currencies[]"="eth" \
  -d "destination_networks[]"="ethereum" \
  -d "transaction_details[wallet_addresses][ethereum]"="0xB00F0759DbeeF5E543Cc3E3B07A6442F5f3928a2" \
  -d "transaction_details[source_currency]"="usd" \
  -d "transaction_details[destination_exchange_amount]"="10" \
  -d "transaction_details[destination_currency]"="eth" \
  -d "transaction_details[destination_network]"="ethereum" \
  -d "transaction_details[supported_destination_currencies][]"="eth" \
  -d "transaction_details[supported_destination_networks][]"="ethereum"

Vous recevez une réponse semblable à ce qui suit :

{
  "id": "cos_0MYvv9589O8KAxCGPm84FhVR",
  "object": "crypto.onramp_session",
  "client_secret": "cos_0MYvv9589O8KAxCGPm84FhVR_secret_IGBYKVlTlnJL8UGxji48pKxBO00deNcBuVc",
  "created": 1675794575,
  "livemode": false,
  "status": "initialized",
  "transaction_details": {
    "destination_currency": "eth",
    "destination_network": "ethereum",
    "fees": null,
    "lock_wallet_address": false,
    "source_currency": "usd",
    "source_amount": null,
    "destination_amount": "0.100000000000000000",
    "destination_currencies": [
      "eth"
    ],
    "destination_networks": [
      "ethereum"
    ],
    "source_exchange_amount": null,
    "destination_exchange_amount": "0.100000000000000000",
    "supported_destination_currencies": [
      "eth"
    ],
    "supported_destination_networks": [
      "ethereum"
    ],
    "transaction_id": null,
    "wallet_address": null,
    "wallet_addresses": {
      "bitcoin": null,
      "ethereum": "0xB00F0759DbeeF5E543Cc3E3B07A6442F5f3928a2",
      "polygon": null,
      "solana": null,
      "stellar": null,
      "destination_tags": null
    }
  }
}

Impact sur les intégrations existantes

Nous avons publié ces changements de manière à ne pas rompre les intégrations bêta existantes. Si vous rencontrez des problèmes avec votre intégration, veuillez contacter le service d’assistance Stripe.

Migrer depuis la version bêta vers la dernière version de la rampe d’accès

Erreur fréquente

Suivez cette section uniquement si :

Stripe a approuvé votre demande d’inscription à la rampe d’accès avant le 2023-06-21.
Vous avez intégré la rampe d’accès avant le 2023-06-21.

Dans le cas contraire, ces instructions ne vous concernent pas, car vous utilisez déjà la version la plus récente de la rampe d’accès.

Compatibilité des versions

Bêta

Si vous souhaitez mettre à niveau la version de votre API, commencez par spécifier crypto_onramp_beta=v2 dans l’en-tête Stripe-Version de vos requêtes.

Les intégrations bêta peuvent désormais transmettre une version crypto_onramp_beta dans l’en-tête Stripe-Version pour utiliser la version bêta ou la dernière version de l’API de la rampe d’accès. Utilisez la matrice suivante pour déterminer le comportement attendu en fonction de l’en-tête Stripe-Version transmis.

Version	En-tête	Comportement attendu de l’API
non spécifiée	`Stripe-Version: 2024-11-20.acacia`	bêta
`v1`	`Stripe-Version: 2024-11-20.acacia;crypto_onramp_beta=v1`	bêta
`v2`	`Stripe-Version: 2024-11-20.acacia;crypto_onramp_beta=v2`	la plus récente

Si vous souhaitez mettre à niveau la version de votre API, commencez par spécifier crypto_onramp_beta=v2 dans l’en-tête Stripe-Version de vos requêtes.