Listar recuperações de valores (Autoatendimento MED)

Lista e filtra registros de Bank Account.

Visão geral

Autenticação e pré-requisitos

Requer autenticação. Envie o token no header Authorization: Bearer {{token}} (JWT do AWS Cognito). Integrações servidor-a-servidor podem usar X-Api-Key. Todo tráfego é HTTPS e a credencial nunca vai na URL nem em query string.

Pré-requisitos: a rota exige identificador(es) de recurso já existente(s):

id — Id da conta bancária (Partner Context)

Request

Parâmetros

Nome	Em	Tipo	Obrigatório	Descrição	Exemplo
`id`	path	`string`	obrigatório	Id da conta bancária (Partner Context)	`3fa85f64-5717-4562-b3fc-2c963f66afa6`
`startDate`	query	`string (date-time)`	opcional	Data inicial do filtro	`valor`
`endDate`	query	`string (date-time)`	opcional	Data final do filtro	`valor`
`status`	query	`objeto`	opcional	Status da recuperação	`valor`
`page`	query	`integer`	opcional	Página da listagem	`10`
`size`	query	`integer`	opcional	Tamanho da página	`10`

Corpo da requisição

Este endpoint não recebe corpo.

Response

Resposta 200.

Campos

Campo	Tipo	Obrigatório	Descrição	Valores	Exemplo
`pagination`	`objeto`	opcional	—	varia conforme o tipo — ver exemplo	`{ … }`
`items`	`array de objeto`	opcional	—	objeto — ver detalhe abaixo	`[ … ]`

Detalhe de `items`

Campo	Tipo	Obrigatório	Descrição	Valores	Exemplo
`recoveryId`	`string`	opcional	—	—	`"3fa85f64-5717-4562-b3fc-2c963f66afa6"`
`bankIspb`	`string`	opcional	—	—	`"texto"`
`originalEndToEndId`	`string`	opcional	—	—	`"3fa85f64-5717-4562-b3fc-2c963f66afa6"`
`receiverName`	`string`	opcional	—	—	`"Fulano de Tal"`
`originalAmount`	`integer (int64)`	opcional	—	—	`0`
`refundedAmount`	`integer (int64)`	opcional	—	—	`0`
`status`	`string`	opcional	—	`NONE`, `CREATED`, `TRACKED`, `AWAITING_ANALYSIS`, `ANALYSED`, `REFUNDING`, `COMPLETED`, `CANCELLED`	`"NONE"`
`createdAt`	`string (date-time)`	opcional	—	—	`"2025-08-11T13:45:00Z"`
`updatedAt`	`string (date-time)`	opcional	—	—	`"2025-08-11T13:45:00Z"`

Exemplo de resposta

{
  "pagination": {
    "currentPage": 0,
    "itemsPerPage": 0,
    "totalPages": 0
  },
  "items": [
    {
      "recoveryId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "bankIspb": "texto",
      "originalEndToEndId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "receiverName": "Fulano de Tal",
      "originalAmount": 0,
      "refundedAmount": 0,
      "status": "NONE",
      "createdAt": "2025-08-11T13:45:00Z",
      "updatedAt": "2025-08-11T13:45:00Z"
    }
  ]
}

Códigos de retorno

Código	Significado	Detalhe do contrato
`200`	Requisição bem-sucedida.	—
`400`	Requisição inválida (validação de campos ou regra de negócio).	—
`404`	Recurso não encontrado.	—

Exemplos

curl -X GET "{{baseUrl}}/v1/BankAccount/3fa85f64-5717-4562-b3fc-2c963f66afa6/Pix/Med/Recover/SelfService/List" \
  -H "Authorization: Bearer {{token}}"

var baseUrl = "{{baseUrl}}";
var token   = "{{token}}";

using var http = new HttpClient { BaseAddress = new Uri(baseUrl) };
http.DefaultRequestHeaders.Authorization =
    new AuthenticationHeaderValue("Bearer", token);

var rota = "/v1/BankAccount/3fa85f64-5717-4562-b3fc-2c963f66afa6/Pix/Med/Recover/SelfService/List";

var resp = await http.GetAsync(rota);
resp.EnsureSuccessStatusCode();
var json = await resp.Content.ReadAsStringAsync();

const baseUrl = '{{baseUrl}}';
const token   = '{{token}}';

const resp = await fetch(`${baseUrl}/v1/BankAccount/3fa85f64-5717-4562-b3fc-2c963f66afa6/Pix/Med/Recover/SelfService/List`, {
  method: 'GET',
  headers: {
    'Authorization': `Bearer ${token}`,
  },
});

if (!resp.ok) throw new Error(`HTTP ${resp.status}`);
const data = await resp.json();

Troque apenas {{baseUrl}} e {{token}}. No Postman, defina-os como variáveis de environment; o cURL importa em Import > Raw text.

Downloads

Este endpoint já vem configurado nas collections abaixo, na pasta da etapa correspondente.

Collection completaConsignado privado e FGTS, em pastas espelhando a documentação.Baixar →Environment do PostmanAs variáveis fora da collection, para versionar uma sem versionar o token.Baixar →Documentação consolidada para LLMToda a documentação em um arquivo de texto, na ordem da navegação.Baixar →Referência em MarkdownEste contrato, campo a campo, gerado do spec.Baixar →

Guia de importação: Como importar no Postman · Todos os downloads: Downloads