Répertorier tous les remboursements
Renvoie une liste des remboursements existants. Stripe affiche les remboursements par ordre chronologique inverse, en faisant apparaître les entrées les plus récentes en premier. La réponse inclut par défaut les 10 remboursements les plus récents.
GET https://api.stripe.com/v1/refunds
Exemples
Exemple cURL :
cURL
curl -X GET https://api.stripe.com/v1/refunds \
-u <YOUR_SECRET_KEY>:
Réponses
Les réponses renvoient des codes standard.
200: OK
Response
{
"object": "list",
"url": "/v1/refunds",
"has_more": false,
"data": [
{
"id": "re_1Nispe2eZvKYlo2Cd31jOCgZ",
"object": "refund",
"amount": 212,
"balance_transaction": "txn_1Nispe2eZvKYlo2CYezqFhEx",
"charge": "ch_1NirD82eZvKYlo2CIvbtLWuY",
"created": 1692942318,
"currency": "usd",
"destination_details": {
"card": {
"reference": "123456789012",
"reference_status": "available",
"reference_type": "acquirer_reference_number",
"type": "refund"
},
"type": "card"
},
"metadata": {},
"payment_intent": "pi_1GszsK2eZvKYlo2CfhZyoZLp",
"reason": null,
"receipt_number": null,
"source_transfer_reversal": null,
"status": "succeeded",
"transfer_reversal": null
}
]
}
Réponses d'erreur
400: Bad Request
Response
{
"error": {
"code": "resource_missing",
"doc_url": "https://stripe.com/docs/error-codes/resource-missing",
"message": "No such charge: 'ch_1NirD82eZvKYlo2CIvbtLWuY'",
"param": "charge",
"request_log_url": "https://dashboard.stripe.com/test/logs/req_HIH2jWkJGecwCk?t=1754504399",
"type": "invalid_request_error"
}
}
401: Unauthorized
Response
{
"error": {
"type": "invalid_request_error",
"message": "Invalid API Key provided: sk_test_********************1234"
}
}
Paramètres
Paramètres de requête
| Paramètre | Type | Description |
|---|---|---|
charge | chaîne | Identifiant de la transaction pour laquelle récupérer les remboursements. S'il est omis, Stripe renvoie tous les remboursements du compte. |
created | dictionnaire | Renvoie uniquement les remboursements créés au cours des intervalles de dates indiqués. Il peut s'agir d'un dictionnaire comportant les clés suivantes : gt, gte, lt, lte. |
ending_before | chaîne | Un curseur à utiliser pour la pagination. Utilisez l'ID d'objet ending_before pour définir votre position dans la liste. Si vous effectuez une requête de liste et recevez 100 résultats, à partir de obj_bar, votre appel suivant peut inclure ending_before=obj_bar pour récupérer la page précédente de la liste. |
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). |
payment_intent | chaîne | Identifiant du PaymentIntent pour lequel récupérer les remboursements. S'il est omis, Stripe renvoie tous les remboursements du compte. |
starting_after | chaîne | Curseur à utiliser pour la pagination. Utilisez l’ID d’objet starting_after pour définir votre position dans la liste. Si vous effectuez une requête de liste et recevez 100 résultats, dont le dernier est obj_foo, votre appel suivant peut inclure starting_after=obj_foo pour récupérer la page suivante de la liste. |
expand[] | tableau de chaînes | Identifie les objets de réponse imbriqués à enrichir et à renvoyer en ligne. |