Cost+Docs

Възстановявания

Обработвайте пълни и частични възстановявания

Cost+ поддържа както пълни, така и частични възстановявания на завършени поръчки. Възстановяванията се обработват чрез оригиналния метод на плащане, използван за транзакцията.

Създаване на възстановяване

Изпратете POST заявка към /v1/orders/\{id\}/refunds/, за да инициирате възстановяване на завършена поръчка.

Заявка

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

Полето amount използва второстепенната единица ISO 4217 на валутата. За EUR възстановяването на 1,00 EUR означава задаване на amount на 100. За пълно възстановяване на сумата използвайте пълната сума на поръчката.

Полета на заявката

ПолеЗадължителноОписание
amountдаСумата за възстановяване във валутната единица ISO 4217
descriptionНеПричина за възстановяването
merchant_order_idНеВаш собствен референтен идентификатор за възстановяването
extraНеДопълнителни метаданни като обект ключ-стойност

Отговор

API-то връща обекта на възстановяването с текущия му статус:

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

Полета на отговора

ПолеОписание
idУникален идентификатор на възстановяването
createdВремева марка на създаване на възстановяването
modifiedВремева марка на последна актуализация на възстановяването
amountСумата за възстановяване във валутната единица ISO 4217
currencyВалута на възстановяването (съвпада с валутата на поръчката)
statusТекущ статус на възстановяването (pending, completed, failed)
descriptionПричина за възстановяването
merchant_order_idВашият референтен идентификатор
extraДопълнителни метаданни

Пълно срещу частично възстановяване

  • Пълно възстановяване: Задайте amount равна на общата сума на поръчката. Цялото плащане се връща на клиента.
  • Частично възстановяване: Задайте amount по-малка от общата сума на поръчката. Само посочената сума се връща.

Можете да издавате множество частични възстановявания на една и съща поръчка, стига общата възстановена сума да не надвишава първоначалната сума на поръчката.

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

Възстановявания могат да се издават само за поръчки със статус completed. Опитът за възстановяване на поръчка, която все още не е завършена, ще доведе до грешка.

Използвайте полето merchant_order_id, за да свържете възстановяванията обратно към вътрешните си системи. Това е особено полезно при издаване на множество частични възстановявания на една и съща поръчка.

Статуси на възстановяване

СтатусОписание
pendingВъзстановяването е инициирано и се обработва.
completedВъзстановяването е успешно обработено. Средствата ще бъдат върнати на клиента.
failedВъзстановяването не може да бъде обработено. Свържете се с поддръжката на Cost+ за съдействие.

Времето, необходимо за появата на възстановената сума в сметката на клиента, зависи от метода на плащане и банката на клиента. Възстановяванията по кредитни карти обикновено отнемат 5-10 работни дни.

Проверка на сумата за възстановяване

Преди да издадете частично възстановяване, можете да проверите колко е налично:

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

Полето refundable в отговора показва максималната сума, която можете да възстановите.

Свързани крайни точки

On this page