API : remboursements

L'API des remboursements vous permet d'effectuer et de récupérer des remboursements sur les commandes de votre boutique. Un remboursement est toujours rattaché à une seule commande, c'est pourquoi les remboursements sont créés et listés sous le jeton d'une commande. Les requêtes sont authentifiées avec votre clé API secrète, transmise comme nom d'utilisateur en authentification HTTP Basic avec un mot de passe vide. Avec curl : -u {API_KEY}:. Voir Authentification pour plus de détails. L'URL de base est toujours https://app.snipcart.com/api.

⚠️ Important : La création d'un remboursement est irréversible et soumet le remboursement à la passerelle de paiement qui a traité la commande d'origine. Vérifiez deux fois le amount avant de l'envoyer.

Table des matières

POST /orders/{token}/refunds

Crée un remboursement pour la commande identifiée par token et le soumet à la passerelle de paiement de la commande.

URL de la ressource

https://app.snipcart.com/api/orders/{token}/refunds

En-têtes

Nom Obligatoire? Description
Accept Oui Doit être application/json.
Content-Type Oui Doit être application/json.

Paramètres de chemin

Nom Obligatoire? Type Description
token Oui string Le jeton unique de la commande.

Paramètres du corps

Nom Obligatoire? Type Description
amount Oui decimal Le montant à rembourser. Arrondi à deux décimales. Ne peut pas dépasser le grand total de la commande ni être inférieur au montant minimal de la passerelle.
comment Non string Une note expliquant la raison du remboursement.
status Non string Type de remboursement. Soit Complete, soit Partial.
autoRefundTaxes Non boolean Lorsque true, les taxes sont remboursées automatiquement au prorata du montant remboursé. La valeur par défaut est false.
notifyCustomer Non boolean Lorsque true, envoie au client un courriel de notification de remboursement. La valeur par défaut est false.

Exemple de requête 

curl https://app.snipcart.com/api/orders/4243490d-87c1-480e-b413-51db0b419313/refunds \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -u {API_KEY}: \
  -d '{
        "amount": 200.50,
        "comment": "Reason for refund",
        "status": "Partial",
        "autoRefundTaxes": true,
        "notifyCustomer": true
      }'

Exemple de réponse 

{
    "id": "2573490e-81d2-110c-b713-51ab0d823513",
    "creationDate": "2026-06-17T14:32:08Z",
    "modificationDate": "2026-06-17T14:32:08Z",
    "orderToken": "4243490d-87c1-480e-b413-51db0b419313",
    "amount": 200.50,
    "comment": "Reason for refund",
    "notifyCustomer": true,
    "refundedByPaymentGateway": true,
    "withdrawals": []
}

GET /orders/{token}/refunds

Retourne tous les remboursements effectués sur la commande identifiée par token.

URL de la ressource

https://app.snipcart.com/api/orders/{token}/refunds

En-têtes

Nom Obligatoire? Description
Accept Oui Doit être application/json.

Paramètres de chemin

Nom Obligatoire? Type Description
token Oui string Le jeton unique de la commande.

Exemple de requête 

curl https://app.snipcart.com/api/orders/4243490d-87c1-480e-b413-51db0b419313/refunds \
  -H "Accept: application/json" \
  -u {API_KEY}:

Exemple de réponse 

[
    {
        "id": "2223490d-84c1-480c-b713-50cb0b819313",
        "creationDate": "2026-05-02T09:14:51Z",
        "modificationDate": "2026-05-02T09:14:51Z",
        "amount": 300.00,
        "comment": "A comment",
        "notifyCustomer": false,
        "refundedByPaymentGateway": true,
        "withdrawals": []
    },
    ...
]

GET /orders/{token}/refunds/{id}

Retourne un seul remboursement pour la commande donnée.

URL de la ressource

https://app.snipcart.com/api/orders/{token}/refunds/{id}

En-têtes

Nom Obligatoire? Description
Accept Oui Doit être application/json.

Paramètres de chemin

Nom Obligatoire? Type Description
token Oui string Le jeton unique de la commande.
id Oui string L'identifiant unique du remboursement (GUID).

Exemple de requête 

curl https://app.snipcart.com/api/orders/4243490d-87c1-480e-b413-51db0b419313/refunds/2223490d-84c1-480c-b713-50cb0b819313 \
  -H "Accept: application/json" \
  -u {API_KEY}:

Exemple de réponse 

{
    "id": "2223490d-84c1-480c-b713-50cb0b819313",
    "creationDate": "2026-05-02T09:14:51Z",
    "modificationDate": "2026-05-02T09:14:51Z",
    "amount": 300.00,
    "comment": "A comment",
    "notifyCustomer": false,
    "refundedByPaymentGateway": true,
    "withdrawals": []
}