Listar contestação - Autoatendimento MED

Este endpoint permite ao usuário pagador listar as notificações 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 GET \
     --url 'https://api-mtls.sandbox.bankly.com.br/pix/branches/0001/accounts/12345678/infractions?status=Analysis&order=ASC&page=1&pageSize=100' \
     --header 'Authorization: Token' \
     --header 'accept: application/json' \
     --header 'api-version: 1' \
     --header 'x-bkly-pix-user-id: 12312312387' \
     --header 'x-correlation-id: bf700e6e-88a6-4368-a392-420e6726effa'

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.	Informe somente números.

Parâmetros da rota (Path)

Nome	Descrição	Especificação
`branch`	Obrigatório. Agência do pagador.	—
`account`	Obrigatório. Conta do pagador.	—

Corpo da requisição (Body)

No body, envie o seguinte campo em formato JSON:

Nome	Tipo	Descrição
`order`	`string`	Enum: "ASC" (do mais antigo para o mas recente) "DESC" (do mais recente para o mas antigo) Default: ASC
`page`	`string`	Página inicial da listagem Default: 1
`pageSize`	`date`	Número de itens por listagem Default: 100

Nome

Tipo

Descrição

order

string

Enum: "ASC" (do mais antigo para o mas recente) "DESC" (do mais recente para o mas antigo)

Default: ASC

page

string

Página inicial da listagem Default: 1

pageSize

date

Número de itens por listagem Default: 100

Resposta (Response)

O status code 200 indicará sucesso na consulta das contestações.

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

Nome	Tipo	Descrição
`page`	`Objeto`	Objeto de detalhes da consulta paginada.
`page.total`	`Integer`	Número total de páginas.
`page.size`	`Integer`	Número total de itens
`page.index`	`Integer`	Página atual
`data`	`Array`	Lista de Itens
`data.infractionReportId`	`String`	Identificador de Notificação de Infração
`data.protocol`	`Objeto`	Objeto do protocolo
`data.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
`data.protocol.openDate`	`String`	Data/hora de abertura da contestação
`data.recipient`	`Objeto`	Objeto com os dados do recebedor
`data.recipient.name`	`String`	Nome do usuário recebedor. (140 caracteres)
`data.originalAmount`	`Objeto`	Objeto que detalha o valor da transação original que está sendo contestada
`data.originalAmount.value`	`Number`	Valor da transação original.
`data.originalAmount.currency`	`String`	Sigla da moeda.
`data.refundedAmount`	`Objeto`	Valor efetivamente devolvido, no caso de contestação aprovada e devolução realizada
`data.refundedAmount.value`	`Number`	Valor efetivamente devolvido.
`data.refundedAmount.currency`	`String`	Sigla da moeda.
`data.status`	`String`	Status da notificação de infração. `Analysis`, `Approved`, `Rejected`, `Canceled`

{
  "page": {
    "total": 10,
    "size": 100,
    "index": 2
  },
  "data": [
    {
      "infractionReportId": "f6b8a9e2-5f4c-4d3b-8e2a-1c2d3e4f5a6b",
      "protocol": {
        "number": "20250712175650999455",
        "openDate": "2025-07-12T17:56:50.999Z"
      },
      "recipient": {
        "name": "João da Silva"
      },
      "originalAmount": {
        "value": 150.75,
        "currency": "BRL"
      },
      "refundedAmount": {
        "value": 100.75,
        "currency": "BRL"
      },
      "status": "Analysis"
    }
  ]
}

👍
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.