Reembolsos

A Cost+ suporta reembolsos totais e parciais em encomendas concluídas. Os reembolsos são processados através do método de pagamento original utilizado na transação.

Criar um Reembolso

Envie um pedido POST para /v1/orders/\{id\}/refunds/ para iniciar um reembolso numa encomenda concluída.

Pedido

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

O campo amount está em cêntimos. Para reembolsar 1,00 EUR, defina amount como 100. Para emitir um reembolso total, defina o montante como o montante total da encomenda.

Campos do Pedido

Campo	Obrigatório	Descrição
`amount`	Sim	Montante do reembolso em cêntimos
`description`	Não	Motivo do reembolso
`merchant_order_id`	Não	O seu próprio ID de referência para o reembolso
`extra`	Não	Metadados adicionais como objeto chave-valor

Resposta

A API devolve o objeto de reembolso com o seu estado atual:

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

Campos da Resposta

Campo	Descrição
`id`	Identificador único do reembolso
`created`	Data e hora de criação do reembolso
`modified`	Data e hora da última atualização do reembolso
`amount`	Montante do reembolso em cêntimos
`currency`	Moeda do reembolso (corresponde à moeda da encomenda)
`status`	Estado atual do reembolso (`pending`, `completed`, `failed`)
`description`	Motivo do reembolso
`merchant_order_id`	O seu ID de referência
`extra`	Metadados adicionais

Reembolsos Totais vs. Parciais

Reembolso total: Defina o amount como o montante total da encomenda. O pagamento completo é devolvido ao cliente.
Reembolso parcial: Defina o amount para menos do que o montante total da encomenda. Apenas o montante especificado é devolvido.

Pode emitir múltiplos reembolsos parciais na mesma encomenda, desde que o montante total reembolsado não exceda o montante original da encomenda.

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

Os reembolsos só podem ser emitidos em encomendas com estado completed. Tentar reembolsar uma encomenda que ainda não está concluída resultará num erro.

Utilize o campo merchant_order_id para ligar os reembolsos aos seus sistemas internos. Isto é especialmente útil quando emite múltiplos reembolsos parciais na mesma encomenda.

Estados do Reembolso

Estado	Descrição
`pending`	O reembolso foi iniciado e está a ser processado.
`completed`	O reembolso foi processado com sucesso. Os fundos serão devolvidos ao cliente.
`failed`	O reembolso não pôde ser processado. Contacte o suporte da Cost+ para assistência.

O tempo que demora até o montante reembolsado aparecer na conta do cliente depende do método de pagamento e do banco do cliente. Os reembolsos por cartão de crédito demoram tipicamente 5-10 dias úteis.

Verificar o Montante Reembolsável

Antes de emitir um reembolso parcial, pode verificar quanto está disponível:

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

O campo refundable na resposta mostra o montante máximo que pode reembolsar.

Endpoints Relacionados

Criar Reembolso — emitir um reembolso total ou parcial numa encomenda concluída
Listar Reembolsos — obter todos os reembolsos de uma encomenda

On this page