Cancelar ou estornar uma Venda
Rota única para desfazer uma Venda, com o campo opcional intent:
cancel: cancela as pré-autorizações de uma Vendapendingcom todos os cartõespre_authorized. Responde202comoperation.type: voide a Venda terminacancelled.refund: estorna o valor integral de uma Vendapaid. Responde202comoperation.type: refunde a Venda permanecepaid.
Sem intent (corpo vazio, {} ou intent: ""), a Malga decide pelo estado da Venda: paid estorna e os demais estados cancelam, com as mesmas regras acima. Envie intent explicitamente para garantir que um cancelamento nunca vire estorno caso a Venda seja capturada entre a sua leitura e a chamada.
Campos extras no corpo (como amount) devolvem 400. Sem X-Idempotency-Key, ou com intent fora do enum, a API devolve 422 com invalid_request. Reenviar a mesma chave com o mesmo corpo devolve 202 com o estado atual da Venda.
Casos de 409:
idempotency_key_payload_mismatch: a chave já foi usada com outro corpo ou em outra operação.purchase_operation_in_progress: já existe uma operação em andamento e você enviou uma chave nova.purchase_intent_mismatch:cancelem Vendapaid, ourefundem Venda com cartões apenas pré-autorizados. Nenhum valor é movimentado.purchase_invalid_state: estado misto, Vendafailedoucancelled, ou sem saldo estornável.
Headers
Chave de idempotência do cancelamento ou do estorno
1 - 255Path Parameters
Identificador da Venda
Body
Corpo opcional do cancelamento ou do estorno
Intenção da chamada. Ausente ou vazia, a Malga decide pelo estado da Venda.
cancel: cancela as pré-autorizações de uma Vendapending. A Venda terminacancelled.refund: estorna o valor integral de uma Vendapaid. A Venda permanecepaid.
cancel, refund Response
Cancelamento ou estorno aceito. Numa repetição idempotente, a operação pode já estar processing
Venda paga com 2 ou 3 cartões
Identificador da Venda
Identificador do merchant da Venda
Valor total da Venda em centavos
x >= 200BRL Indica o modo de captura informado na criação. false exige captura explícita; true captura automaticamente
Status da Venda
pending, paid, failed, cancelled 2 - 3 elementsShow child attributes
Show child attributes
Sinal de que a Venda precisa de revisão. A Venda permanece pending e você deve interromper o polling automático
Show child attributes
Show child attributes
Operação pending ou processing em andamento na Venda (a mais recente). Omitido quando não há operação ativa. Nas respostas 202, a operação aceita vem em operation
Show child attributes
Show child attributes
Identificador do pedido no seu sistema
Session de origem informada na criação
Metadados informados na criação. Omitido quando não enviados
Regras de split informadas na criação. Omitido quando não enviadas
Show child attributes
Show child attributes
Operação assíncrona aceita por esta chamada. Na criação, vem com type: authorize e pode ser omitida numa repetição idempotente
Show child attributes
Show child attributes
Was this page helpful?