4.4 Consult QRCode
GetPixQRCodeById
API Method = GetPixQRCodeById
This method allows the user to consult a PIX charge by its DocumentNumber, entered after the QrCode issuance request.
{
"Method": "GetPixQRCodeById",
"PartnerId": 30519,
"BusinessUnitId": 51138,
"DocumentNumber": 854127,
"TaxNumber": "84928589076"
}
Description
Parameter | Description | Mandatory | Type |
---|---|---|---|
Method | GetPixQRCodeById | YES | STRING |
PartnerId | Information provided by FitBank | YES | INT |
BusinessUnitId | Information provided by FitBank | YES | INT |
DocumentNumber | Document number (ID) of the static or dynamic QrCode that is to be consulted | YES | NUMBER |
TaxNumber | CPF/CNPJ of who generated the QrCode charge | YES | STRING |
GetPixQRCodeByIdentifier
API Method = GetPixQRCodeByIdentifier
This method allows the user to consult a PIX charge through a DocumentNumber or Identifier.
{
"method": "GetPixQRCodeByIdentifier",
"PartnerId": 30519,
"BusinessUnitId": 51138,
"TaxNumber": "84928589076",
"DocumentNumber": 854127,
"Identifier": "ac1e955d-905d-436f-9881-f8dbdda58c73"
}
Description
Parameter | Description | Mandatory | Type |
---|---|---|---|
Method | Method to be used | YES | STRING |
PartnerId | Information provided by FitBank | YES | INT |
BusinessUnitId | Information provided by FitBank | YES | INT |
TaxNumber | CPF/CNPJ of who generated the QrCode charge | YES | STRING |
DocumentNumber | Document number (ID) of the static or dynamic QrCode that is to be | NO | INT |
Identifier | Collection identifier assigned by collection issuer | NO | STRING |
QRCode Status sent in the API:
- Created: The request for QrCode generation was received by FitBank
- Registering: The QrCode is in the process of being registered at the Central Bank (Banco Central)
- Processed: The QrCode is ready for use
- Settled: The QrCode was successfully paid
- Error: QrCode registration processing error at the Central Bank (Banco Central)
- Canceled: Canceled QrCode
- Expired: Expired QrCode
Updated 3 months ago