Cost+Docs

Palautukset

Käsittele täysiä ja osittaisia palautuksia

Cost+ tukee sekä täysiä että osittaisia palautuksia valmiille tilauksille. Palautukset käsitellään alkuperäisen tapahtumassa käytetyn maksutavan kautta.

Palautuksen luominen

Lähetä POST-pyyntö osoitteeseen /v1/orders/\{id\}/refunds/ aloittaaksesi palautuksen valmiille tilaukselle.

Pyyntö

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

amount-kenttä on senteissä. Palauttaaksesi 1,00 EUR, aseta amount arvoon 100. Täyden palautuksen tekemiseksi aseta summa tilauksen koko summaksi.

Pyyntökentät

KenttäPakollinenKuvaus
amountKylläPalautussumma senteissä
descriptionEiPalautuksen syy
merchant_order_idEiOma viitetunnisteesi palautukselle
extraEiLisämetatiedot avain-arvo-objektina

Vastaus

API palauttaa palautusobjektin ja sen nykyisen tilan:

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

Vastauskentät

KenttäKuvaus
idPalautuksen yksilöllinen tunniste
createdAikaleima palautuksen luomisesta
modifiedAikaleima palautuksen viimeisimmästä päivityksestä
amountPalautussumma senteissä
currencyPalautuksen valuutta (vastaa tilauksen valuuttaa)
statusPalautuksen nykyinen tila (pending, completed, failed)
descriptionPalautuksen syy
merchant_order_idOma viitetunnisteesi
extraLisämetatiedot

Täysi vs. osittainen palautus

  • Täysi palautus: Aseta amount tilauksen kokonaissummaksi. Koko maksu palautetaan asiakkaalle.
  • Osittainen palautus: Aseta amount tilauksen kokonaissummaa pienemmäksi. Vain määritetty summa palautetaan.

Voit tehdä useita osittaisia palautuksia samalle tilaukselle, kunhan palautettu kokonaissumma ei ylitä alkuperäisen tilauksen summaa.

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

Palautuksia voi tehdä vain tilauksille, joiden tila on completed. Palautuksen yrittäminen keskeneräiselle tilaukselle johtaa virheeseen.

Käytä merchant_order_id-kenttää yhdistääksesi palautukset sisäisiin järjestelmiisi. Tämä on erityisen hyödyllistä, kun teet useita osittaisia palautuksia samalle tilaukselle.

Palautusten tilat

TilaKuvaus
pendingPalautus on aloitettu ja sitä käsitellään.
completedPalautus on käsitelty onnistuneesti. Varat palautetaan asiakkaalle.
failedPalautusta ei voitu käsitellä. Ota yhteyttä Cost+-tukeen avun saamiseksi.

Aika, joka kuluu palautetun summan näkymiseen asiakkaan tilillä, riippuu maksutavasta ja asiakkaan pankista. Luottokorttien palautukset kestävät tyypillisesti 5–10 arkipäivää.

Palautettavissa olevan summan tarkistaminen

Ennen osittaisen palautuksen tekemistä voit tarkistaa käytettävissä olevan summan:

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

Vastauksen refundable-kenttä näyttää enimmäissumman, jonka voit palauttaa.

Liittyvät päätepisteet

On this page