Obter informações por QRCode PIX

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 — —

Request

Parâmetros

Nome	Em	Tipo	Obrigatório	Descrição	Exemplo
`id`	path	`string`	obrigatório	—	`3fa85f64-5717-4562-b3fc-2c963f66afa6`
`qrCode`	query	`string`	opcional	—	`valor`
`intendedPaymentDate`	query	`string (date-time)`	opcional	—	`valor`

Corpo da requisição

Este endpoint não recebe corpo.

Response

Resposta 200.

Campos

Campo	Tipo	Obrigatório	Descrição	Valores	Exemplo
`pixKey`	`string`	opcional	—	—	`"texto"`
`pixKeyType`	`objeto`	opcional	—	varia conforme o tipo — ver exemplo	`"NaturalRegistrationNumber"`
`pixKeyTypeDisplay`	`string`	opcional	—	—	`"texto"`
`endToEndId`	`string`	opcional	—	—	`"3fa85f64-5717-4562-b3fc-2c963f66afa6"`
`beneficiary`	`objeto`	opcional	—	objeto — ver detalhe abaixo	`{ … }`
`payer`	`objeto`	opcional	—	objeto — ver detalhe abaixo	`{ … }`
`valueInCents`	`integer (int64)`	opcional	—	—	`0`
`originalValueInCents`	`integer (int64)`	opcional	—	—	`0`
`interestValueInCents`	`integer (int64)`	opcional	—	—	`0`
`assessmentValueInCents`	`integer (int64)`	opcional	—	—	`0`
`discountValueInCents`	`integer (int64)`	opcional	—	—	`0`
`rebateValueInCents`	`integer (int64)`	opcional	—	—	`0`
`dueDate`	`string (date-time)`	opcional	—	—	`"2025-08-11T13:45:00Z"`
`validityAfterExpiration`	`integer`	opcional	—	—	`1`
`txId`	`string`	opcional	—	—	`"3fa85f64-5717-4562-b3fc-2c963f66afa6"`
`info`	`string`	opcional	—	—	`"texto"`
`qrCodeType`	`string`	opcional	—	—	`"texto"`
`pixType`	`string`	opcional	—	—	`"texto"`
`recurrenceData`	`objeto`	opcional	—	varia conforme o tipo — ver exemplo	`{ … }`

Detalhe de `beneficiary`

Campo	Tipo	Obrigatório	Descrição	Valores	Exemplo
`agency`	`string`	opcional	—	—	`"texto"`
`accountNumber`	`string`	opcional	—	—	`"texto"`
`accountType`	`string`	opcional	—	`CheckingAccount`, `SalaryAccount`, `SavingsAccount`, `Transactional`	`"CheckingAccount"`
`accountTypeDisplay`	`string`	opcional	—	—	`"texto"`
`ispb`	`string`	opcional	—	—	`"texto"`
`personType`	`string`	opcional	—	`Natural`, `Legal`	`"Natural"`
`personTypeDisplay`	`string`	opcional	—	—	`"texto"`
`registrationNumber`	`string`	opcional	—	—	`"12345678909"`
`name`	`string`	opcional	—	—	`"Fulano de Tal"`
`bankName`	`string`	opcional	—	—	`"Fulano de Tal"`

Detalhe de `payer`

Campo	Tipo	Obrigatório	Descrição	Valores	Exemplo
`personType`	`string`	opcional	—	`Natural`, `Legal`	`"Natural"`
`personTypeDisplay`	`string`	opcional	—	—	`"texto"`
`registrationNumber`	`string`	opcional	—	—	`"12345678909"`
`name`	`string`	opcional	—	—	`"Fulano de Tal"`

Exemplo de resposta

{
  "pixKey": "texto",
  "pixKeyType": "NaturalRegistrationNumber",
  "pixKeyTypeDisplay": "texto",
  "endToEndId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "beneficiary": {
    "agency": "texto",
    "accountNumber": "texto",
    "accountType": "CheckingAccount",
    "accountTypeDisplay": "texto",
    "ispb": "texto",
    "personType": "Natural",
    "personTypeDisplay": "texto",
    "registrationNumber": "12345678909",
    "name": "Fulano de Tal",
    "bankName": "Fulano de Tal"
  },
  "payer": {
    "personType": "Natural",
    "personTypeDisplay": "texto",
    "registrationNumber": "12345678909",
    "name": "Fulano de Tal"
  },
  "valueInCents": 0,
  "originalValueInCents": 0,
  "interestValueInCents": 0,
  "assessmentValueInCents": 0,
  "discountValueInCents": 0,
  "rebateValueInCents": 0,
  "dueDate": "2025-08-11T13:45:00Z",
  "validityAfterExpiration": 1,
  "txId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "info": "texto",
  "qrCodeType": "texto",
  "pixType": "texto",
  "recurrenceData": {
    "recurrenceId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "journey": "JORNADA_1",
    "journeyDisplay": "texto",
    "retry": "texto",
    "amountValueInCents": 0,
    "minimumAmountValueInCents": 0,
    "receiverBankIspb": "texto",
    "receiverName": "Fulano de Tal",
    "receiverRegistrationNumber": "texto",
    "payerCpf": "12345678909",
    "payerBankRegistrationNumber": "texto",
    "payerBankName": "Fulano de Tal",
    "firstRecurrenceDate": "2025-08-11T13:45:00Z",
    "lastRecurrenceDate": "2025-08-11T13:45:00Z",
    "periodicity": "MIAN",
    "contractNumber": "texto",
    "description": "texto",
    "updates": [
      {
        "updateDateTime": "2025-08-11T13:45:00Z",
        "status": "texto"
      }
    ]
  }
}

Códigos de retorno

Código	Significado	Detalhe do contrato
`200`	Requisição bem-sucedida.	—

Exemplos

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

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/QRCode`, {
  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