Cost+Docs

Tagasimaksed

Töötlege täielikke ja osalisi tagasimakseid

Cost+ toetab nii täielikke kui osalisi tagasimakseid lõpetatud tellimustele. Tagasimaksed töödeldakse algse tehingu makseviisi kaudu.

Tagasimakse loomine

Saatke POST päring aadressile /v1/orders/\{id\}/refunds/, et algatada tagasimakse lõpetatud tellimusele.

Päring

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

Väli amount on sentides. 1,00 EUR tagasimaksmiseks määrake amount väärtuseks 100. Täieliku tagasimakse tegemiseks määrake summa tellimuse kogusummaks.

Päringu väljad

VäliKohustuslikKirjeldus
amountJahTagasimakse summa sentides
descriptionEiTagasimakse põhjus
merchant_order_idEiTeie enda viide-ID tagasimakse jaoks
extraEiTäiendavad metaandmed võtme-väärtuse objektina

Vastus

API tagastab tagasimakse objekti selle praeguse olekuga:

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

Vastuse väljad

VäliKirjeldus
idTagasimakse unikaalne identifikaator
createdAjatempel, millal tagasimakse loodi
modifiedAjatempel, millal tagasimakset viimati uuendati
amountTagasimakse summa sentides
currencyTagasimakse valuuta (vastab tellimuse valuutale)
statusTagasimakse praegune olek (pending, completed, failed)
descriptionTagasimakse põhjus
merchant_order_idTeie viide-ID
extraTäiendavad metaandmed

Täielikud vs osalised tagasimaksed

  • Täielik tagasimakse: Määrake amount tellimuse kogusummaks. Kogu makse tagastatakse kliendile.
  • Osaline tagasimakse: Määrake amount väiksemaks kui tellimuse kogusumma. Tagastatakse ainult määratud summa.

Saate sama tellimuse kohta teha mitu osalist tagasimakset, kui tagasimakstud kogusumma ei ületa algset tellimuse summat.

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

Tagasimakseid saab teha ainult olekuga completed tellimustele. Katse teha tagasimakse tellimusele, mis ei ole veel lõpetatud, põhjustab vea.

Kasutage välja merchant_order_id, et siduda tagasimaksed oma sisesüsteemidega. See on eriti kasulik, kui teete samale tellimusele mitu osalist tagasimakset.

Tagasimakse olekud

OlekKirjeldus
pendingTagasimakse on algatatud ja seda töödeldakse.
completedTagasimakse on edukalt töödeldud. Raha tagastatakse kliendile.
failedTagasimakset ei saanud töödelda. Võtke ühendust Cost+ toega.

Tagasimakstud summa kliendi kontole jõudmise aeg sõltub makseviisist ja kliendi pangast. Krediitkaardi tagasimaksed võtavad tavaliselt 5–10 tööpäeva.

Tagasimakstava summa kontrollimine

Enne osalise tagasimakse tegemist saate kontrollida, kui palju on saadaval:

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

Vastuse väli refundable näitab maksimaalset tagasimakstavat summat.

Seotud lõpp-punktid

On this page