v1

latestOpenAPI 3.0.0Apache 2.02026-07-263079321.1 MB
QRCode Management

GetPixQRCodeById

This method can be used to consult a Pix QRCode by its identifier (DocumentNumber)

post/GetPixQRCodeById

Request body

Methodstring required
PartnerIdinteger required

Partner identifier provided by Fitbank

BusinessUnitIdinteger required
DocumentNumberinteger required

Transaction id

TaxNumberstring required

Legal Identification From Company

Example request

{
  "Method": "GetPixQRCodeById",
  "PartnerId": 30324,
  "BusinessUnitId": 51138,
  "DocumentNumber": 656,
  "TaxNumber": "33.762.255/0001-40"
}

Response

OK

Successstring
GetPixQRCodeByIdInfo (Estático)object
GetPixQRCodeByIdInfo (Dinâmico)object
GetPixQRCodeByIdInfo (Estático + Composto)object
GetPixQRCodeByIdInfo (Dinâmico + Composto)object

Example response

{
  "Success": "true",
  "GetPixQRCodeByIdInfo (Estático + Composto)": {
    "Identifier": "string",
    "PixKey": "string",
    "City": "string",
    "ZipCode": "string",
    "ReceiverName": "string",
    "ReceiverTaxNumber": "string",
    "QRCodeBase64": "string",
    "HashCode": "string",
    "CreationDate": "string",
    "PrincipalValue": "string",
    "Status": "string",
    "PixQRCodeType": "string",
    "Recurrence": {
      "Values": {
        "FinalValue": "021.67",
        "MinimumValue": "32078.66"
      },
      "Contract": {
        "Identifier": "7u8p5L99JleaMeICqMrB3g7TPb0kiVtZbQ6",
        "Description": "string"
      },
      "Date": {
        "Frequency": 0,
        "InitialDate": "2025-07-25",
        "EndDate": "2025-07-25"
      }
    }
  },
  "GetPixQRCodeByIdInfo (Dinâmico + Composto)": {
    "Identifier": "string",
    "PixQRCodeType": "string",
    "PixKey": "string",
    "Status": "string",
    "City": "string",
    "ZipCode": "string",
    "PayerName": "string",
    "PayerTaxNumber": "string",
    "ReceiverName": "string",
    "ReceiverTaxNumber": "string",
    "ChangeType": "string",
    "PrincipalValue": "string",
    "DueDate": "string",
    "RebateValue": 0,
    "InterestValue": 0,
    "FineValue": 0,
    "Reusable": true,
    "PayerRequest": "string",
    "ExpirationDate": "string",
    "TransactionChangeType": "string",
    "TransactionValue": "string",
    "TransactionPurpose": "string",
    "AgentModality": "string",
    "CreationDate": "string",
    "QRCodeBase64": "string",
    "HashCode": "string",
    "Recurrence": {
      "Values": {
        "FinalValue": "021.67",
        "MinimumValue": "32078.66"
      },
      "Contract": {
        "Identifier": "7u8p5L99JleaMeICqMrB3g7TPb0kiVtZbQ6",
        "Description": "string"
      },
      "Date": {
        "Frequency": 0,
        "InitialDate": "2025-07-25",
        "EndDate": "2025-07-25"
      }
    }
  }
}