Vrácení plateb

Cost+ podporuje úplné i částečné refundace dokončených objednávek. Refundace jsou zpracovány prostřednictvím původní platební metody použité pro transakci.

Vytvoření refundace

Odešlete požadavek POST na /v1/orders/\{id\}/refunds/ pro zahájení refundace dokončené objednávky.

Požadavek

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

Pole amount je v centech. Pro vrácení 1,00 EUR nastavte amount na 100. Pro úplnou refundaci nastavte částku na celkovou částku objednávky.

Pole požadavku

Pole	Povinné	Popis
`amount`	Ano	Částka refundace v centech
`description`	Ne	Důvod refundace
`merchant_order_id`	Ne	Vaše vlastní referenční ID refundace
`extra`	Ne	Dodatečná metadata jako objekt klíč-hodnota

Odpověď

API vrátí objekt refundace s jejím aktuálním stavem:

{
  "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
}

Pole odpovědi

Pole	Popis
`id`	Unikátní identifikátor refundace
`created`	Časové razítko vytvoření refundace
`modified`	Časové razítko poslední aktualizace refundace
`amount`	Částka refundace v centech
`currency`	Měna refundace (odpovídá měně objednávky)
`status`	Aktuální stav refundace (`pending`, `completed`, `failed`)
`description`	Důvod refundace
`merchant_order_id`	Vaše referenční ID
`extra`	Dodatečná metadata

Úplné vs. částečné refundace

Úplná refundace: Nastavte amount na celkovou částku objednávky. Celá platba je vrácena zákazníkovi.
Částečná refundace: Nastavte amount na méně než celková částka objednávky. Vrácena je pouze uvedená částka.

Na stejné objednávce můžete provést více částečných refundací, pokud celková vrácená částka nepřesáhne původní částku objednávky.

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

Refundace lze provádět pouze u objednávek se stavem completed. Pokus o refundaci objednávky, která ještě není dokončena, povede k chybě.

Použijte pole merchant_order_id k propojení refundací s vašimi interními systémy. To je obzvláště užitečné při provádění více částečných refundací na stejné objednávce.

Stavy refundace

Stav	Popis
`pending`	Refundace byla zahájena a je zpracovávána.
`completed`	Refundace byla úspěšně zpracována. Prostředky budou vráceny zákazníkovi.
`failed`	Refundaci nebylo možné zpracovat. Kontaktujte podporu Cost+.

Doba, za kterou se vrácená částka objeví na účtu zákazníka, závisí na platební metodě a bance zákazníka. Refundace kreditních karet obvykle trvají 5–10 pracovních dní.

Kontrola refundovatelné částky

Před provedením částečné refundace můžete zkontrolovat, kolik je k dispozici:

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

Pole refundable v odpovědi ukazuje maximální částku, kterou můžete refundovat.

Související endpointy

Vytvoření refundace — provedení úplné nebo částečné refundace dokončené objednávky
Seznam refundací — získání všech refundací objednávky

On this page