put
https://apisandbox.braspag.com.br/v2/sales//void
Cancela ou estorna uma transação de cartão de crédito.
| Ambiente | Método | Endpoint |
|---|---|---|
| Sandbox | put | https://apisandbox.braspag.com.br/v2/sales/{PaymentId}/void |
| Produção | put | https://api.braspag.com.br/v2/sales/{PaymentId}/void |
Novo campo obrigatório para cancelamento de transações por risco de fraudeA partir de 17/04/2026, será obrigatório informar o campo
Reasonquando o motivo do cancelamento for risco de fraude identificado pelo estabelecimento.Informe
Reason= "HighRisk" no corpo da requisição, conforme exemplo:{ "Reason": "HighRisk" }
Cancelamento total
Para cancelar totalmente uma transação, não é necessário enviar o campo Amount.
Cancelamento parcial
| Ambiente | Método | Endpoint |
|---|---|---|
| Sandbox | put | https://apisandbox.braspag.com.br/v2/sales/{PaymentId}/void?amount={Amount} |
| Produção | put | https://api.braspag.com.br/v2/sales/{PaymentId}/void?amount={Amount} |
Para cancelar parcialmente uma transação, envie no campo Amount o valor em centavos que deseja cancelar.
Não é possível estornar parcialmente uma transação não capturada.Para fazer um cancelamento parcial, o campo
Capturedeve ser "true" na criação do pagamento com cartão de crédito.
A API permite cancelar transações individualmente.
Para cancelar um grupo de transações, utilize o portal e-commerce. Saiba mais em:
- Como cancelar transações em lote (até 23h59 do dia da criação da transação);
- Como estornar transações em lote (a partir do dia seguinte à criação da transação).