Rimborsi

Cost+ supporta sia rimborsi totali che parziali sugli ordini completati. I rimborsi vengono elaborati attraverso il metodo di pagamento originale utilizzato per la transazione.

Creare un Rimborso

Invia una richiesta POST a /v1/orders/\{id\}/refunds/ per avviare un rimborso su un ordine completato.

Richiesta

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

Il campo amount è in centesimi. Per rimborsare 1,00 EUR, imposta amount a 100. Per emettere un rimborso totale, imposta l'importo pari all'importo totale dell'ordine.

Campi della Richiesta

Campo	Obbligatorio	Descrizione
`amount`	Sì	Importo del rimborso in centesimi
`description`	No	Motivo del rimborso
`merchant_order_id`	No	Il tuo ID di riferimento per il rimborso
`extra`	No	Metadati aggiuntivi come oggetto chiave-valore

Risposta

L'API restituisce l'oggetto rimborso con il suo stato attuale:

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

Campi della Risposta

Campo	Descrizione
`id`	Identificatore univoco del rimborso
`created`	Timestamp di creazione del rimborso
`modified`	Timestamp dell'ultimo aggiornamento del rimborso
`amount`	Importo del rimborso in centesimi
`currency`	Valuta del rimborso (corrisponde alla valuta dell'ordine)
`status`	Stato attuale del rimborso (`pending`, `completed`, `failed`)
`description`	Motivo del rimborso
`merchant_order_id`	Il tuo ID di riferimento
`extra`	Metadati aggiuntivi

Rimborsi Totali vs. Parziali

Rimborso totale: Imposta l'amount pari all'importo totale dell'ordine. L'intero pagamento viene restituito al cliente.
Rimborso parziale: Imposta l'amount inferiore all'importo totale dell'ordine. Solo l'importo specificato viene restituito.

Puoi emettere più rimborsi parziali sullo stesso ordine, purché l'importo totale rimborsato non superi l'importo originale dell'ordine.

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

I rimborsi possono essere emessi solo su ordini con stato completed. Tentare di rimborsare un ordine non ancora completato risulterà in un errore.

Usa il campo merchant_order_id per collegare i rimborsi ai tuoi sistemi interni. Questo è particolarmente utile quando si emettono più rimborsi parziali sullo stesso ordine.

Stati del Rimborso

Stato	Descrizione
`pending`	Il rimborso è stato avviato ed è in fase di elaborazione.
`completed`	Il rimborso è stato elaborato con successo. I fondi verranno restituiti al cliente.
`failed`	Il rimborso non è stato elaborato. Contatta il supporto Cost+ per assistenza.

Il tempo necessario affinché l'importo rimborsato appaia sul conto del cliente dipende dal metodo di pagamento e dalla banca del cliente. I rimborsi con carta di credito richiedono tipicamente 5-10 giorni lavorativi.

Verificare l'Importo Rimborsabile

Prima di emettere un rimborso parziale, puoi verificare quanto è disponibile:

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

Il campo refundable nella risposta mostra l'importo massimo rimborsabile.

Endpoint Correlati

Crea Rimborso — emetti un rimborso totale o parziale su un ordine completato
Lista Rimborsi — recupera tutti i rimborsi di un ordine

On this page