Vouchers

L'objet Voucher représente un bon d'achat émis suite à un sinistre. Le marchand peut informer Estaly de l'utilisation d'un bon d'achat via son reference_id.

ENDPOINTS

• POST /api/v2/store/{store_id}/vouchers/{reference_id}/mark_as_used : Informe Estaly qu'un bon d'achat a été utilisé par le client.

---

L'object Voucher

Attributs

• reference_id (string) : Identifiant externe unique du bon d’achat (référence marchand).
• amount (number) : Montant du bon d’achat.
• currency_code (string) : Devise du bon d’achat (ex : “EUR”).
• code (string) : Code du bon d’achat.
• end_validity_date (string) : Date de fin de validité du bon d’achat.
• usage_date (string | null) : Date d’utilisation du bon d’achat. null si le bon d’achat n’a pas été utilisé.

Exemple de l'objet Voucher

JSON

{
  "reference_id": "CART-RULE-12345",
  "amount": 1200.00,
  "currency_code": "EUR",
  "code": "ESTALY-BA-324",
  "end_validity_date": "12/06/2023",
  "usage_date": null
}