---
title: "GeneratePixRecurrence"
method: POST
path: "/GeneratePixRecurrence"
tags: ["Payment and Payment Management"]
---

# GeneratePixRecurrence

`POST /GeneratePixRecurrence`

This method can be used to create a recurring Pix schedule.

## Request body

- object
  - `Method` string
  - `PartnerId` integer — Partner identifier provided by Fitbank
  - `BusinessUnitId` integer
  - `InitialDate` string, date-time, required — Initial date of recurrence.
  - `Type` string, required — Type of recurrence.
  - `Frequency` string, required — Frequency of recurrence.
  - `Quantity` integer — Number of recurrence executions.
  - `FinalDate` string, date-time — End date of recurrence.
  - `InitiationType` string, required — Type of initiation.
  - `Hash` string — QR Code Hash, if applicable.
  - `Value` number, required — Transaction value.
  - `Payee` object, required — Recipient information.
    - `TaxNumber` string, required
    - `Name` string, required
    - `ISPB` string
    - `Bank` string
    - `BankBranch` string, required
    - `BankAccount` string, required
    - `BankAccountDigit` string, required
  - `Payer` object, required — Payer information.
    - `TaxNumber` string, required
    - `Name` string, required
    - `ISPB` string
    - `Bank` string
    - `BankBranch` string, required
    - `BankAccount` string, required
    - `BankAccountDigit` string, required
  - `CustomerMessage` string — Custom message.
  - `Identifier` string, required — Unique identifier for the recurrence.
  - `Tags` string[] — Lista de tags para a transação.
  - `SearchProtocol` integer — Search protocol.

## Response `200`

Recurrence created successfully

- object
  - `Success` string
  - `Message` string
  - `Identifier` string

---

[API](https://skmtc.net/fitbank/apis/onboarding.md) · [All operations](https://skmtc.net/fitbank/apis/onboarding/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/fitbank/onboarding/versions/f94d262a8f58/schema)
