4.1 Generate QRCode

Generate Static Pix QRCode

API Method = GenerateStaticPixQRCode

This method generates a simplified billing QrCode where there is no association of a payer. The payment is able to be done by any user who does the optical reading of the QrCode or enter the hash code. The same QrCode can be used several times for payment.

The charge may be generated containing a set amount for a specific billing, or make it available for the payer to report the amount to pay, so a zero value QrCode billing can be generated so that the charge can be made openly available and users can make a payment for the amount they are entitled to. For example: QrCodes available in restaurants.

To issue a fixed value charge, simply apply the value to the PrincipalValue field. If the charge does not have a specific value, the PrincipalValue field must be filled with null, because in this situation the FitBank API does not consider a 0 value.

With this modality, it is not possible to define a due date.

{
     "Method": "GenerateStaticPixQRCode",
     "PartnerId": 30519,
     "BusinessUnitId": 51138,
     "PrincipalValue": 123.45,
     "TaxNumber": "84928589076",
     "PixKey": "17699384008",
     "Address": {
          "AddressLine": "Rua Niterói",
          "AddressLine2": "string",
          "ZipCode": "60731-305",
          "Neighborhood": "Canindezinho",
          "CityCode": "451",
          "CityName": "Fortaleza",
          "State": "Ceará",
          "AddressType": 1,
          "Country": "Brasil",
          "Complement": "Apto 01",
          "Reference": "Próximo ao mercado"
     },
     "Bank": "450",
     "BankBranch": "0001",
     "BankAccount": "440246",
     "BankAccountDigit": "3",
     "AdditionalData": "pagamento",
     "TransactionPurpose": 0,
     "Identifier": "string",
}

{
    "Success": "true",
    "Message": "ISI0001 - Método executado com sucesso",
    "DocumentNumber": 300400
}

Description:

Parameter	Description	Mandatory	Type	Comments
Method	GenerateStaticPixQRCode	YES	STRING	-
PartnerId	Information provided by FitBank	YES	INT	-
BusinessUnitId	Information provided by FitBank	YES	INT	-
PrincipalValue	Value of the collection/billing	YES	INT	-
TaxNumber	CPF/CNPJ of the receiver	YES	STRING	-
PixKey	Receiver's pix key	YES	STRING	-
Address	Adress of the receiver	YES	OBJECT	-
AddressLine	First adress of the receiver	DESIRABLE	STRING	-
AddressLine2	Second adress of the receiver	DESIRABLE	STRING	-
Neighborhood	Neighborhood of the receiver	DESIRABLE	STRING	-
ZipCode	ZipCode of the receiver	DESIRABLE	INT	Valid Formats: 61801490 61801-490 Limit: 10 characters
CityName	City of the receiver	DESIRABLE	STRING	-
AddressType	Type of adress of the receiver	DESIRABLE	INT	Commercial = 0 Residential = 1
CityCode	City code of the receiver	DESIRABLE	STRING	-
State	State of the receiver	DESIRABLE	STRING	-
Country	Country of the receiver	DESIRABLE	STRING	-
Complement	Aditional information to the adress of the receiver	DESIRABLE	STRING	-
Reference	Reference to the adress of the receiver	DESIRABLE	STRING	-
Bank	Receiver's Bank Code (Ex.: “450”)	YES	STRING	-
BankBranch	Receiver's Bank Agency Code (Ex.: “0001”)	YES	STRING	-
BankAccount	Receiver's Bank Account (Ex.: “146492”)	YES	STRING	-
BankAccountDigit	Receiver's Account Digit (Ex.: “1”)	YES	STRING	-
AdditionalData	Additional information of the collection	NO	STRING	-
TransactionPurpose	Purpose of the collection	NO	INT	PurchaseOrTransfer = 0 Withdraw = 2 For a common payment transaction, by default fill in 0
Identifier	Collection identifier assigned by the collection issuer	NO	STRING	-

Generate Dynamic Pix QRCode

API Method = GenerateDynamicPixQRCode

This modality is intended for charges that have a specified payer, with the identification of this payer, and the reason for the charge. This type of QrCode can only be used to make a payment once, after using it and successfully settling a payment, it expires. If after issuing the charge, payment is not made until the expiration date (ExpirationDate), the QrCode also expires.

If the generated QrCode is not used by anyone, it expires on the date assigned by the collector (ExpirationDate field). In addition, it is possible to edit the QrCode information as the billing amount, the payer information and the expiration date, maintaining the same hash, through the API method ChangeDynamicPixQRCode.

If the charger does not intend to specify a payer for the billing he wants to generate, the fields PayerName and PayerTaxNumber must be filled as null.

This type of QrCode does not allow the customer to issue charges with value 0, thus the generated charges must have a PrincipalValue greater than or equal to 0.01.

{
     "Method": "GenerateDynamicPixQRCode",
     "PartnerId": 30519,
     "BusinessUnitId": 51138,
     "PixKey": "17699384008",
     "TaxNumber": "84928589076",
     "PayerTaxNumber": "65023491021",
     "PayerName": "João da Silva Pereira",
     "PrincipalValue": 123.45,
     "ExpirationDate": "31/01/2022 15:35:59",
     "Address": {
          "AddressLine": "Rua Niterói",
          "AddressLine2": "string",
          "ZipCode": "60731-305",
          "Neighborhood": "Canindezinho",
          "CityCode": "451",
          "CityName": "Fortaleza",
          "State": "Ceará",
          "AddressType": 1,
          "Country": "Brasil",
          "Complement": "Apto 01",
          "Reference": "Próximo ao mercado"
     },
     "Bank": "450",
     "BankBranch": "0001",
     "BankAccount": "440246",
     "BankAccountDigit": "3",
     "ChangeType": 0,
     "AdditionalData": [
          {
               "Name": "pagamento",
               "Value": "300"
          }
     ],
     "PayerRequest": "pagamento",
     "TransactionPurpose": 1,
     "TransactionValue": null,
     "AgentModality": 2,
     "TransactionChangeType": null,
     "Identifier": "string",
}

{
    "Success": "true",
    "Message": "ISI0001 - Método executado com sucesso",
    "DocumentNumber": 36301
}

Description:

Parameter	Description	Mandatory	Type	Comments
Method	GenerateDynamicPixQRCode	YES	STRING	-
PartnerId	Information provided by FitBank	YES	INT	-
BusinessUnitId	Information provided by FitBank	YES	INT	-
PixKey	Receiver's PIX key	YES	STRING	-
TaxNumber	CPF/CNPJ of the collector/receiver, meaning, who will have the PIX key and generates the charge	YES	STRING	-
PayerTaxNumber	CPF/CNPJ of the payer	NO	STRING	-
PayerName	Name of the payer	NO	STRING	-
PrincipalValue	Value of the collection	YES	NUMBER	-
ExpirationDate	Date and time until the QR Code expires	YES	STRING	Valid Formats: 31/01/2022 31/01/2022 15:35 31/01/2022 15:35:59
Address	Adress of the receiver	YES	OBJECT	-
AddressLine	First adress of the receiver	DESIRABLE	STRING	-
AddressLine2	Second adress of the receiver	DESIRABLE	STRING	-
ZipCode	ZipCode of the receiver	DESIRABLE	INT	Valid Formats: 61801490 61801-490 Limit: 10 characters
Neighborhood	Neighborhood of the receiver	DESIRABLE	STRING	-
CityCode	City code of the receiver	DESIRABLE	STRING	-
CityName	City of the receiver	DESIRABLE	STRING	-
State	State of the receiver	DESIRABLE	STRING	-
AddressType	Type of adress of the receiver	DESIRABLE	INT	Commercial = 0 Residential = 1
Country	Country of the receiver	DESIRABLE	STRING	-
Complement	Aditional information to the adress of the receiver	DESIRABLE	STRING	-
Reference	Reference to the adress of the receiver	DESIRABLE	STRING	-
Bank	Receiver's Bank Code (Ex.: “450”)	YES	STRING	-
BankBranch	Receiver's Bank Agency Code (Ex.: “0001”)	YES	STRING	-
BankAccount	Receiver's Bank Account (Ex.: “146492”)	YES	STRING	-
BankAccountDigit	Receiver's Account Digit (Ex.: “1”)	YES	STRING	-
ChangeType*	Parameter that allows the amount charged to be changed or not at the moment of payment	YES	INT	None = 0 (Does not allow value change) Allowed = 1 (Allows value change)
AdditionalData	Additional information of the collection	NO	ARRAY OF OBJECTS	-
Name	Name of the custom parameter to be add with transaction	NO	STRING	-
Value	Value of the custom parameter to be add with transaction	NO	STRING	Does not necessarily have to be the indication of a monetary value
PayerRequest	Message or description that can be added if desirable	NO	STRING	Maximum number of accepted characters: 140 characters
TransactionPurpose	Purpose of the collection	NO	INT	PurchaseOrTransfer = 0 PurchaseWithChange = 1 Withdraw = 2 For a common payment transaction, by default fill as 0
TransactionValue	Value of the transaction	NO	NUMBER	Applicable only if the QrCode is set as PIX Withdraw or PIX Change. If not, must be filled as null
AgentModality	Agent modality of the withdraw transaction	NO	INT	PSS = 0 (Withdrawal Service Provider) CommercialEstablishment = 1 Other = 2 By default, fill as 2, unless it refers to a PIX Withdraw transaction
TransactionChangeType	Type of the collection transaction	NO	INT	None = 0 Allowed = 1 Applicable only if the QrCode is set as PIX Withdraw or PIX Change. If not, must be filled as null
Identifier	Collection identifier assigned by the collection issuer	NO	STRING	-

❗️
*Important
Even if in the request, the ChangeType field is registered with Type 0 (Does not allow value changes), it is the customer's responsibility to perform the reconciliation between the values charged and the values received, and to do so, he can use the information available in the PixIn webhook.

Generate Dynamic Pix QRCode Due Date

API Method = GenerateDynamicPixQRCodeDueDate

This method can be used to generate dynamic PIX QrCodes with due date, meaning the charge generated by this method will have an expiration date (ExpirationDate) and a due date (DueDate), and based on this due date, certain fees may be charged or discounts may be granted, so that the collector can control the billing dynamics as he wishes.

This type of QrCode can only be used to make a payment once, after using it and successfully settling a payment, it expires. If after issuing the charge, payment is not made until the expiration date (ExpirationDate), the QrCode also expires.

If the charger does not intend to specify a payer for the billing he wants to generate, the fields PayerName and PayerTaxNumber must be filled as null.

This type of QrCode does not allow the customer to issue charges with value 0, thus the generated charges must have a PrincipalValue greater than or equal to 0.01.

{
     "Method": "GenerateDynamicPixQRCodeDueDate",
     "PartnerId": 30519,
     "BusinessUnitId": 51138,
     "PixKey": "17699384008",
     "TaxNumber": "84928589076",
     "PayerTaxNumber": "65023491021",
     "PayerName": "João da Silva Pereira",
     "PrincipalValue": 123.45,
     "Address": {
          "AddressLine": "Rua Niterói",
          "AddressLine2": "string",
          "ZipCode": "60731-305",
          "Neighborhood": "Canindezinho",
          "CityCode": "451",
          "CityName": "Fortaleza",
          "State": "Ceará",
          "AddressType": 1,
          "Country": "Brasil",
          "Complement": "Apto 01",
          "Reference": "Próximo ao mercado"
     },
     "DueDate": "2022/10/29",
     "ExpirationDate": "2022/10/30",
     "Bank": "450",
     "BankBranch": "0001",
     "BankAccount": "440246",
     "BankAccountDigit": "3",
     "RebateValue": 0,
     "InterestValue": 0,
     "FineValue": 0,
     "AdditionalData": [
          {
               "Name": "pagamento",
               "Value": "300"
          }
     ],
     "PayerRequest": "pagamento",
     "Identifier": "string"
}

{
    "Success": "true",
    "Message": "ISI0001 - Método executado com sucesso",
    "DocumentNumber": 883322,
    "ExpirationDate": "30/09/2023 23:59:59",
    "ConciliationId": "EFD129E625831C5E23D477DD36406000005",
}

Description:

Parameter	Description	Mandatory	Type	Comments
Method	GenerateDynamicPixQRCodeDueDate	YES	STRING	-
PartnerId	Information provided by FitBank	YES	INT	-
BusinessUnitId	Information provided by FitBank	YES	INT	-
PixKey	Receiver's pix key	YES	STRING	-
TaxNumber	CPF/CNPJ of the collector/receiver, meaning, who will have the PIX key and generates the charge	YES	STRING	-
PayerTaxNumber	CPF/CNPJ of the payer	YES	STRING	-
PayerName	Name of the payer	YES	STRING	-
PrincipalValue	Value of the collection/charge	YES	NUMBER	-
Address	Adress of the receiver	YES	OBJECT	-
AddressLine	First adress of the receiver	DESIRABLE	STRING	-
AddressLine2	Second adress of the receiver	DESIRABLE	STRING	-
ZipCode	ZipCode of the receiver	DESIRABLE	INT	Valid Formats: 61801490 61801-490 Limit: 10 characters
Neighborhood	Neighborhood of the receiver	DESIRABLE	STRING	-
CityCode	City code of the receiver	DESIRABLE	STRING	-
CityName	City of the receiver	DESIRABLE	STRING	-
State	State of the receiver	DESIRABLE	STRING	-
AddressType	Type of adress of the receiver	DESIRABLE	INT	Commercial = 0 Residential = 1
Country	Country of the receiver	DESIRABLE	STRING	-
Complement	Aditional information to the adress of the receiver	DESIRABLE	STRING	-
Reference	Reference to the adress of the receiver	DESIRABLE	STRING	-
DueDate	Date until the transaction can be paid without any fine or interest	YES	STRING	-
ExpirationDate	Date until the QrCode/transaction expires	NO	STRING	-
Bank	Receiver's Bank Code (Ex.: “450”)	YES	STRING	-
BankBranch	Receiver's Bank Agency Code (Ex.: “0001”)	YES	STRING	-
BankAccount	Receiver's Bank Account (Ex.: “146492”)	YES	STRING	-
BankAccountDigit	Receiver's Account Digit (Ex.: “1”)	YES	STRING	-
RebateValue	Discount value	NO	NUMBER	To be applied if the payment is done before due date
InterestValue	Interest value	NO	NUMBER	To be applied if the payment is done after due date
FineValue	Fine value	NO	NUMBER	To be applied if the payment is done after due date
AdditionalData	Additional information of the collection	NO	ARRAY OF OBJECTS	-
Name	Name of the custom parameter to be add with transaction	NO	STRING	-
Value	Value of the custom parameter to be add with transaction	NO	STRING	Does not necessarily have to be the indication of a monetary value
PayerRequest	Message or description that can be added if desirable	NO	STRING	Maximum number of accepted characters: 140 characters
Identifier	Collection identifier assigned by collection issuer	NO	STRING	-

Generate Static Pix QRCode

Generate Dynamic Pix QRCode

❗️*Important

Generate Dynamic Pix QRCode Due Date

❗️
*Important