v1

latestOpenAPI 3.0.0Apache 2.02026-07-263079321.1 MB

Payment and Payment Management

GeneratePixRecurrence

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

post/GeneratePixRecurrence

Request body

Methodstring

PartnerIdinteger

Partner identifier provided by Fitbank

BusinessUnitIdinteger

InitialDatestring date-time required

Initial date of recurrence.

Typestring required

Type of recurrence.

Frequencystring required

Frequency of recurrence.

Quantityinteger

Number of recurrence executions.

FinalDatestring date-time

End date of recurrence.

InitiationTypestring required

Type of initiation.

Hashstring

QR Code Hash, if applicable.

Valuenumber required

Transaction value.

CustomerMessagestring

Custom message.

Identifierstring required

Unique identifier for the recurrence.

Tagsstring[]

Lista de tags para a transação.

SearchProtocolinteger

Search protocol.

Example request

{
  "Method": "GeneratePixRecurrence",
  "PartnerId": 30324,
  "BusinessUnitId": 51138,
  "InitialDate": "2025-07-11T00:00:00.000Z",
  "Type": "Scheduled",
  "Frequency": "Monthly",
  "Quantity": 12,
  "FinalDate": "2026-07-11T00:00:00.000Z",
  "InitiationType": "Automatic",
  "Hash": "00020126520014BR.GOV.BCB.PIX01...",
  "Value": 150.5,
  "Payee": {
    "TaxNumber": "12345678900",
    "Name": "João da Silva",
    "ISPB": "12345678",
    "Bank": "450",
    "BankBranch": "0001",
    "BankAccount": "440246",
    "BankAccountDigit": "3"
  },
  "Payer": {
    "TaxNumber": "98765432100",
    "Name": "Maria Souza",
    "ISPB": "87654321",
    "Bank": "450",
    "BankBranch": "0001",
    "BankAccount": "123456",
    "BankAccountDigit": "9"
  },
  "CustomerMessage": "Pagamento mensal do aluguel",
  "Identifier": "recorrencia-aluguel-2025",
  "Tags": [
    "aluguel",
    "mensal"
  ],
  "SearchProtocol": 123456789
}

Response

Recurrence created successfully

Successstring

Messagestring

Identifierstring

Example response

{
  "Success": "true",
  "Message": "Recorrência de agendamento PIX criada com sucesso.",
  "Identifier": "recorrencia-aluguel-2025"
}