Rechercher des intents de paiement
Grâce au langage de requête de recherche (Search Query Language) de Stripe, vous pouvez rechercher des « Payment Intents » créés précédemment.
Évitez les requêtes de recherche dans les pipelines de type « lecture après écriture » qui nécessitent une cohérence immédiate des données. En conditions normales de fonctionnement, les données sont consultables en moins d’une minute. Il peut toutefois arriver, en cas de panne, que la propagation des données nouvelles ou mises à jour accuse un retard pouvant aller jusqu’à une heure.
La fonction de recherche n'est pas disponible pour les commerçants en Inde.
GET https://api.stripe.com/v1/payment_intents/search
Exemples
Exemple cURL :
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,
"url": "/v1/payment_intents/search"
}
Réponses d'erreur
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: Unauthorized
{
"error": {
"type": "invalid_request_error",
"message": "Invalid API Key provided: sk_test_********************1234"
}
}
Paramètres
Paramètres de requête
| Paramètre | Type | Description |
|---|---|---|
expand[] | tableau de chaînes | Identifie les objets de réponse imbriqués à enrichir et à renvoyer en ligne. |
limit | entier | Limite le nombre d'enregistrements dans la réponse. Entrez un nombre entier compris entre 1 et 100 (valeur par défaut : 10). |
page | chaîne | Curseur permettant de parcourir 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 | chaîne | (Obligatoire) La chaîne de requête de recherche. Consultez la section consacrée au langage de requête de recherche et la liste des champs de requête pris en charge pour les intentions de paiement. |