List Pix Recurrences with pagination

​
Query Parameters
  • recurrence
    Type: string enum

    Recurrence frequency filter.

    values
    • WEEKLY
    • BIWEEKLY
    • MONTHLY
  • ispb
    Type: string

    Sender account ISPB.

  • accountNumber
    Type: string
    min length:  
    1
    required

    Sender account number.

  • branch
    Type: string
    min length:  
    1
    required

    Sender account branch.

  • status
    Type: string enum

    Status filter.

    values
    • ACTIVE
    • INACTIVE
    • COMPLETED
    • REJECTED
    • EXPIRED
    • PENDING
  • source
    Type: string enum

    Source filter (MANUAL or PIX_AUTOMATIC).

    values
    • MANUAL
    • PIX_AUTOMATIC
  • mandateId
    Type: string

    Mandate identifier filter.

  • senderTaxId
    Type: string

    Sender tax ID (CPF/CNPJ) filter.

  • receiverTaxId
    Type: string

    Receiver tax ID (CPF/CNPJ) filter.

  • recurrenceId
    Type: string Format: uuid

    Recurrence identifier filter.

  • startDate
    Type: string Pattern: ^\d{4}-\d{2}-\d{2}$

    Start date filter (yyyy-MM-dd). Lower bound for the schedule date.

  • endDate
    Type: string Pattern: ^\d{4}-\d{2}-\d{2}$

    End date filter (yyyy-MM-dd). Upper bound for the schedule date.

  • page
    Type: integer Format: int32

    Page number (0-indexed).

  • size
    Type: integer Format: int32

    Page size.

  • sort
    Type: array string[]

    Sort fields (e.g. scheduledDate,desc).

Headers
  • Idempotency-Key
    Type: string
    required
Responses
  • */*
Request Example for get/api/v1/pix-schedules/recurrences
curl 'http://localhost:8080/api/v1/pix-schedules/recurrences?accountNumber=123456789&branch=0001' \
  --header 'Idempotency-Key: ' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

{
  "items": [
    {
      "id": "string",
      "status": "ACTIVE",
      "createdAt": "string",
      "updatedAt": "string",
      "initiationMethod": "APDN",
      "priority": "HIGH",
      "priorityType": "PAGAGD",
      "purpose": "GSCB",
      "amount": 1,
      "userDescription": "string",
      "sender": {
        "name": "string",
        "document": {
          "type": "CPF",
          "value": "string"
        },
        "account": {
          "ispb": "string",
          "type": "CACC",
          "branch": "string",
          "number": "string"
        }
      },
      "receiver": {
        "key": "string",
        "name": "string",
        "document": {
          "type": "CPF",
          "value": "string"
        },
        "account": {
          "ispb": "string",
          "type": "CACC",
          "branch": "string",
          "number": "string"
        }
      },
      "source": "MANUAL",
      "recurrence": "WEEKLY",
      "startDate": "2026-07-29",
      "recurrenceEndDate": "2026-07-29",
      "nextExecutionDate": "2026-07-29",
      "lastExecutionDate": "2026-07-29",
      "totalInstallments": 1
    }
  ],
  "totalItems": 1,
  "page": 1,
  "size": 1,
  "totalPages": 1,
  "hasNext": true
}

Query completed successfully