Cancelar pagamento

💡 Endpoint que processa o cancelamento/estorno de uma venda a partir do seu identificador único (muid).

Se você estiver tentando cancelar uma transação feita há mais de 1 dia, sua devolução será definida como D+N.

Devolução D+N: Devoluções de transações D+N serão aplicadas a transações com mais de um dia. Isso resultará uma transação de reembolso com status PENDENTE.

Fazendo Requisição

A chamada deverá ser feita utilizando o método POST. É necessária a autenticação via Authorization header.

POST/v1/card_payments/void/{muid}

Parâmetros de Requisição

Atributo	Tipo	Descrição	Obrigatório
muid	string	Identificador único da transação	Sim
refund_tracking_number	string	Identificador único opcional gerado pelo cliente para transações de reembolso. Deve ser uma sequência hexadecimal de 32 caracteres. Usado apenas para cancelamentos D+N; ignorado para cancelamentos normais (D0).

Dica: recomendamos usar um UUID v4 (32 caracteres hexadecimais, sem hífens) para este campo, a fim de garantir a exclusividade global e a conformidade com o formato exigido. | Não |

Exemplo de Requisição

POST /v1/card_payments/void/837f389330134109a5b7eb295ed95c42

Request Body

{
  "refund_tracking_number": "string"
}

Sucesso

HTTP 200 Response Body - Exemplo

{
  "muid": "812188b72ff1486498479c1cccd12191",
  "request_token": "E3122044DC3849C1982F5792CFB93211",
  "code": "ACCEPTED",
  "amount": 1,
  "authorization_code": "296181",
  "currency": "BRL",
  "rrn": "010003861000",
  "tracking_number": "00011109171157040010000000324831",
  "brand_response_code": "01",
  "multiacq_id": "021",
  "status": "ok"
}

Eventos Notificados

• O sistema irá enviar notificações para todos os status disponíveis da transação.
• Isso vale para Checkout, PixQrCode e Cartão
• Qualquer mudança de status (Criação, confirmação, cancelamento, etc.) resultará em uma chamada ao webhook configurado na criação da transação.
• As notificações seguirão exatamente o mesmo padrão de dados já utilizados pelo webhook existente, garantindo compatibilidade e consistência na integração.

Entre nesta página para mais detalhes sobre [Webhook - Notificação do cartão](docs/card/wehbook-notification.m

Erros

HTTP 422 Response Body - Unprocessable Entity - Exemplo

{
  "errors": [
      {
          "code": "ALREADY_CANCELED",
          "msg": "The original transaction has already been canceled."
      }
  ],
  "request_token": "5EE75D660C9B4096A4AAC51E2B8393E1",
  "amount": 1,
  "currency": "BRL",
  "transaction_status": "REJECTED",
  "multiacq_id": "021",
  "status": "unprocessable_entity"
}

Atributos de Resposta

Atributo	Tipo	Descrição
muid	string	Identificador único
amount	number	Valor da transação
code	string	Código de resposta
authorization_code	string	Código de autorização
currency	string	Moeda utilizada na transação
tracking_number	string	O trackingNumber é um identificador único usado pelo nosso autorizador
rrn	string	O número de referência
brand_response_code	string	Contém o código de resposta retornado pela bandeira do cartão durante os fluxos de autorização. Presente apenas quando a bandeira do cartão aprovou ou negou a solicitação de autorização
status	string	Status da requisição
errors[n].code	string	Código de erro
errors[n].msg	string	Mensagem de erro