Banking and collection boletos

API Method = GenerateBoletoOut
Our platform pays every collection boleto type, as much as both bank collection and collection of collections and consumption invoices. Through the barcode (or serial number), we can consult a lot of payment data:

Collection boleto: Type of product segment, charged value (GetInfoByBarcode);
Bank boleto: beneficiary, value, due date, discounts, interest, and fines (Query method: GetInfoCipByBarcode).

All of these information are fundamental to validating and performing the payment, according to the regulation of FEBRABAN's collection boletos and bank boleto, regulated by CIP .

Types of boletos with barcodes accepted in the method

Collection boletos: dealerships (water, energy, internet, telephone, TV, etc.) and taxes (Taxes and Fees*);
Bank boletos.

{
    Method: 'GenerateBoletoOut',
    PartnerId: 10343,
    BusinessUnitId: 30421,
    Name: 'Paula',
    TaxNumber: '33109855046',
    BeneficiaryTaxNumber: '33409855046',
    BeneficiaryName: 'João Silva',
    GuarantorTaxNumber: '81422414043',
    GuarantorName: 'Maria Helena',
    PayerTaxNumber: '16982097030',
    PayerName: 'João Alves',
    MailToSend: '[email protected]',
    PhoneToSend: '8854324232',
    Barcode: '03394894500000087671760680778200262003064000',
    PrincipalValue: 168.67,
    DiscountValue: 0,
    ExtraValue: 0,
    PaymentDate: '2022/05/16',
    DueDate: '2022/05/20',
    Tags: {Pagamento: 'Pagamento'},
    Description: 'Pagamento',
    Identifier: '5354ge45l3',
    RateValue: 1.19,
    RateValueType: 1,
    PaymentSubType: 0,
    FeePayerFullName: 'Ana Silva Goes',
    FeePayerTaxNumber: '13067778000160',
    FeePayerMail: '[email protected]',
    FeePayerBank: '450',
    FeePayerBankBranch: '1024',
    FeePayerBankAccount: '8147341',
    FeePayerBankAccountDigit: '0',
    FeePayerTradingName: 'Comercial Pereira',
    FeePayerLegalName: 'Maria Ferreira Lima',
    FeePayerIdentityDocument: '19062375308',
    Bank: '033',
    BankBranch: '1024',
    BankAccount: '8147342',
    BankAccountDigit: '1',
    Entries: {
      Name: 'Paula',
      TaxNumber: '33109855046',
      Value: 80.45,
      Description: 'Pagamento',
      Bank: '033',
      BankBranch: '1024',
      BankAccount: '8147342',
      BankAccountDigit: '1'
    }
  }

Boleto

Boletos with barcode are widely used in Brazil for a variety of transactions

Description

Method	GenerateBoletoOut
Parameter	Description	Type	Mandotory
Method	API method to be used	string	YES
PartnerId	Partner ID provided by Fitbank	integer	YES
BusinessUnitId	Business Unit ID provided by Fitbank	integer	YES
Name	Payer's name	string	YES
TaxNumber	Payer's CPF or CNPJ	string	YES
BeneficiaryTaxNumber	Beneficiary's CPF or CNPJ	string	NO
BeneficiaryName	Beneficiary's name	string	NO
GuarantorTaxNumber	Guarantor's tax number	string	NO
GuarantorName	Guarantor's name	string	NO
PayerTaxNumber	Payer's CPF or CNPJ	string	NO
PayerName	Payer's name	string	NO
MailToSend	Beneficiary's email	string	NO
PhoneToSend	Beneficiary's phone	string	NO
Barcode	Bar code	string	YES
PrincipalValue	Payment value	number	NO
DiscountValue	Discount Value	number	NO
ExtraValue	Extra Value	number	NO
PaymentDate	Payment date set to settle the payment	string	YES
DueDate	Boleto Due Date	string	YES
Tags	List of tags: (Ex.: Payment, API Test)	object	NO
Description	Description	string	NO
Identifier	Id reference to the payment generated	string	NO
RateValue	Value sent at the Rate	number	NO
RateValueType	0 - Default	integer	NO
	1 - Value sent at the RateValue field		NO
PaymentSubType	Payment sub type	integer	NO
FeePayerFullName	Fee Payer Full Name	string	NO
FeePayerTaxNumber	Fee Payer Tax Number	string	NO
FeePayerMail	Fee Payer Mail	string	NO
FeePayerBank	Fee Payer Bank	string	NO
FeePayerBankBranch	Fee Payer Bank Branch	string	NO
FeePayerBankAccount	Fee Payer Bank Account	string	NO
FeePayerBankAccountDigit	Fee Payer Bank Account Digit	string	NO
FeePayerTradingName	Fee Payer Trading Name	string	NO
FeePayerLegalName	Fee Payer Legal Name	string	NO
FeePayerIdentityDocument	Fee Payer Identity Document	string	NO
Bank	Bank	string	NO
BankBranch	Bank Branch	string	NO
BankAccount	Bank Account	string	NO
BankAccountDigit	Bank Account Digit	string	NO
Entries	Entries	string	NO
JSONENTRIES OBJECT	JSONENTRIES OBJECT	object	NO
Name	Name	string	NO
TaxNumber	Tax Number	string	NO
Value	Value	number	NO
Description	Description		NO
Bank	Bank	string	NO
BankBranch	Bank Branch	string	NO
BankAccount	Bank Account	string	NO
BankAccountDigit	Bank Account Digit	string	N

Tax and Collection Guide without barcode

Some payment guides do have not a barcode and use dedicated methods for each type where data is entered manually.

They are:

DARF (Federal Collection Document)
API Method: GeneratePaymentDARF
GPS (Social Security Guide)
API Method: GeneratePaymentGPS
GARE (Collection State Document)
API Method: GeneratePaymentGARE
DARJ (Collection of Rio de Janeiro Document)
API Method: GeneratePaymentDARJ
FGTS (collection of the Severance Pay Fund)
API Method: GeneratePaymentFGTS

🚧
Taxes with barcodes
The payments mentioned above are being updated to contain barcodes and can be paid using the same payment method as for boletos with barcodes: GenerateBoletoOut.

{
  "Method": "GeneratePaymentDARF",
  "PartnerId": 10343,
  "BusinessUnitId": 30421,
  "TaxNumber": "33109855046",
  "FromBank": "450",
  "FromBankBranch": "1024",
  "FromBankAccount": "8142542",
  "FromBankAccountDIgit": "2",
  "DARFType": 1,
  "CalculationPeriod": "2022/06/05",
  "CodeRevenue": "4321",
  "ContributorTaxNumber": "87649862097",
  "ReferenceNumber": "012018",
  "DueDate": "2022/05/20",
  "GrossRevenueValue": 0,
  "GrossRevenuePercentage": "0.0",
  "PrincipalValue": 168.67,
  "FineValue": 1230,
  "InterestValue": 17890,
  "PaymentDate": "2022/05/16",
  "Description": "Pagamento",
  "Identifier": "5354ge45l3",
  "RateValueType": 1
}

{
  "Method": "GeneratePaymentGPS",
  "PartnerId": 10343,
  "BusinessUnitId": 30421,
  "TaxNumber": "33109855046",
  "ContributorTaxNumber": "87649862097",
  "PrincipalValue": 168.67,
  "FineInterestValue": 0,
  "OtherValues": 0,
  "RateValue": 1.19,
  "PaymentDate": "2022/05/16",
  "DueDate": "2022/05/20",
  "RateValueType": 1,
  "Description": "Pagamento",
  "Identifier": "5354ge45l3",
  "PaymentCode": "3213",
  "ReferenceNumber": "012018",
  "JurisdictionDate": "102017",
  "FromBank": "450",
  "FromBankBranch": "1024",
  "FromBankAccount": "8142542",
  "FromBankAccountDigit": "2",
  "ContributorDocumentType": 2

{
  "Method": "GeneratePaymentGARE",
  "PartnerId": 10343,
  "BusinessUnitId": 30421,
  "TaxNumber": "33109855046",
  "ContributorTaxNumber": "87649862097",
  "ReferenceNumber": "012018",
  "PrincipalValue": 168.67,
  "FineValue": 1230,
  "InterestValue": 17890,
  "TotalValue": 134.5,
  "RateValue": 1.19,
  "DueDate": "2022/05/20",
  "PaymentDate": "2022/05/16",
  "CodeRevenue": "4321",
  "StateRegistration": "67890",
  "ActiveDebit": "1",
  "QuoteNumberNotification": "213",
  "RateValueType": 1,
  "Description": "Pagamento",
  "Identifier": "5354ge45l3",
  "GareType": 0,
  "FromBank": "450",
  "FromBankBranch": "1024",
  "FromBankAccount": "8142542",
  "FromBankAccountDigit": "2"
}

{
  "Method": "GeneratePaymentDARJ",
  "PartnerId": 10343,
  "BusinessUnitId": 30421,
  "TaxNumber": "33109855046",
  "ContributorTaxNumber": "87649862097",
  "ReferenceNumber": "012018",
  "PrincipalValue": 168.67,
  "FineValue": 1230,
  "InterestValue": 17890,
  "MonetaryValue": 22,
  "TotalValue": 134.5,
  "RateValue": 1.19,
  "DueDate": "2022/05/20",
  "PaymentDate": "2022/05/16",
  "CodeRevenue": "4321",
  "StateRegistration": "67890",
  "OriginDocument": 2,
  "RateValueType": 1,
  "Description": "Pagamento",
  "Identifier": "5354ge45l3",
  "FromBank": "450",
  "FromBankBranch": "1024",
  "FromBankAccount": "8142542",
  "FromBankAccountDigit": "2"
}

{
  "Tags": {
    "Pagamento": "Pagamento"
  },
  "Method": "GeneratePaymentFGTS",
  "PartnerId": 10343,
  "BusinessUnitId": 30421,
  "TaxNumber": "33109855046",
  "ContributorTaxNumber": "87649862097",
  "PrincipalValue": 168.67,
  "CodeRevenue": "4321",
  "Barcode": "03394894500000087671760680778200262003064000",
  "FgtsIdentifier": "9",
  "SocialConnectivityCode": 0,
  "SocialConnectivityDigit": 0,
  "PaymentDate": "2022/05/16",
  "RateValueType": 1,
  "Description": "Pagamento",
  "Identifier": "5354ge45l3",
  "FromBank": "450",
  "FromBankBranch": "1024",
  "FromBankAccount": "8142542",
  "FromBankAccountDigit": "2"
}

DARF

It is a cashier's desk that serves to collect taxes, contributions, and fees that are included in financial transactions. It is the main tool for collecting taxes from the Federal Revenue Service. As a result, its use is mandatory in the daily lives of individuals and companies.

Description

Method	Generate Payment DARF
Parameter	Description	Type	Mandotory
Method	API Method	string	YES
PartnerId	Partner ID provided by Fitbank	integer	YES
BusinessUnitId	Business Unit Identifier provided by Fitbank	integer	YES
TaxNumber	Payer's CPF or CNPJ	string	YES
FromBank	Bank Code	string	NO
FromBankBranch	Agency Number	string	NO
FromBankAccount	Account Number	string	NO
FromBankAccountDIgit	Account Digit Number	string	NO
DARFType	DARF Type	integer	YES
CalculationPeriod	Calculation Period	string	YES
CodeRevenue	Code Revenue	string	YES
ContributorTaxNumber	Contributor Tax Number	string	YES
ReferenceNumber	Reference Number	string	NO
DueDate	Expiration Date	string	NO
GrossRevenueValue	Gross Revenue Value	number	NO
GrossRevenuePercentage	Gross Revenue Percentage	string	NO
PrincipalValue	Principal Value	number	YES
FineValue	Fine Value	number	NO
InterestValue	Interest Value	number	NO
PaymentDate	Payment date	string	YES
Tags	Tag List	object	NO
Description	Description	string	NO
Identifier	Unique Identifier	string	NO
RateValueType	Rate Value Type	integer	NO

GPS

The Social Security Guide (GPS) It is the valid document for the collection of social contributions (INSS) that will be used by contributors, whether optional or not. Payment must be made monthly and without delays, so that the worker can guarantee access to social security benefits.

Description

Method	Generate Payment GPS
Parameter	Description	Type	Mandotory
Method	API Method	string	YES
PartnerId	Partner ID provided by Fitbank	integer	YES
BusinessUnitId	Business Unit Identifier provided by Fitbank	integer	YES
TaxNumber	Payer's CPF or CNPJ	string	YES
ContributorTaxNumber	Contributor Tax Number	string	YES
PrincipalValue	Principal Value	number	YES
FineInterestValue	FineInterest Value	number	NO
OtherValues	Other values	number	NO
RateValue	Rate Value	number	NO
PaymentDate	Payment's date	string	YES
DueDate	Expiration Date	string	NO
Tags	Tag List	object	NO
RateValueType	Rate Value Type	integer	NO
Description	Description	string	NO
Identifier	Unique Identifier	string	NO
PaymentCode	Payment Code	string	YES
ReferenceNumber	Reference Number	string	NO
JurisdictionDate	JurisdictionDate	string	YES
FromBank	Bank Code	string	NO
FromBankBranch	Agency Number	string	NO
FromBankAccount	Account Number	string	NO
FromBankAccountDIgit	Account Digit Number	string	NO
ContributorDocumentType	Contributor Document Type	integer	NO

GARE

The state revenue collection guide is a document used to collect ICMS (Tax on Circulation of Goods and Services) and other public revenues from a state.
The GARE can be used for two purposes: refunding or correcting information.
Refund: returning to the company amounts paid incorrectly as taxes;
Correction: aimed at making changes to tax information, state institution, active debt, installment number, and other fields on tax forms.

Description

Method	Generate Payment GARE
Parameter	Description	Type	Mandotory
Method	API Method	string	YES
PartnerId	Partner ID provided by Fitbank	integer	YES
BusinessUnitId	Business Unit Identifier provided by Fitbank	integer	YES
TaxNumber	Payer's CPF or CNPJ	string	YES
ContributorTaxNumber	Contributor Tax Number	string	YES
ReferenceNumber	Reference Number	string	NO
PrincipalValue	Principal Value	number	YES
FineValue	Fine Value	number	NO
InterestValue	Interest Value	number	NO
TotalValue	Boleto Total Amount	number	NO
RateValue	Rate Value	number	NO
DueDate	Due Date	string	NO
PaymentDate	Payment's date	string	YES
Tags	Tag List	object	NO
CodeRevenue	Code Revenue	string	YES
StateRegistration	State Registration	string	YES
ActiveDebit	Active Debit	string	NO
QuoteNumberNotification	Quote Number Notification	string	NO
RateValueType	Rate Value Type	integer	NO
Description	Description	string	NO
Identifier	Unique Identifier	string	NO
GareType	GareType	integer	NO
FromBank	Bank Code	string	NO
FromBankBranch	Agency Number	string	NO
FromBankAccount	Account Number	string	NO
FromBankAccountDIgit	Account Digit Number	string	NO

DARJ

Used for collecting taxes and fees from residents of the state of Rio de Janeiro.

Description

Method	Generate Payment DARJ
Parameter	Description	Type	Mandotory
Method	API Method	string	YES
PartnerId	Partner ID provided by Fitbank	integer	NO
BusinessUnitId	Business Unit Identifier provided by Fitbank	integer	NO
TaxNumber	Payer's CPF or CNPJ	string	YES
ContributorTaxNumber	Contributor Tax Number	string	YES
ReferenceNumber	Reference Number	string	NO
PrincipalValue	Principal Value	number	YES
FineValue	Fine Value	number	NO
InterestValue	Interest Value	number	NO
MonetaryValue	Monetary Value	number	NO
TotalValue	Boleto Total Amount	number	NO
RateValue	Rate Value	number	NO
DueDate	Due Date	string	NO
PaymentDate	Payment's date	string	YES
Tags	Tag List	object	NO
CodeRevenue	Code Revenue	string	YES
StateRegistration	State Registration	string	YES
OriginDocument	Origin Document	number	NO
RateValueType	Rate Value Type	integer	NO
Description	Description	string	NO
Identifier	Unique Identifier	string	NO
FromBank	Bank Code	string	NO
FromBankBranch	Agency Number	string	NO
FromBankAccount	Account Number	string	NO
FromBankAccountDIgit	Account Digit Number	integer	NO

FGTS

The FGTS guide is a document used for the collection of the Severance Pay Fund (FGTS), a right guaranteed to Brazilian workers governed by the Consolidation of Labor Laws (CLT).

Description

Method	Generate Payment FGTS
Parameter	Description	Type	Mandotory
Method	API Method	string	YES
PartnerId	Partner ID provided by Fitbank	integer	YES
BusinessUnitId	Business Unit Identifier provided by Fitbank	integer	YES
TaxNumber	Payer's CPF or CNPJ	string	YES
ContributorTaxNumber	Contributor Tax Number	string	YES
PrincipalValue	Principal Value	number	YES
CodeRevenue	Code Revenue	string	YES
Barcode	Boleto Bar Code	string	YES
FgtsIdentifier	Identificador Fgts	string	NO
SocialConnectivityCode	Social Connectivity Code	integer	YES
SocialConnectivityDigit	Social Connectivity Digit	integer	YES
PaymentDate	Payment Date	string	YES
Tags	Tag List	object	NO
RateValueType	Rate Value Type	integer	NO
Description	Description	string	NO
Identifier	Unique Identifier	string	YES
FromBank	Bank Code	string	NO
FromBankBranch	Agency Number	string	NO
FromBankAccount	Account Number	string	NO
FromBankAccountDIgit	Account Digit Number	string	NO

Generate´s Responses

GenerateBoletoOut

 
 { 
  "Success": true, 
  "DocumentNumber": 142578, 
  "EntryId": 10, 
  "Url": "http://www.pdfurl.com.br/pdf?filename=2022-04-04/omu1tvh3.pdf", 
  "Exists": true 
}

GeneratePaymentDARF

{ 
  "Success": true, 
  "DocumentNumber": 70586, 
  "Url": "http://www.pdfurl.com.br/pdf?filename=2021-05-25/gq5yp15j.pdf", 
  "EntryId": 14 
}

GeneratePaymentGARE

{ 
  "Success": true, 
  "DocumentNumber": "40374", 
  "Url": "http://www.pdfurl.com.br/pdf?filename=2021-05-25/ygbhszcw.pdf" 
}

GeneratePaymentsGPS

{ 
  "Success": true, 
  "DocumentNumber": 30336, 
  "Url": "http://www.pdfurl.com.br/pdf?filename=2021-05-25/b4ecclde.pdf\"" 
}

GeneratePaymentsDARJ

{ 
  "Success": true, 
  "DocumentNumber": 30319, 
  "Url": "http://www.pdfurl.com.br/pdf?filename=2021-05-25/o4u0hmb0.pdf" 
}

GeneratePaymentsFGTS

{ 
  "Success": true, 
  "DocumentNumber": 30336, 
  "Url": "http://www.pdfurl.com.br/pdf?filename=2021-05-25/tvhuu5kz.pdf" 
}

2 - Types of Payments

Banking and collection boletos

Types of boletos with barcodes accepted in the method

Boleto

Description

Tax and Collection Guide without barcode

🚧
Taxes with barcodes

DARF

Description

GPS

Description

GARE

Description

DARJ

Description

FGTS

Description

Generate´s Responses

GenerateBoletoOut

GeneratePaymentDARF

GeneratePaymentGARE

GeneratePaymentsGPS

GeneratePaymentsDARJ

GeneratePaymentsFGTS

Banking and collection boletos

Types of boletos with barcodes accepted in the method

Boleto

Description

Tax and Collection Guide without barcode

🚧Taxes with barcodes

DARF

Description

GPS

Description

GARE

Description

DARJ

Description

FGTS

Description

Generate´s Responses

GenerateBoletoOut

GeneratePaymentDARF

GeneratePaymentGARE

GeneratePaymentsGPS

GeneratePaymentsDARJ

GeneratePaymentsFGTS

🚧
Taxes with barcodes