Consultar detalhes da contestação

Este endpoint permite ao usuário pagador consultar os detalhes de uma notificação de infração.

Requisição (Request)

Requisição HTTP

GET https://api-mtls.sandbox.bankly.com.br/pix/branches/{branch}/accounts/{account}/infractions

curl --request POST \
     --url https://api-mtls.sandbox.bankly.com.br/pix/scheduling-payments \
     --header 'accept: application/json' \
     --header 'api-version: 1' \
     --header 'content-type: application/json'

Autorização

Para garantir a segurança nas requisições, todos os endpoints do Bankly utilizam scopes como parte do seu fluxo de autorização.

Esta requisição requer o scope descrito a seguir:

Scope	Descrição
`pix.infraction-notifications.read`	Concede acesso para listar as notificações de infração.

Cabeçalhos (Headers)

Nome	Descrição	Especificação
`api-version`	Obrigatório. Versão da API. Atualmente estamos na versão 1.	—
`Authorization`	Obrigatório. Token de autorização do tipo Bearer.	—
`x-bkly-pix-user-id`	Obrigatório. Número do documento do usuário que está fazendo a requisição.	`^([0-9]{11}\|[A-Z0-9]{12}[0-9]{2})$`
`x-company-key`	Company Key do parceiro que está fazendo a requisição

Parâmetros da rota (Path)

Nome	Descrição	Especificação
`branch`	Obrigatório. Agência do pagador.	—
`account`	Obrigatório. Conta do pagador.	—
`protocolNumber`	Obrigatório. Número do protocolo	YYYYMMDDhhmmssSSSAAA

Corpo da requisição (Body)

Não é necessário enviar campos no body desta requisição.

Resposta (Response)

O status code 200 indicará sucesso na consulta do detalhe de uma contestação.

Sendo bem-sucedido, o retorno irá trazer os seguintes campos em formato JSON:

Nome	Tipo	Descrição
`endToEndId`	`String`	E2E da transação original
`protocol`	`Objeto`	Objeto do protocolo
`protocol.number`	`String`	YYYYMMDDhhmmssSSSAAA: Sendo “YYYY” o ano; “MM” o mês; “DD” o dia; “hh” a hora; “mm” o minuto; “ss” o segundo; “SSS” o milissegundo; “AAA” três dígitos aleatórios. Exemplo: 20250712175650999455
`protocol.openDate`	`String`	Data/hora de abertura da contestação
`recipient`	`Objeto`	Objeto com os dados do recebedor
`recipient.name`	`String`	Nome do usuário recebedor. (140 caracteres)
`requestedAmount`	`Objeto`	Objeto que contem os dados do valor a ser contestado.
`requestedAmount.value`	`Number`	Valor da transação original que está sendo contestada
`requestedAmount.currency`	`String`	Sigla da moeda.
`refundedAmount`	`Objeto`	Objeto que contem os dados do valor efetivamente devolvido.
`refundedAmount.value`	`String`	Valor efetivamente devolvido.
`refundedAmount.currency`	`String`	Sigla da moeda
`status`	`String`	Status da notificação de infração. `Analysis`, `Approved`, `Rejected`, `Canceled`
`limitDate`	`Objeto`	Objeto que retorna as datas relacionadas à notificação de infração.
`limitDate.analysis`	`String`	Data/hora limite para análise da notificação de infração (7 dias após criação da notificação de infração)

{
  "endToEndId": "E5958811120250808184150764PB2233",
  "protocol": {
    "number": "20250712175650999455",
    "openDate": "2025-07-12T17:56:50.999Z"
  },
  "recipient": {
    "name": "João da Silva"
  },
  "requestedAmount": {
    "value": 150.75,
    "currency": "BRL"
  },
  "refundedAmount": {
    "value": 150.75,
    "currency": "BRL"
  },
  "status": "Analysis",
  "limitDate": {
    "analysis": "2025-07-19T17:56:50.999Z"
  }
}

👍
Dica
Para simular uma requisição nesse endpoint, acesse o API Reference.

Erros

Este endpoint pode retornar erros específicos, conforme a tabela a seguir:

Status code	Código	Mensagem	Significado
400	INVALID_PARAMETER	—	Um ou mais campos obrigatórios não foram preenchidos.
400	INVALID_PARAMETER		Um ou mais campos com erro no preenchimento.
403	FORBIDDEN
500	UNEXPECTED_ERROR		Ocorreu um erro inesperado durante o processamento.

Eventos

Este endpoint não possui eventos relacionados a ele.