API Docs Início Documentação Referência de API Copiar para LLM
GET/v1/BankAccount/{id}/Pix/MED/Reporter/Refunds
Banking · PIX

Devoluções associadas à operação de um relato (RELATOR)

Lista e filtra registros de Bank Account.

Visão geral

Devoluções associadas à operação de um relato (RELATOR).

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):

Request

Parâmetros

NomeEmTipoObrigatórioDescriçãoExemplo
idpathstringobrigatório3fa85f64-5717-4562-b3fc-2c963f66afa6
codAgenciaquerystringopcionalvalor
nroContaquerystringopcionalvalor
cpfCnpjquerystringopcionalvalor
tipoContaquerystringopcionalvalor
idRelatoInfracaoquerystringopcionalvalor
idTransacaoquerystringopcionalvalor

Corpo da requisição

Este endpoint não recebe corpo.

Response

Resposta 200 — retorna uma lista (array) de objetos.

Campos

CampoTipoObrigatórioDescriçãoValoresExemplo
idTransacaostringopcional"texto"
valorOperacaonumber (decimal)opcional1000

Exemplo de resposta

[
  {
    "idTransacao": "texto",
    "valorOperacao": 1000
  }
]

Códigos de retorno

CódigoSignificadoDetalhe do contrato
200Requisição bem-sucedida.

Exemplos

curl -X GET "{{baseUrl}}/v1/BankAccount/3fa85f64-5717-4562-b3fc-2c963f66afa6/Pix/MED/Reporter/Refunds" \
  -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/Reporter/Refunds";

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/Reporter/Refunds`, {
  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.

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