Incrémenter une autorisation

Sur votre serveur, créez une session Checkout et attribuez la valeur embedded au paramètre ui_mode. Vous pouvez configurer la session Checkout pour qu’elle inclue les postes de facture et d’autres options, par exemple la devise.

Pour rediriger vos clients vers une page personnalisée hébergée sur votre site Web, spécifiez l’URL de cette page dans le paramètre return_url. Incluez la variable de modèle {CHECKOUT_SESSION_ID} dans l’URL pour récupérer l’état de la session sur la page de retour. Checkout remplace automatiquement la variable par l’ID de session Checkout avant la redirection.

En savoir plus sur la configuration de la page de retour et d’autres options pour personnaliser le comportement de redirection.

Après avoir créé la session Checkout, utilisez la client_secret renvoyée dans la réponse pour monter Checkout.

Pour activer la fonctionnalité d’autorisation complémentaire, définissez request_incremental_authorization sur if_available.

# This example sets up an endpoint using the Sinatra framework.
# To learn more about Sinatra, watch this video: https://youtu.be/8aA9Enb8NVc.
require 'json'
require 'sinatra'
require 'stripe'

# Set your secret key. Remember to switch to your live secret key in production.
# See your keys here: https://dashboard.stripe.com/apikeys
Stripe.api_key = 
'sk_test_BQokikJOvBiI2HlWgH4olfQ2'

post '/create-checkout-session' do
  session = Stripe::Checkout::Session.create({
    line_items: [{
      price_data: {
        currency: 'usd',
        product_data: {
          name: 'T-shirt',
        },
        unit_amount: 2000,
      },
      quantity: 1,
    }],
    mode: 'payment',
    ui_mode: 'embedded',
    payment_method_options: {
      card: {
        request_incremental_authorization: 'if_available',
      },
    },
    return_url: 'https://example.com/checkout/return?session_id={CHECKOUT_SESSION_ID}'
  })

  {clientSecret: session.client_secret}.to_json
end

Une fois que le client a terminé son paiement, le champ payment_method_details de l’objet latest_charge du PaymentIntent contient available ou unavailable en fonction du moyen de paiement du client et des critères de disponibilité mentionnés ci-dessus, qui détermine si un PaymentIntent est admissible pour une autorisation complémentaire. (Si vous n’avez pas demandé d’autorisation complémentaire lors de la création de la session CheckoutSession, celle-ci sera définie sur unavailable.)

{
  "id": "pi_ANipwO3zNfjeWODtRPIg",
  "object": "payment_intent",
  "amount": 1000,
  "amount_capturable": 1000,
  "amount_received": 0,
  ...
  // if latest_charge is expanded
  {
    "latest_charge": {
        "amount": 1000,
        "payment_method_details": {
          "card": {
            "incremental_authorization": {
                "status": "available" // or "unavailable"
            }
          }
        }
        ...
      }
  }

}

Pour augmenter le montant autorisé sur un PaymentIntent, utilisez l’endpoint increment_authorization et fournissez le total mis à jour du montant d’autorisation à ajouter. Ce montant doit être supérieur au montant initialement autorisé. Vous tentez ainsi d’autoriser un montant plus élevé sur la carte de votre client. Un même PaymentIntent peut appeler cet endpoint plusieurs fois pour augmenter à nouveau le montant autorisé.

Vous disposez au maximum de 10 tentatives d’autorisation complémentaire par PaymentIntent.

curl https://api.stripe.com/v1/payment_intents/{{PAYMENT_INTENT_ID}}/increment_authorization \
  -u 
sk_test_BQokikJOvBiI2HlWgH4olfQ2
: \
  -d "amount"=1500

Si l’autorisation complémentaire aboutit, elle renvoie l’objet PaymentIntent avec le montant mis à jour. Si l’autorisation échoue, une erreur card_declined est alors renvoyée. L’objet PaymentIntent peut toujours être capturé pour le montant précédemment autorisé. Toute modification éventuelle d’autres champs du PaymentIntent (par exemple, application_fee_amount, transfer_data, metadata, description et statement_descriptor) ne sera pas enregistrée en cas d’échec de l’autorisation complémentaire.

L’autorisation complémentaire est plafonnée à 500 USD (ou la somme équivalente dans la devise locale) au-dessus ou à 500 % du montant précédemment autorisé (selon le montant le plus élevé) pour chaque complément.

Vous devez capturer les fonds avant que l’autorisation initiale n’expire, que vous augmentiez ou non le montant autorisé d’un PaymentIntent avec une autorisation complémentaire. Les autorisations complémentaires ne prolongent pas la période de validité. Pour capturer le montant autorisé sur un PaymentIntent avec des autorisations complémentaires antérieures, utilisez l’endpoint capture de la manière habituelle.

curl https://api.stripe.com/v1/payment_intents/{{PAYMENT_INTENT_ID}}/capture \
  -u 
sk_test_BQokikJOvBiI2HlWgH4olfQ2
:

Si l’autorisation complémentaire aboutit, elle renvoie l’objet PaymentIntent capturé avec le montant mis à jour. Si l’autorisation échoue, une erreur card_declined est alors renvoyée. Le PaymentIntent n’est pas capturé, mais il peut toujours être capturé pour le montant précédemment autorisé. Toute modification éventuelle d’autres champs du PaymentIntent (par exemple, application_fee_amount, transfer_data, metadata, description et statement_descriptor) ne sera pas enregistrée en cas d’échec de l’autorisation complémentaire.

Utilisez la carte de test d’autorisation complémentaire avec n’importe quel CVC, code postal et date d’expiration postérieure à la date du jour pour déclencher des autorisations complémentaires pendant le test :

1. Commencez par créer la CheckoutSession à l’aide de la carte de test utilisée à l’étape Créer une CheckoutSession ci-dessus.

1. Exécutez l’autorisation complémentaire avec les paramètres spécifiés dans l’étape Exécuter l’autorisation complémentaire, puis utilisez la carte de test pour déclencher l’autorisation complémentaire.