Återbetalningar

Cost+ stöder både fullständiga och partiella återbetalningar på slutförda ordrar. Återbetalningar behandlas via den ursprungliga betalningsmetoden som användes för transaktionen.

Skapa en återbetalning

Skicka en POST-förfrågan till /v1/orders/\{id\}/refunds/ för att initiera en återbetalning på en slutförd order.

Förfrågan

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

Fältet amount anges i ören/cent. För att återbetala 1,00 EUR, ange amount till 100. För en fullständig återbetalning, ange beloppet till orderns totala belopp.

Förfrågningsfält

Fält	Obligatoriskt	Beskrivning
`amount`	Ja	Återbetalningsbelopp i ören/cent
`description`	Nej	Anledning till återbetalningen
`merchant_order_id`	Nej	Ditt eget referens-ID för återbetalningen
`extra`	Nej	Ytterligare metadata som nyckel-värde-objekt

Svar

API:et returnerar återbetalningsobjektet med dess aktuella status:

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

Svarsfält

Fält	Beskrivning
`id`	Unik identifierare för återbetalningen
`created`	Tidsstämpel när återbetalningen skapades
`modified`	Tidsstämpel när återbetalningen senast uppdaterades
`amount`	Återbetalningsbelopp i ören/cent
`currency`	Valuta för återbetalningen (matchar ordervalutan)
`status`	Aktuell återbetalningsstatus (`pending`, `completed`, `failed`)
`description`	Anledning till återbetalningen
`merchant_order_id`	Ditt referens-ID
`extra`	Ytterligare metadata

Fullständig kontra partiell återbetalning

Fullständig återbetalning: Ange amount till orderns totalbelopp. Hela betalningen returneras till kunden.
Partiell återbetalning: Ange amount till mindre än orderns totalbelopp. Endast det angivna beloppet returneras.

Du kan utfärda flera partiella återbetalningar på samma order, så länge det totala återbetalade beloppet inte överstiger det ursprungliga orderbeloppet.

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

Återbetalningar kan bara utfärdas på ordrar med statusen completed. Att försöka återbetala en order som ännu inte är slutförd resulterar i ett fel.

Använd fältet merchant_order_id för att koppla återbetalningar till dina interna system. Detta är särskilt användbart vid utfärdande av flera partiella återbetalningar på samma order.

Återbetalningsstatusar

Status	Beskrivning
`pending`	Återbetalningen har initierats och behandlas.
`completed`	Återbetalningen har behandlats framgångsrikt. Medlen kommer att returneras till kunden.
`failed`	Återbetalningen kunde inte behandlas. Kontakta Cost+ support för hjälp.

Tiden det tar för det återbetalade beloppet att visas på kundens konto beror på betalningsmetoden och kundens bank. Kreditkortsåterbetalningar tar vanligtvis 5-10 arbetsdagar.

Kontrollera återbetalningsbart belopp

Innan du utfärdar en partiell återbetalning kan du kontrollera hur mycket som är tillgängligt:

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

Fältet refundable i svaret visar det maximala beloppet du kan återbetala.

Relaterade endpoints

Skapa återbetalning — utfärda en fullständig eller partiell återbetalning på en slutförd order
Lista återbetalningar — hämta alla återbetalningar för en order

On this page