Fonctions de l'API sur les remboursements

Créer un remboursement

Crée un remboursement pour un frais déjà créé mais pas encore remboursé. Le montant à rembourser peut être spécifié, ou le montant total de la charge peut être remboursé en ne spécifiant pas de montant. Le remboursement sera effectué dans la même devise que le prélèvement et selon le même mode de paiement que le prélèvement.

Si vous tentez de rembourser un montant qui a déjà été remboursé, une erreur sera renvoyée. Il en va de même si vous tentez de rembourser un montant supérieur au montant initial.

Point final : https://api.stripe.com/v1/refunds

Opération : POST

Exemples

cURL Exemple:

curl -X POST https://api.stripe.com/v1/refunds \
  -u <YOUR_SECRET_KEY>: \
  -d "charge=ch_1NirD82eZvKYlo2CIvbtLWuY"

Réponses

Les réponses renvoient des codes standard.

200 : OK

{
  "id" : "re_1Nispe2eZvKYlo2Cd31jOCgZ",
  "object" : "remboursement",
  "amount" : 212,
  "balance_transaction" : "txn_1Nispe2eZvKYlo2CYezqFhEx",
  "charge" : "ch_1NirD82eZvKYlo2CIvbtLWuY",
  "créé" : 1692942318,
  "currency" : "usd",
  "destination_details" : {
    "card" : {
      "référence" : "123456789012",
      "reference_status" : "disponible",
      "reference_type" : "numéro de référence de l'acquéreur",
      "type" : "remboursement"
    },
    "type" : "carte"
  },
  "metadata" : {},
  "payment_intent" : "pi_1GszsK2eZvKYlo2CfhZyoZLp",
  "reason" : null,
  "receipt_number" : null,
  "source_transfer_reversal" : null,
  "status" : "succeeded",
  "transfer_reversal" : 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	Montant à rembourser, en cents. Si aucun montant n'est spécifié, le montant total de la facture sera remboursé.
charge	chaîne de caractères	(Obligatoire) ID de la charge à rembourser.
currency	string	Code de devise ISO à trois lettres, en minuscules. Il doit s'agir d'une devise prise en charge. Si elle n'est pas spécifiée, c'est la devise du prélèvement qui sera utilisée.
expand[]	tableau de chaînes	Spécifie quels champs de la réponse doivent être développés.
customer	chaîne de caractères	ID du client auquel le prélèvement appartient.
reason	chaîne de caractères	Raison du remboursement. Si elle est définie, les valeurs possibles sont duplicate, fraudulent, ou requested_by_customer. Si la valeur est fraudulent, la carte et l'email associés au remboursement seront ajoutés à vos listes de blocage, et aideront à améliorer la détection des fraudes par Stripe.
payment_intent	string	ID du PaymentIntent à rembourser.
refund_application_fee	boolean	Indique si les frais de dossier doivent être remboursés. Si le montant total est remboursé, les frais de dossier seront également remboursés. Dans le cas contraire, les frais de dossier seront remboursés proportionnellement au remboursement. Les frais de dossier ne peuvent correspondre qu'à l'application à l'origine des frais.
origin	string	L'origine du remboursement.
reverse_transfer	booléen	Indique si le transfert doit être inversé. Le transfert est inversé proportionnellement au montant du remboursement (remboursement total ou partiel).
instructions_email	string	Utilise l'adresse email du client pour les instructions de remboursement lorsque la méthode de paiement sans support de remboursement est utilisée.

Mettre à jour un remboursement

Met à jour le remboursement spécifié en définissant les valeurs des paramètres passés. Tout paramètre non fourni sera laissé inchangé. Cette fonction est utile pour stocker des informations supplémentaires sur le remboursement.

Point de terminaison : https://api.stripe.com/v1/refunds/{id}

Opération : POST

Exemples

cURL Exemple:

curl -X POST `https://api.stripe.com/v1/refunds/{id}` \
  -u <YOUR_SECRET_KEY>: \
  -d "metadata[order_id]=6735"

Réponses

Les réponses renvoient des codes standard.

200 : OK

{
  "id" : "re_1Nispe2eZvKYlo2Cd31jOCgZ",
  "object" : "remboursement",
  "amount" : 1000,
  "balance_transaction" : "txn_1Nispe2eZvKYlo2CYezqFhEx",
  "charge" : "ch_1NirD82eZvKYlo2CIvbtLWuY",
  "créé" : 1692942318,
  "currency" : "usd",
  "destination_details" : {
    "card" : {
      "référence" : "123456789012",
      "reference_status" : "disponible",
      "reference_type" : "numéro de référence de l'acquéreur",
      "type" : "remboursement"
    },
    "type" : "carte"
  },
  "metadata" : {
    "order_id" : "6735"
  },
  "payment_intent" : "pi_1GszsK2eZvKYlo2CfhZyoZLp",
  "reason" : null,
  "receipt_number" : null,
  "source_transfer_reversal" : null,
  "status" : "succeeded",
  "transfer_reversal" : 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
metadata	object	Ensemble de paires clé-valeur que vous pouvez attacher à un objet. Cela peut être utile pour stocker des informations supplémentaires sur l'objet dans un format structuré.
expand[]	tableau de chaînes	Spécifie quels champs de la réponse doivent être développés.

Variables de chemin

Nom	Type	Obligatoire	Description
id	string	Required	L'ID du remboursement à mettre à jour.

Récupérer un remboursement

Permet de récupérer les détails d'un remboursement spécifique.

Point de terminaison : https://api.stripe.com/v1/refunds/{id}

Opération : GET

Exemples

cURL Exemple:

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

Réponses

Les réponses renvoient des codes standard.

200 : OK

{
  "id" : "re_1Nispe2eZvKYlo2Cd31jOCgZ",
  "object" : "remboursement",
  "amount" : 212,
  "balance_transaction" : "txn_1Nispe2eZvKYlo2CYezqFhEx",
  "charge" : "ch_1NirD82eZvKYlo2CIvbtLWuY",
  "créé" : 1692942318,
  "currency" : "usd",
  "destination_details" : {
    "card" : {
      "référence" : "123456789012",
      "reference_status" : "disponible",
      "reference_type" : "numéro de référence de l'acquéreur",
      "type" : "remboursement"
    },
    "type" : "carte"
  },
  "metadata" : {},
  "payment_intent" : "pi_1GszsK2eZvKYlo2CfhZyoZLp",
  "reason" : null,
  "receipt_number" : null,
  "source_transfer_reversal" : null,
  "status" : "succeeded",
  "transfer_reversal" : 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 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.

Variables de chemin

Nom	Type	Requis	Description
id	chaîne de caractères	Obligatoire	L'ID du remboursement à récupérer.

Liste de tous les remboursements

Renvoie une liste des remboursements existants. Les remboursements sont triés par ordre, les plus récents apparaissant en premier. Les 10 remboursements les plus récents sont affichés par défaut.

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

Opération : GET

Exemples

cURL Exemple:

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

Réponses

Les réponses renvoient des codes standard.

200 : OK

{
  "object" : "liste",
  "url" : "/v1/refunds",
  "has_more" : false,
  "data" : [
    {
      "id" : "re_1Nispe2eZvKYlo2Cd31jOCgZ",
      "object" : "remboursement",
      "amount" : 212,
      "balance_transaction" : "txn_1Nispe2eZvKYlo2CYezqFhEx",
      "charge" : "ch_1NirD82eZvKYlo2CIvbtLWuY",
      "créé" : 1692942318,
      "currency" : "usd",
      "destination_details" : {
        "card" : {
          "référence" : "123456789012",
          "reference_status" : "disponible",
          "reference_type" : "numéro de référence de l'acquéreur",
          "type" : "remboursement"
        },
        "type" : "carte"
      },
      "metadata" : {},
      "payment_intent" : "pi_1GszsK2eZvKYlo2CfhZyoZLp",
      "reason" : null,
      "receipt_number" : null,
      "source_transfer_reversal" : null,
      "status" : "succeeded",
      "transfer_reversal" : null
    }
  ]
}

400 : Bad Request

{
    "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 : Non autorisé

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

Paramètres

Paramètre	Type	Description
charge	chaîne de caractères	ID de la charge pour laquelle les remboursements doivent être récupérés. S'il n'est pas spécifié, tous les remboursements seront renvoyés.
created	dictionnaire	Retourne les remboursements créés uniquement pendant les intervalles de dates donnés. Il peut s'agir d'un dictionnaire avec les clés suivantes : gt, gte, lt, lte.
ending_before	string	Un curseur à utiliser dans la pagination. Utilisez l'ID de l'objet ending_before pour définir votre place dans la liste. Si vous faites une requête de liste et recevez 100 résultats, commençant par obj_bar, votre appel suivant peut inclure ending_before=obj_bar pour récupérer la page précédente de la liste.
limit	integer	Une limite sur le nombre d'objets à retourner. Limit peut être compris entre 1 et 100. La valeur par défaut est 10.
payment_intent	string	ID du PaymentIntent pour lequel les remboursements doivent être récupérés. S'il n'est pas spécifié, tous les remboursements seront retournés.
starting_after	chaîne de caractères	Un curseur à utiliser dans la pagination. Utilisez l'ID d'objet starting_after pour définir votre place dans la liste. Si vous faites une requête de liste et recevez 100 résultats, se terminant par 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	Spécifie quels champs de la réponse doivent être développés.