Remboursements

Cost+ prend en charge les remboursements totaux et partiels sur les commandes finalisées. Les remboursements sont traités via la méthode de paiement originale utilisée pour la transaction.

Créer un remboursement

Envoyez une requête POST à /v1/orders/\{id\}/refunds/ pour initier un remboursement sur une commande finalisée.

Requête

{
  "amount": 100,
  "description": "Refund for item",
  "merchant_order_id": "refund-001"
}

Le champ amount utilise l'unité mineure ISO 4217 de la devise. Pour EUR, rembourser 1,00 EUR signifie définir amount sur 100. Pour effectuer un remboursement complet, utilisez le montant total de la commande.

Champs de la requête

Champ	Obligatoire	Description
`amount`	Oui	Montant du remboursement dans l'unité mineure ISO 4217 de la devise
`description`	Non	Raison du remboursement
`merchant_order_id`	Non	Votre propre identifiant de référence pour le remboursement
`extra`	Non	Métadonnées supplémentaires sous forme d'objet clé-valeur

Réponse

L'API renvoie l'objet remboursement avec son statut actuel :

{
  "id": "ref_abc123...",
  "created": "2024-01-02T10:00:00.000000+00:00",
  "modified": "2024-01-02T10:00:00.000000+00:00",
  "amount": 100,
  "currency": "EUR",
  "status": "pending",
  "description": "Refund for item",
  "merchant_order_id": "refund-001",
  "extra": null
}

Champs de la réponse

Champ	Description
`id`	Identifiant unique du remboursement
`created`	Horodatage de la création du remboursement
`modified`	Horodatage de la dernière mise à jour du remboursement
`amount`	Montant du remboursement dans l'unité mineure ISO 4217 de la devise
`currency`	Devise du remboursement (correspond à la devise de la commande)
`status`	Statut actuel du remboursement (`pending`, `completed`, `failed`)
`description`	Raison du remboursement
`merchant_order_id`	Votre identifiant de référence
`extra`	Métadonnées supplémentaires

Remboursement total vs partiel

Remboursement total : Définissez amount au montant total de la commande. L'intégralité du paiement est restituée au client.
Remboursement partiel : Définissez amount à un montant inférieur au montant total de la commande. Seul le montant spécifié est restitué.

Vous pouvez effectuer plusieurs remboursements partiels sur la même commande, tant que le montant total remboursé ne dépasse pas le montant original de la commande.

{
  "amount": 500,
  "description": "Partial refund - damaged item"
}

Les remboursements ne peuvent être effectués que sur des commandes avec un statut completed. Tenter de rembourser une commande non encore finalisée entraînera une erreur.

Utilisez le champ merchant_order_id pour lier les remboursements à vos systèmes internes. C'est particulièrement utile lorsque vous effectuez plusieurs remboursements partiels sur la même commande.

Statuts des remboursements

Statut	Description
`pending`	Le remboursement a été initié et est en cours de traitement.
`completed`	Le remboursement a été traité avec succès. Les fonds seront restitués au client.
`failed`	Le remboursement n'a pas pu être traité. Contactez le support Cost+ pour obtenir de l'aide.

Le délai d'apparition du montant remboursé sur le compte du client dépend de la méthode de paiement et de la banque du client. Les remboursements par carte bancaire prennent généralement 5 à 10 jours ouvrés.

Vérifier le montant remboursable

Avant d'effectuer un remboursement partiel, vous pouvez vérifier le montant disponible :

curl -u YOUR_API_KEY: \
  "https://api.costplus.online/v1/orders/{order_id}/?fields[]=amount_details"

Le champ refundable dans la réponse indique le montant maximum que vous pouvez rembourser.

Points d'accès associés

Créer un remboursement — effectuer un remboursement total ou partiel sur une commande finalisée
Lister les remboursements — récupérer tous les remboursements d'une commande

Remboursements

On this page