Obter registro de recorrência de um pix automático

Consulta Bank Account pelo identificador informado na rota.

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

Request

Parâmetros

Nome	Em	Tipo	Obrigatório	Descrição	Exemplo
`id`	path	`string`	obrigatório	—	`3fa85f64-5717-4562-b3fc-2c963f66afa6`
`automaticPixId`	path	`string`	obrigatório	—	`3fa85f64-5717-4562-b3fc-2c963f66afa6`

Corpo da requisição

Este endpoint não recebe corpo.

Response

Resposta 200.

Campos

Campo	Tipo	Obrigatório	Descrição	Valores	Exemplo
`id`	`string`	opcional	—	—	`"texto"`
`bankAccountId`	`string`	opcional	—	—	`"3fa85f64-5717-4562-b3fc-2c963f66afa6"`
`bankAccount`	`objeto`	opcional	—	varia conforme o tipo — ver exemplo	`{ … }`
`automaticPixItemId`	`string`	opcional	—	—	`"3fa85f64-5717-4562-b3fc-2c963f66afa6"`
`automaticPixItem`	`objeto`	opcional	—	varia conforme o tipo — ver exemplo	`{ … }`
`status`	`string`	opcional	—	`Processing`, `Confirmed`, `Rejected`, `Canceled`, `PendingPayer`, `PendingUser`, `Activated`, `CancellationRequested`	`"Processing"`
`statusDisplay`	`string`	opcional	—	—	`"texto"`
`amount`	`integer (int64)`	opcional	—	—	`0`
`sequenceType`	`string`	opcional	—	`RCUR`	`"RCUR"`
`frequencyType`	`string`	opcional	—	`MIAN`, `MNTH`, `QURT`, `WEEK`, `YEAR`	`"MIAN"`
`frequencyTypeDisplay`	`string`	opcional	—	—	`"texto"`
`firstRecurrenceDate`	`string (date-time)`	opcional	—	—	`"2025-08-11T13:45:00Z"`
`lastRecurrenceDate`	`string (date-time)`	opcional	—	—	`"2025-08-11T13:45:00Z"`
`recurrenceId`	`string`	opcional	—	—	`"3fa85f64-5717-4562-b3fc-2c963f66afa6"`
`contractNumber`	`string`	opcional	—	—	`"texto"`
`receivingUserName`	`string`	opcional	—	—	`"Fulano de Tal"`
`receivingUserRegistrationNumber`	`string`	opcional	—	—	`"texto"`
`receivingBankISPB`	`string`	opcional	—	—	`"texto"`
`isDeleted`	`boolean`	opcional	—	—	`true`

Exemplo de resposta

{
  "id": "texto",
  "bankAccountId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "bankAccount": {
    "id": "texto",
    "createdAt": "2025-08-11T13:45:00Z",
    "createdBy": {
      "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "registrationNumber": "12345678909",
      "userIdDisplay": "texto",
      "tenantDisplay": "texto",
      "tenantName": "Fulano de Tal"
    },
    "tenant": "texto",
    "tenantDisplay": "texto",
    "updatedAt": "2025-08-11T13:45:00Z",
    "updatedBy": {
      "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "registrationNumber": "12345678909",
      "userIdDisplay": "texto",
      "tenantDisplay": "texto",
      "tenantName": "Fulano de Tal"
    },
    "ownerUser": {
      "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "registrationNumber": "12345678909",
      "userIdDisplay": "texto",
      "tenantDisplay": "texto",
      "tenantName": "Fulano de Tal"
    },
    "ownerGroup": {
      "groupDisplay": "texto",
      "tenantDisplay": "texto"
    },
    "bankCode": 0,
    "bankCodeDisplay": "texto",
    "bankIspb": 0,
    "account": "texto",
    "agency": "texto",
    "type": "PaymentAccount",
    "typeDisplay": "texto",
    "modality": "NaturalCheckingAccount",
    "modalityDisplay": "texto",
    "quorumMinimumApproval": 0,
    "externalId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "tenantName": "Fulano de Tal",
    "isDeleted": true,
    "status": "Active",
    "statusDisplay": "texto",
    "person": {
      "id": "texto",
      "createdAt": "2025-08-11T13:45:00Z",
      "createdBy": {
        "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "registrationNumber": "12345678909",
        "userIdDisplay": "texto",
        "tenantDisplay": "texto",
        "tenantName": "Fulano de Tal"
      },
      "tenant": "texto",
      "tenantDisplay": "texto",
      "updatedAt": "2025-08-11T13:45:00Z",
      "updatedBy": {
        "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "registrationNumber": "12345678909",
        "userIdDisplay": "texto",
        "tenantDisplay": "texto",
        "tenantName": "Fulano de Tal"
      },
      "ownerUser": {
        "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "registrationNumber": "12345678909",
        "userIdDisplay": "texto",
        "tenantDisplay": "texto",
        "tenantName": "Fulano de Tal"
      },
      "ownerGroup": {
        "groupDisplay": "texto",
        "tenantDisplay": "texto"
      },
      "registrationNumber": "12345678909",
      "name": "Fulano de Tal"
    },
    "balance": {
      "currentBalance": 0,
      "blockedBalance": 0,
      "available": 0,
      "bankAccount": {
        "bankCode": 0,
        "bankIspb": 0,
        "bankCodeDisplay": "texto",
        "type": {},
        "typeDisplay": "texto",
        "modality": {},
        "modalityDisplay": "texto",
        "account": 0,
        "agency": 0,
        "personRegistrationNumber": "texto",
        "personName": "Fulano de Tal",
        "isDeleted": true,
        "status": {},
        "creditors": []
      }
    },
    "creditors": [
      {
        "id": "texto",
        "name": "Fulano de Tal",
        "tenant": "texto"
      }
    ]
  },
  "automaticPixItemId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "automaticPixItem": {
    "id": "texto",
    "createdAt": "2025-08-11T13:45:00Z",
    "mandanteIdentification": "texto",
    "mandanteRequestIdentification": "texto",
    "occurrencesSequenceType": "texto",
    "occurrencesFrequency": "MIAN",
    "occurrencesFirstRecurrenceDate": "2025-08-11T13:45:00Z",
    "occurrencesFinalRecurrenceDate": "2025-08-11T13:45:00Z",
    "trackingIndicator": true,
    "collectionAmount": 0,
    "creditorName": "Fulano de Tal",
    "creditorIdentification": "texto",
    "creditorAgentMemberIdentification": "texto",
    "debtoIdentification": "texto",
    "debtorAccountIdentification": "texto",
    "debtorAccountIssuer": "texto",
    "debtorAgentMemberIdentification": "texto",
    "ultimateDebtorName": "Fulano de Tal",
    "ultimateIdentification": "texto",
    "createConfirmationRequestDate": "2025-08-11T13:45:00Z",
    "referredDocumentNumber": "texto",
    "referredDocumentCreditorReference": "texto",
    "createRecurrencePeriodicPaymentDate": "2025-08-11T13:45:00Z",
    "confirmationRequestExpirationDate": "2025-08-11T13:45:00Z",
    "maxColletionAmount": 0
  },
  "status": "Processing",
  "statusDisplay": "texto",
  "amount": 0,
  "sequenceType": "RCUR",
  "frequencyType": "MIAN",
  "frequencyTypeDisplay": "texto",
  "firstRecurrenceDate": "2025-08-11T13:45:00Z",
  "lastRecurrenceDate": "2025-08-11T13:45:00Z",
  "recurrenceId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "contractNumber": "texto",
  "receivingUserName": "Fulano de Tal",
  "receivingUserRegistrationNumber": "texto",
  "receivingBankISPB": "texto",
  "isDeleted": true
}

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/Automatic/3fa85f64-5717-4562-b3fc-2c963f66afa6" \
  -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/Automatic/3fa85f64-5717-4562-b3fc-2c963f66afa6";

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/Automatic/3fa85f64-5717-4562-b3fc-2c963f66afa6`, {
  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