4.5 Consult Received Pix

GetPixInById

API Method = GetPixInById

This method allows the user to consult a PIX receipt (PixIn) by its DocumentNumber, which is returned in the PixIn webhook. A PIX receipt (PixIn) can refer to a common payment receipt, or to a QrCode payment receipt.

Important: if the receipt is related to a PixQrCode, the response of this method will return an object called QRCodeInfos, containing all the information related to the paid QrCode that generated the receipt. Otherwise, this object will be returned by the API as null.

You can consult the Pix In data by DocumentNumber or EndToEnd; however, it is necessary to fill in at least one of the two fields.

{
"Method": "GetPixInById",
"PartnerId": 0000,
"BusinessUnitId": 0000,
"DocumentNumber": 000000,
"TaxNumber": "00000000000",
"Bank": "000",
"BankBranch": "0000",
"BankAccount": "000000",
"BankAccountDigit": "0",
"EndToEndId": "K7222485720949273185595604910271",
"ConciliationId": "21s88c5832a7899"
}

Description

ParameterDescriptionMandatoryType
MethodGetPixInByIdYESSTRING
PartnerIdInformation provided by FitBankYESINT
BusinessUnitIdInformation provided by FitBankYESINT
DocumentNumberDocument number (ID) of the static or dynamic QrCode that is to be consultedDESIRABLENUMBER
TaxNumberCPF/CNPJ of who received the PIXYESSTRING
BankReceiver's Bank Code (Ex.: “450”)YESSTRING
BankBranchReceiver's Bank Agency Code (Ex.: “0001”)YESSTRING
BankAccountReceiver's Bank Account (Ex.: “146492”)YESSTRING
BankAccountDigitReceiver's Account Digit (Ex.: “1”)YESSTRING
EndToEndIdAuthenticator CodeDESIRABLESTRING
ConciliationIdConciliation ID used to reconcile payments.DESIRABLESTRING

GetPixInByDate

API Method = GetPixInByDate

This method allows the user to consult a PIX receipt (PixIn) through a date filter. A PIX receipt (PixIn) can refer to a common payment receipt, or to a QrCode payment receipt.

Important: if the receipt is related to a PixQrCode, the response of this method will return an object called QRCodeInfos, containing all the information related to the paid QrCode that generated the receipt. Otherwise, this object will be returned by the API as null.

{
     "Method": "GetPixInByDate",
     "PartnerId": 30519,
     "BusinessUnitId": 51138,
     "TaxNumber": "84928589076",
     "StartDate": "2021/10/06",
     "EndDate": "2021/10/29",
     "Bank": "450",
     "BankBranch": "0001",
     "BankAccount": "440246",
     "BankAccountDigit": "3",
     "PageIndex": 0,
     "PageSize": 10
}

Description

ParameterDescriptionMandatoryType
MethodMethod to be usedYESSTRING
PartnerIdInformation provided by FitBankYESINT
BusinessUnitIdInformation provided by FitBankYESINT
TaxNumberCPF/CNPJ of who received the PIXYESSTRING
StartDateStart date for the searchYESSTRING
EndDateEnd date for the searchYESSTRING
BankReceiver's Bank Code (Ex.: “450”)YESSTRING
BankBranchReceiver's Bank Agency Code (Ex.: “0001”)YESSTRING
BankAccountReceiver's Bank Account (Ex.: “146492”)YESSTRING
BankAccountDigitReceiver's Account Digit (Ex.: “1”)YESSTRING
PageIndexReference of which page will be accessedYESINT
PageSizeNumber of results that will be displayed on the same pageYESINT