Fonctions de l'API Payment Intent

Liste de toutes les intentions de paiement

Renvoie une liste des intentions de paiement.

Point d'arrivée : https://api.stripe.com/v1/payment_intents

Opération : GET

Exemples

cURL Exemple:

curl -X GET https://api.stripe.com/v1/payment_intents \
  -u <YOUR_SECRET_KEY>:

Réponses

Les réponses renvoient des codes standard.

200 : OK

{
  "object" : "liste",
  "data" : [
    {
      "id" : "pi_1234567890",
      "object" : "payment_intent",
      "amount" : 1000,
      "currency" : "usd",
      "status" : "requires_confirmation"
    }
  ],
  "has_more" : false,
  "url" : "/v1/payment_intents"
}

400 : Bad Request

{
  "error" : {
    "message" : "Si vous passez un tableau avec des clés explicites (par exemple foo[0]=a&foo[1]=b) au lieu d'un tableau (par exemple foo[]=a&foo[]=b), les clés doivent être numériques et séquentielles en commençant par 0. Vous avez passé les clés `1`, nous nous attendions à avoir une clé avec la valeur `0`.",
    "param" : "expand",
    "request_log_url" : "https://dashboard.stripe.com/test/logs/req_kCeAL5FAly5bkh?t=1734734555",
    "type" : "invalid_request_error"
  }
}

401 : Non autorisé

{
  "error" : {
    "type" : "invalid_request_error",
    "message" : "Invalid API Key provided : sk_test_********************1234"
  }
}

Paramètres

Paramètres de la requête

Paramètre	Type	Description
`limit`	integer	Une limite sur le nombre d'objets à renvoyer. La limite peut être comprise entre 1 et 100, et la valeur par défaut est 10.
`starting_after`	string	Un curseur à utiliser dans la pagination. `starting_after` est un identifiant d'objet qui définit votre place dans la liste.
`ending_before`	chaîne de caractères	Un curseur à utiliser dans la pagination. `ending_before` est un identifiant d'objet qui définit votre place dans la liste.
`expand[]`	tableau de chaînes	Spécifie quels champs de la réponse doivent être développés.

Créer une intention de paiement

Une fois qu'une intention de paiement a été créée, il convient d'y associer une méthode de paiement et de la confirmer pour poursuivre le paiement.

L'utilisation de confirm=true lors de la création est équivalente à la création et à la confirmation de l'intention de paiement dans le même appel. L'application de confirm=true permet d'utiliser tous les paramètres de l'API confirm.

Point de terminaison : https://api.stripe.com/v1/payment_intents

Operation : POST

remarque

La requête confirm doit être effectuée via HTTPS.

Exemples

cURL Exemple:

curl -X POST https://api.stripe.com/v1/payment_intents \
  -u <YOUR_SECRET_KEY>: \
  -d "amount=212&currency=usd&payment_method=pm_card_visa&confirm=true"

Réponses

Les réponses renvoient des codes standard.

200 : OK

{
    "id" : "pi_3Rsx4dDtWMrPDtgt0mUrePJ9",
    "object" : "payment_intent",
    "amount" : 212,
    "amount_capturable" : 0,
    "amount_details" : {
        "tip" : {}
    },
    "amount_received" : 0,
    "application" : null,
    "application_fee_amount" : null,
    "automatic_payment_methods" : {
        "allow_redirects" : "always",
        "enabled" : true
    },
    "canceled_at" : null,
    "cancellation_reason" : null,
    "capture_method" : "automatic_async",
    "client_secret" : "pi_3Rsx4dDtWMrPDtgt0mUrePJ9_secret_7sqfufxuIYiBhbw52Vi51Z47o",
    "confirmation_method" : "automatique",
    "created" : 1754447247,
    "currency" : "usd",
    "client" : null,
    "description" : null,
    "last_payment_error" : null,
    "latest_charge" : null,
    "livemode" : false,
    "metadata" : {},
    "next_action" : null,
    "on_behalf_of" : null,
    "payment_method" : null,
    "payment_method_configuration_details" : {
        "id" : "pmc_1RsGk1DtWMrPDtgtcaQ0d3Sg",
        "parent" : null
    },
    "payment_method_options" : {
        "amazon_pay" : {
            "express_checkout_element_session_id" : null
        },
        "card" : {
            "installments" : null,
            "options_mandat" : null,
            "réseau" : null,
            "demande_trois_d_sécurité" : "automatique"
        },
        "cashapp" : {},
        "klarna" : {
            "preferred_locale" : null
        },
        "link" : {
            "persistent_token" : null
        }
    },
    "payment_method_types" : [
        "card",
        "klarna",
        "link",
        "cashapp",
        "amazon_pay"
    ],
    "processing" : null,
    "receipt_email" : null,
    "review" : null,
    "setup_future_usage" : null,
    "shipping" : null,
    "source" : null,
    "statement_descriptor" : null,
    "statement_descriptor_suffix" : null,
    "status" : "requires_payment_method",
    "transfer_data" : null,
    "transfer_group" : null
}

400 : Bad Request

{
  "error" : {
    "code" : "parameter_invalid_integer",
    "doc_url" : "https://stripe.com/docs/error-codes/parameter-invalid-integer",
    "message" : "Invalid integer : <integer>",
    "param" : "amount",
    "request_log_url" : "https://dashboard.stripe.com/test/logs/req_UQf6XBwBl9yk66?t=1734829676",
    "type" : "invalid_request_error"
  }
}

401 : Non autorisé

{
  "error" : {
    "type" : "invalid_request_error",
    "message" : "Invalid API Key provided : sk_test_********************1234"
  }
}

Paramètres

Paramètres du corps

Paramètre	Type	Description
`amount`	integer	(Obligatoire) Montant à collecter. Un nombre entier positif représentant le montant à prélever dans la plus petite unité monétaire (par exemple, 100 cents pour prélever 1,00 $).
`currency`	string	(Required) Code ISO à trois lettres de la devise, en minuscules. Il doit s'agir d'une devise prise en charge.
`confirm`	booléen	Mettre à true pour essayer de confirmer ce PaymentIntent immédiatement.
`customer`	string	ID du client auquel appartient ce PaymentIntent, s'il existe.
`description`	string	Une chaîne arbitraire attachée à l'objet.
`payment_method`	string	ID de la méthode de paiement à attacher à ce PaymentIntent.
`payment_method_types[]`	tableau de chaînes	La liste des types de méthodes de paiement que ce PaymentIntent peut utiliser.
`shipping`	objet	Informations sur l'expédition pour le PaymentIntent.
`statement_descriptor`	string	Une chaîne arbitraire affichée sur le relevé de carte de crédit de votre client.
`statement_descriptor_suffix`	chaîne de caractères	Fournit des détails supplémentaires affichés sur le relevé de carte de crédit de votre client.
`expand[]`	tableau de chaînes	Spécifie quels champs de la réponse doivent être développés.

Rechercher les intentions de paiement

En utilisant le langage de recherche de Stripe, vous pouvez rechercher des intentions de paiement précédemment créées.

N'utilisez pas la requête de recherche dans les flux de lecture après écriture où une cohérence stricte est nécessaire. En fonctionnement normal, les données sont consultables pendant moins d'une minute. Il peut arriver que la propagation de données nouvelles ou mises à jour accuse un retard pouvant aller jusqu'à une heure en cas d'interruption de service.

remarque

La fonction de recherche n'est pas disponible pour les commerçants en Inde.

Point final : https://api.stripe.com/v1/payment_intents/search

Opération : GET

Exemples

cURL Exemple:

curl -X GET "https://api.stripe.com/v1/payment_intents/search?query=amount:1000" \
  -u <YOUR_SECRET_KEY>:

Réponses

Les réponses renvoient des codes standard.

200 : OK

{
  "object" : "search_result",
  "data" : [],
  "has_more" : false,
  "next_page" : null,
  "url" : "/v1/payment_intents/search"
}

400 : Bad Request

{
  "error" : {
    "code" : "parameter_invalid_string",
    "doc_url" : "https://stripe.com/docs/error-codes/parameter-invalid-string",
    "message" : "Provide a query parameter with a valid search query string",
    "param" : "query",
    "type" : "invalid_request_error"
  }
}

401 : Non autorisé

{
  "error" : {
    "type" : "invalid_request_error",
    "message" : "Invalid API Key provided : sk_test_********************1234"
  }
}

Paramètres

Paramètres de la requête

Paramètre	Type	Description
`expand[]`	tableau de chaînes	Spécifie quels champs de la réponse doivent être développés.
`limit`	entier	Limite du nombre d'objets à renvoyer. Limit peut être compris entre 1 et 100, et la valeur par défaut est 10.
`page`	chaîne de caractères	Un curseur pour la pagination sur plusieurs pages de résultats. N'incluez pas ce paramètre lors du premier appel. Utilisez la valeur `next_page` renvoyée dans une réponse précédente pour demander les résultats suivants.
`query`	string	(Requis) La chaîne de la requête de recherche. Voir le langage de requête de recherche et la liste des champs de requête pris en charge pour les intentions de paiement.

Liste de toutes les intentions de paiement​

Exemples​

Réponses​

Paramètres​

Paramètres de la requête​

Créer une intention de paiement​

Exemples​

Réponses​

Paramètres​

Paramètres du corps​

Rechercher les intentions de paiement​

Exemples​

Réponses​

Paramètres​

Paramètres de la requête​

Liste de toutes les intentions de paiement

Exemples

Réponses

Paramètres

Paramètres de la requête

Créer une intention de paiement

Exemples

Réponses

Paramètres

Paramètres du corps

Rechercher les intentions de paiement

Exemples

Réponses

Paramètres

Paramètres de la requête