Remover um pagamento de um pedido
DELETE/v1/orders/:id/payments/:paymentId
Cancela um pagamento de um pedido e retorna o pedido com os totais de pagamento recalculados.
O pagamento não é apagado: ele permanece no pedido com canceled_at definido, de modo que a movimentação de dinheiro continua auditável. Cancelar todos os pagamentos também é o que um pedido precisa antes de poder ser cancelado com POST /v1/orders/{id}/cancel.
Funciona em pedidos criados pela API, feitos pelo cliente na loja virtual (INBOUND) ou realizados pelo comerciante no POS (OUTBOUND). Um pedido de um food app pertence a esse canal e responde 422 order_not_modifiable.
Escopo necessário: orders:write
Request
Responses
- 200
- 401
- 403
- 404
- 422
O pedido sem o pagamento cancelado.
Não autenticado — a requisição não possui uma credencial, ou o token Bearer / API key é inválido, expirou ou foi revogado.
Escopo insuficiente — a credencial está autenticada, mas não possui um escopo exigido pelo endpoint.
Não encontrado — nenhum recurso corresponde ao id no caminho (ou ele pertence a outra empresa).
Falha de validação — o corpo da requisição falhou na validação do schema. errors[] lista todos os campos com problema.