Cost+Docs

Vratenie platieb

Spracovanie uplnych a ciastocnych vrateni platieb

Cost+ podporuje uplne aj ciastocne vratenia platieb pri dokoncených objednavkach. Vratenia sa spracovavaju cez povodnu platobnu metodu pouzitu pri transakcii.

Vytvorenie vratenia

Posliete poziadavku POST na /v1/orders/\{id\}/refunds/ na iniciovanie vratenia pri dokoncenej objednavke.

Poziadavka

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

Pole amount používa vedľajšiu jednotku meny ISO 4217. V prípade EUR vrátenie 1,00 EUR znamená nastavenie amount na 100. Ak chcete vrátiť peniaze v plnej výške, použite celú sumu objednávky.

Polia poziadavky

PolePovinnePopis
amountánoSuma vrátenia v menovej jednotke ISO 4217 meny
descriptionNieDovod vratenia
merchant_order_idNieVase vlastne referencne ID pre vratenie
extraNieDoplnkove metadata ako objekt kluc-hodnota

Odpoved

API vrati objekt vratenia s jeho aktualnym stavom:

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

Polia odpovede

PolePopis
idJediny identifikator vratenia
createdCasova znacka vytvorenia vratenia
modifiedCasova znacka poslednej aktualizacie vratenia
amountSuma vrátenia v menovej jednotke ISO 4217 meny
currencyMena vratenia (zodpoveda mene objednavky)
statusAktualny stav vratenia (pending, completed, failed)
descriptionDovod vratenia
merchant_order_idVase referencne ID
extraDoplnkove metadata

Uplne vs. ciastocne vratenia

  • Uplne vratenie: Nastavte amount na celkovu sumu objednavky. Cela platba sa vrati zakaznikovi.
  • Ciastocne vratenie: Nastavte amount na menej ako celkova suma objednavky. Zakaznikovi sa vrati len zadana suma.

Na tu istu objednavku mozete vykonat viacero ciastocnych vrateni, pokial celkova vratena suma neprekroci povodnu sumu objednavky.

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

Vratenia je mozne vykonat len pri objednavkach v stave completed. Pokus o vratenie objednavky, ktora este nie je dokoncena, sposobi chybu.

Pouzite pole merchant_order_id na prepojenie vrateni s vasimi internymi systemami. To je obzvlast uzitocne pri vydavani viacerych ciastocnych vrateni na tej istej objednavke.

Stavy vratenia

StavPopis
pendingVratenie bolo iniciovane a spracovava sa.
completedVratenie bolo uspesne spracovane. Prostriedky sa vratia zakaznikovi.
failedVratenie sa nepodarilo spracovat. Kontaktujte podporu Cost+.

Cas, za ktory sa vratena suma objavi na ucte zakaznika, zavisi od platobnej metody a banky zakaznika. Vratenia na kreditne karty zvycajne trvaju 5-10 pracovnych dni.

Kontrola sumy dostupnej na vratenie

Pred vydanim ciastocneho vratenia mozete skontrolovat, kolko je dostupnych:

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

Pole refundable v odpovedi zobrazuje maximalnu sumu, ktoru mozete vratit.

Suvisiace endpointy

On this page