v1

latestOpenAPI 3.0.0Apache 2.02026-07-263079321.1 MB

Payment and Payment Management

GetPixRecurrences

This method can be used to query all Pix scheduled recurrences for an account.

post/GetPixRecurrences

Request body

Methodstring

PartnerIdinteger

Partner identifier provided by Fitbank

BusinessUnitIdinteger

TaxNumberstring required

CPF/CNPJ of the account holder.

Bankstring required

Bank code.

BankBranchstring required

Bank branch.

BankAccountstring required

Bank account number.

BankAccountDigitstring required

Bank account digit.

Example request

{
  "Method": "GetPixRecurrences",
  "PartnerId": 30324,
  "BusinessUnitId": 51138,
  "TaxNumber": "12345678900",
  "Bank": "450",
  "BankBranch": "0001",
  "BankAccount": "440246",
  "BankAccountDigit": "3"
}

Response

Query completed successfully

Successstring

Example response

{
  "Success": "true",
  "PixRecurrence": [
    {
      "Identifier": "recurrence-rent-2025",
      "Parcel": {
        "Amount": 12,
        "Current": 5
      },
      "NextPaymentDate": "2025-08-11",
      "Frequency": "Monthly",
      "Value": 150.5
    }
  ]
}