Zwroty

Cost+ obsługuje zarówno pełne, jak i częściowe zwroty zrealizowanych zamówień. Zwroty są przetwarzane za pośrednictwem oryginalnej metody płatności użytej w transakcji.

Tworzenie zwrotu

Wyślij żądanie POST na /v1/orders/\{id\}/refunds/, aby zainicjować zwrot zrealizowanego zamówienia.

Żądanie

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

Pole amount jest podawane w groszach/centach. Aby zwrócić 1,00 EUR, ustaw amount na 100. Aby dokonać pełnego zwrotu, ustaw kwotę na pełną kwotę zamówienia.

Pola żądania

Pole	Wymagane	Opis
`amount`	Tak	Kwota zwrotu w groszach/centach
`description`	Nie	Powód zwrotu
`merchant_order_id`	Nie	Twój własny identyfikator referencyjny zwrotu
`extra`	Nie	Dodatkowe metadane jako obiekt klucz-wartość

Odpowiedź

API zwraca obiekt zwrotu z jego aktualnym statusem:

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

Pola odpowiedzi

Pole	Opis
`id`	Unikalny identyfikator zwrotu
`created`	Znacznik czasu utworzenia zwrotu
`modified`	Znacznik czasu ostatniej aktualizacji zwrotu
`amount`	Kwota zwrotu w groszach/centach
`currency`	Waluta zwrotu (zgodna z walutą zamówienia)
`status`	Aktualny status zwrotu (`pending`, `completed`, `failed`)
`description`	Powód zwrotu
`merchant_order_id`	Twój identyfikator referencyjny
`extra`	Dodatkowe metadane

Zwrot pełny a częściowy

Pełny zwrot: Ustaw amount na pełną kwotę zamówienia. Cała płatność zostanie zwrócona klientowi.
Częściowy zwrot: Ustaw amount na kwotę mniejszą niż łączna kwota zamówienia. Tylko określona kwota zostanie zwrócona.

Możesz dokonać wielu częściowych zwrotów tego samego zamówienia, pod warunkiem że łączna zwrócona kwota nie przekracza oryginalnej kwoty zamówienia.

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

Zwroty mogą być dokonywane tylko dla zamówień ze statusem completed. Próba zwrotu zamówienia, które nie zostało jeszcze zrealizowane, spowoduje błąd.

Użyj pola merchant_order_id, aby powiązać zwroty z Twoimi wewnętrznymi systemami. Jest to szczególnie przydatne przy dokonywaniu wielu częściowych zwrotów tego samego zamówienia.

Statusy zwrotów

Status	Opis
`pending`	Zwrot został zainicjowany i jest przetwarzany.
`completed`	Zwrot został pomyślnie przetworzony. Środki zostaną zwrócone klientowi.
`failed`	Nie udało się przetworzyć zwrotu. Skontaktuj się z pomocą techniczną Cost+.

Czas, po jakim zwrócona kwota pojawi się na koncie klienta, zależy od metody płatności i banku klienta. Zwroty kartami kredytowymi trwają zazwyczaj od 5 do 10 dni roboczych.

Sprawdzanie kwoty dostępnej do zwrotu

Przed dokonaniem częściowego zwrotu możesz sprawdzić, ile jest dostępne:

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

Pole refundable w odpowiedzi pokazuje maksymalną kwotę, którą możesz zwrócić.

Powiązane punkty końcowe

Utwórz zwrot — dokonaj pełnego lub częściowego zwrotu zrealizowanego zamówienia
Lista zwrotów — pobierz wszystkie zwroty dla zamówienia

On this page