GET/v1/BankAccount/{id}/Pay/BankslipFGTS

Banking · Transferências

Obtém os dados de um boleto FGTS informando código de barras, ou linha digitável

Lista e filtra registros de Bank Account.

Visão geral

Obtém os dados de um boleto FGTS informando código de barras, ou linha digitável.

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

Request

Parâmetros

Nome	Em	Tipo	Obrigatório	Descrição	Exemplo
`id`	path	`string`	obrigatório	Id da conta	`3fa85f64-5717-4562-b3fc-2c963f66afa6`
`BarCode`	query	`string`	opcional	—	`valor`
`DigitableLine`	query	`string`	opcional	—	`valor`

Corpo da requisição

Este endpoint não recebe corpo.

Response

Resposta 200.

Campos

Campo	Tipo	Obrigatório	Descrição	Valores	Exemplo
`barCode`	`string`	opcional	—	—	`"texto"`
`digitableLine`	`string`	opcional	—	—	`"texto"`
`situationCode`	`integer`	opcional	—	—	`0`
`reason`	`string`	opcional	—	—	`"texto"`
`authorizationTypeReceiptDivergentValue`	`objeto`	opcional	—	varia conforme o tipo — ver exemplo	`"QualquerValor"`
`discount`	`integer (int64)`	opcional	—	—	`0`
`discountValue`	`integer (int64)`	opcional	—	—	`0`
`rebateValue`	`integer (int64)`	opcional	—	—	`0`
`fee`	`integer (int64)`	opcional	—	—	`0`
`trafficTicket`	`integer (int64)`	opcional	—	—	`0`
`maximumValue`	`integer (int64)`	opcional	—	—	`0`
`minimumValue`	`integer (int64)`	opcional	—	—	`0`
`totalValue`	`integer (int64)`	opcional	—	—	`0`
`nominalValue`	`integer (int64)`	opcional	—	—	`0`
`partialPaymentIndicator`	`string`	opcional	—	—	`"texto"`
`value`	`integer (int64)`	opcional	—	—	`0`
`dueDate`	`string (date-time)`	opcional	—	—	`"2025-08-11T13:45:00Z"`
`paymentDeadline`	`string (date-time)`	opcional	—	—	`"2025-08-11T13:45:00Z"`
`dateTimeBillingConsult`	`string (date-time)`	opcional	—	—	`"2025-08-11T13:45:00Z"`
`statusBilling`	`objeto`	opcional	—	varia conforme o tipo — ver exemplo	`"PaidBilling"`
`beneficiary`	`objeto`	opcional	—	objeto — ver detalhe abaixo	`{ … }`
`payer`	`objeto`	opcional	—	objeto — ver detalhe abaixo	`{ … }`
`guarantor`	`objeto`	opcional	—	objeto — ver detalhe abaixo	`{ … }`
`issuingBank`	`objeto`	opcional	—	objeto — ver detalhe abaixo	`{ … }`
`notifications`	`array de objeto`	opcional	—	objeto — ver detalhe abaixo	`[ … ]`

Detalhe de `beneficiary`

Campo	Tipo	Obrigatório	Descrição	Valores	Exemplo
`name`	`string`	opcional	—	—	`"Fulano de Tal"`
`document`	`string`	opcional	—	—	`"12345678909"`

Detalhe de `payer`

Campo	Tipo	Obrigatório	Descrição	Valores	Exemplo
`name`	`string`	opcional	—	—	`"Fulano de Tal"`
`document`	`string`	opcional	—	—	`"12345678909"`

Detalhe de `guarantor`

Campo	Tipo	Obrigatório	Descrição	Valores	Exemplo
`name`	`string`	opcional	—	—	`"Fulano de Tal"`
`document`	`string`	opcional	—	—	`"12345678909"`

Detalhe de `issuingBank`

Campo	Tipo	Obrigatório	Descrição	Valores	Exemplo
`code`	`string`	opcional	—	—	`"texto"`
`name`	`string`	opcional	—	—	`"Fulano de Tal"`

Detalhe de `notifications`

Campo	Tipo	Obrigatório	Descrição	Valores	Exemplo
`property`	`string`	opcional	—	—	`"texto"`
`message`	`string`	opcional	—	—	`"texto"`

Exemplo de resposta

{
  "barCode": "texto",
  "digitableLine": "texto",
  "situationCode": 0,
  "reason": "texto",
  "authorizationTypeReceiptDivergentValue": "QualquerValor",
  "discount": 0,
  "discountValue": 0,
  "rebateValue": 0,
  "fee": 0,
  "trafficTicket": 0,
  "maximumValue": 0,
  "minimumValue": 0,
  "totalValue": 0,
  "nominalValue": 0,
  "partialPaymentIndicator": "texto",
  "value": 0,
  "dueDate": "2025-08-11T13:45:00Z",
  "paymentDeadline": "2025-08-11T13:45:00Z",
  "dateTimeBillingConsult": "2025-08-11T13:45:00Z",
  "statusBilling": "PaidBilling",
  "beneficiary": {
    "name": "Fulano de Tal",
    "document": "12345678909"
  },
  "payer": {
    "name": "Fulano de Tal",
    "document": "12345678909"
  },
  "guarantor": {
    "name": "Fulano de Tal",
    "document": "12345678909"
  },
  "issuingBank": {
    "code": "texto",
    "name": "Fulano de Tal"
  },
  "notifications": [
    {
      "property": "texto",
      "message": "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/Pay/BankslipFGTS" \
  -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/Pay/BankslipFGTS";

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