Cancelar Pagamento

Cancelar pagamento

PUT /api/v1/payments/{paymentId}/cancel

Cancela uma transação de pagamento a partir do seu identificador.

Requer autenticação mTLS. Veja Autenticação.

Request

Parâmetros de rota

Parâmetro	Tipo	Obrigatório	Exemplo
`paymentId`	string	sim	`8f14e45f-ceea-467e-9a9f-1d1a3c1e5b3a`

Response

`200 OK`

{
  "codigo": "0",
  "mensagem": "Cancelamento efetuado com sucesso",
  "codigoAutorizacao": "00",
  "mensagemAutorizador": "Cancelamento aprovado",
  "status": "CAN",
  "identicadorPagamentoAdquirente": "a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6q7r8s9t0u1v2w3x4y5z6a7b8c9d0e1f2",
  "identificadorPagamento": "PAG-20250723-0001",
  "bandeiraCartao": "1",
  "codigoAdquirente": "1",
  "nomeAdquirente": "Rede",
  "dataAutorizacao": "23/07/2026T14:40",
  "numeroAutorizacao": "123456",
  "merchantUsn": "123456789012",
  "esitefUsn": "123456789012345",
  "hostUsn": "123456789012345",
  "valor": "15000",
  "tipoPagamento": "C",
  "esitefDate": "23/07/2026T14:41",
  "isHostCancel": "false"
}

Diferente dos demais endpoints de pagamento, aqui valor é uma string em centavos (ex.: "15000" = R$ 150,00), não um number em reais.

Campos da resposta

Campo	Tipo	Descrição
`codigo`	string	Código de resposta. Diferente de `0` significa falha
`mensagem`	string	Mensagem de resposta
`codigoAutorizacao`	string	Código de resposta do autorizador. Retornado apenas com autenticação por assinatura
`mensagemAutorizador`	string	Mensagem de resposta do autorizador. Retornado apenas com autenticação por assinatura
`status`	enum	Status do cancelamento — ver Status de transação
`identicadorPagamentoAdquirente`	string	Identificador do cancelamento na adquirente (nit)
`identificadorPagamento`	string	order_id do pagamento original
`cupomCliente`	string	Cupom fiscal via cliente (customer_receipt)
`cupomEstabelecimento`	string	Cupom fiscal via estabelecimento (merchant_receipt)
`bandeiraCartao`	string	Código da bandeira utilizada na transação original
`codigoAdquirente`	string	Código da adquirente (acquirer_id)
`nomeAdquirente`	string	Nome da adquirente (acquirer_name)
`dataAutorizacao`	string	Data de efetivação retornada pelo autorizador, `DD/MM/AAAA'T'HH:mm`
`numeroAutorizacao`	string	Número de autorização do cancelamento
`merchantUsn`	string	Número sequencial único do pedido original, enviado pela loja
`esitefUsn`	string	Número sequencial único do cancelamento no e-SiTef
`hostUsn`	string	NSU da autorizadora (host_usn)
`tid`	string	ID da transação na adquirente. Retornado apenas em adquirentes externas ao SiTef
`valor`	string	Valor cancelado em centavos (ex.: `"15000"` = R$ 150,00)
`tipoPagamento`	enum	`B` boleto, `C` crédito, `D` débito, `P` private label, `T` transferência, `G` gift, `O` outros, `W` boleto NR
`esitefDate`	string	Data de efetivação do cancelamento, `DD/MM/AAAA'T'HH:mm`
`isHostCancel`	string	`"true"` quando o cancelamento foi realizado via host

Erros

Status	Significado
`404`	Pagamento não encontrado para o `paymentId` informado
`409`	Pagamento não pode ser cancelado no estado atual
`500`	Erro interno ao cancelar o pagamento