Create a recurring Pix Request Schedule

​

Creates a recurrence and materializes the linked single schedules. If recurrenceEndDate is provided, every installment up to that date is created at once. Otherwise, the recurrence is open-ended and the worker materializes the next installment after each execution.

Headers
  • Idempotency-Key
    Type: string
    required
Body·
required
application/json

Request payload for creating a recurring Pix schedule. Materializes one or more single schedules linked to this recurrence.

  • amount
    Type: number
    required

    Transaction amount.

  • initiationMethod
    Type: string enum
    required

    Payment initiation method.

    values
    • APDN
    • APES
    • AUTO
    • DICT
    • INIC
    • MANU
    • QRDN
    • QRES
  • receiver
    Type: object ·
    required

    Receiver/beneficiary information for the Pix transaction

  • recurrence
    Type: string enum
    required

    Recurrence frequency. Options: WEEKLY, BIWEEKLY, MONTHLY.

    values
    • WEEKLY
    • BIWEEKLY
    • MONTHLY
  • sender
    Type: object ·
    required

    Payer/sender information for the Pix transaction

  • startDate
    Type: string Format: date
    required

    Start date of the recurrence in ISO format (yyyy-MM-dd). The first installment is materialized on this date.

  • description
    Type: string

    Payment description or message to the receiver.

  • metadata
    Type: array object[] ·

    Optional list of custom key/value pairs.

    Key/value metadata item

  • priority
    Type: string enum

    Payment priority for the outgoing Pix request (SPI band: HIGH → HIGH, NORM → NORM)

    values
    • HIGH
    • NORM
  • purpose
    Type: string enum

    Purpose of the outgoing Pix payment (SPI purpose codes)

    values
    • GSCB
    • IPAY
    • IPRT
    • OTHR
    • REFU
  • reconciliationId
    Type: string

    Client reconciliation identifier for reporting and matching.

  • recurrenceEndDate
    Type: string Format: date

    End date for recurrence in ISO format (yyyy-MM-dd). When provided, every installment up to this date is materialized at creation time. When omitted, the recurrence is open-ended and the worker materializes the next installment after each execution.

Responses
  • */*
Request Example for post/api/v1/pix-schedules/recurrences
curl http://localhost:8080/api/v1/pix-schedules/recurrences \
  --request POST \
  --header 'Idempotency-Key: ' \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --data '{
  "initiationMethod": "DICT",
  "amount": 123.98,
  "sender": {
    "name": "",
    "document": {
      "type": "CPF",
      "value": ""
    },
    "account": {
      "ispb": "",
      "type": "CACC",
      "branch": "",
      "number": ""
    }
  },
  "receiver": {
    "key": "",
    "name": "",
    "document": {
      "type": "CPF",
      "value": ""
    },
    "account": {
      "ispb": "",
      "type": "CACC",
      "branch": "",
      "number": ""
    }
  },
  "description": "",
  "reconciliationId": "REC-20260408-001",
  "priority": "HIGH",
  "metadata": [
    {
      "key": "",
      "value": ""
    }
  ],
  "purpose": "IPAY",
  "source": "MANUAL",
  "recurrence": "MONTHLY",
  "startDate": "2026-04-30",
  "recurrenceEndDate": "2027-04-30"
}'

{
  "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
}

Recurrence created