Obter registro de pagamentos agendados do pix automático

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`
`status`	query	`objeto`	opcional	—	`Scheduled`
`page`	query	`integer`	opcional	—	`10`
`size`	query	`integer`	opcional	—	`10`
`isDeleted`	query	`boolean`	opcional	—	`true`
`orderBy`	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
`data`	`array de objeto`	opcional	—	objeto — ver detalhe abaixo	`[ … ]`
`page`	`integer`	opcional	—	—	`0`
`totalPages`	`integer`	opcional	—	—	`0`
`totalItems`	`integer`	opcional	—	—	`0`

Detalhe de `data`

Campo	Tipo	Obrigatório	Descrição	Valores	Exemplo
`transfer`	`objeto`	opcional	—	varia conforme o tipo — ver exemplo	`{ … }`
`automaticPix`	`objeto`	opcional	—	varia conforme o tipo — ver exemplo	`{ … }`

Exemplo de resposta

{
  "data": [
    {
      "transfer": {
        "id": "texto",
        "createdAt": "2025-08-11T13:45:00Z",
        "createdBy": {},
        "tenant": "texto",
        "tenantDisplay": "texto",
        "updatedAt": "2025-08-11T13:45:00Z",
        "updatedBy": {},
        "ownerUser": {},
        "ownerGroup": {},
        "nsu": "texto",
        "amount": 0,
        "transferDate": "2025-08-11T13:45:00Z",
        "paymentPurpose": {},
        "paymentPurposeDisplay": "texto",
        "status": {},
        "statusDisplay": "texto",
        "accountingEntry": "texto",
        "errorMessage": "texto",
        "reversalCodeReason": "texto",
        "reversalDescriptionReason": "texto",
        "bankAccountBeneficiaryId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "bankAccountBeneficiary": {},
        "authorizedAt": "2025-08-11T13:45:00Z",
        "bankAccountId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "requester": {},
        "approvals": []
      },
      "automaticPix": {
        "id": "texto",
        "bankAccountId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "bankAccount": {},
        "automaticPixItemId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "automaticPixItem": {},
        "status": {},
        "statusDisplay": "texto",
        "amount": 0,
        "sequenceType": {},
        "frequencyType": {},
        "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
      }
    }
  ],
  "page": 0,
  "totalPages": 0,
  "totalItems": 0
}

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/ScheduledPayments" \
  -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/ScheduledPayments";

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