2.1 - Boleto issue

Boleto Issue

Issuance of collection boleto

API Method = GenerateBoleto
In the FitBank API, the GenerateBoleto method is used to issue collection slips. Through the request, the customer must inform the following data:

ParameterTypeDescriptionMandatory
Method StringGenerateBoletoYES
MktPlaceId Long FitBank provided IDYES 
PartnerId Long FitBank provided IDYES 
BusinessUnitId Long FitBank provided IDYES 
GroupTemplate String Send as number 2, by defaultYES 
CustomerName String Payer's nameYES 
CustomerTaxNumber String Payer's CPF/CNPJYES 
CustomerMailStringPayer’s mailNO
CustomerPhone String Payer’s PhoneYES 
City String Payer's CityYES 
Neighborhood String Payer's neighborhoodNO
State String Payer's City (Ex: SP, RJ, BA, etc)YES 
ZipCode String Payer's ZipCodeYES 
AddressLine1 String Payer's addresslineNO
AddressLine2StringPayer's addressline additionalNO
PhoneToSendString Phone number for sending notificationsNO
MailToSend String Mail for sending notificationsYES 
SupplierTaxNumber String Payee's CPF/CNPJYES 
SupplierFullName String Payee's full name of boletoYES 
SupplierTradingName String Payee's trading name of boletoYES 
SupplierLegalName String Payee's legal name of boletoYES 
SupplierBankString Payee's account bank numberNO
SupplierBankBranch String Payee's account bank branchNO
SupplierBankAccountString Payee's account bankNO
SupplierBankAccountDigitStringPayee's account bank account digit numberNO
SupplierMailStringPayee’s mailNO
SupplierPhoneStringAccount holder's phone number NO
RateValue Decimal Payee’s phoneYES 
RateSent Boolean 0 - Default
1 - Value sent at the RateValue field
 YES 
ExternalNumber String External identification numberYES 
(May be optional depending on parameterization)
OurNumberString"Nosso Número" of the boletoYES
(May be optional depending on parameterization)
Identifier String External identification number (It cannot be repeated)YES 
CommentsStringBoleto CommentsNO
Products ObjectProduct listYES 
SellerPersonType Short Type of Issuer of the boleto
0 - Individuals (natural person)
1 - Company (legal person)
YES 
SellerName String Legal Name of the Boleto issuing accountYES 
SellerTaxNumber String CPF/CNPJ of the Boleto issuing accountYES 
ReceiverPersonType Short Type of receiver of the boleto
0 - Individuals (natural person)
1 - Company (legal person)
YES 
ReceiverName String Legal Name of the Boleto receiverYES 
ReceiverTaxNumber String CPF/CNPJ of the Boleto receiverYES 
ReceiverBankStringInternal account receiver identification BankNO 
ReceiverBankBranchStringInternal account receiver identification Bank Branch NO
ReceiverBankAccountStringInternal account receiver identification Bank AccountNO 
ReceiverBankAccountDigitStringInternal account receiver identification Bank Account DigitNO
Reference String Transaction descriptionYES 
ProductCode String Transaction descriptionYES 
ProductName String Transaction descriptionYES 
ProductQty Decimal Transaction descriptionYES 
ProductValue Decimal Value of boletoYES 
AutomaticType IntSend True, to activate the parameter for automatic Bank TransferNO
AccountTypeInt0 - Checking account
1 - Savings account
NO 
BankStringBank CodeNO
BankBranchStringBank BranchNO
BankAccountStringBank AccountNO
BankAccountDigitStringBank Account DigitNO 
ProductRateValueToTransferDecimalDebit made at the supplier by transferNO
DueDate DateTime (yyyy/mm/dd)YES 
ExpirationDaysDecimalNumber of days to pay the boleto after the due dateNO
TotalValue Decimal Value of boletoYES
FineDateDateTime(yyyy/mm/dd)NO
FinePercentDecimalFine PercentNO
FineValueDecimalFine ValueNO
InterestPercentDecimalInterest PercentNO
InterestValueDecimalInterest ValueNO
InterestTypeDecimalInterestType = 0 (daily)
InterestType = 1 (monthly)
NO
InterestDateDateTimeDate for charging interestNO
DiscountDateDateTime(yyyy/mm/dd)NO
DiscountValueDecimalDiscount ValueNO
DiscountDate2DateTime(yyyy/mm/dd)NO
DiscountValue2DecimalDiscount valueNO
DiscountDate3DateTime(yyyy/mm/dd)NO
DiscountValue3DecimalDiscount valueNO
RebateValueDecimalRebate ValueNO
TagsString Tag ListNO

Issuance of reoccurring boleto

API Method = GenerateRecurrenceBoleto
The recurring bill is a charge that happens periodically, like a subscription plan. This time is defined in the contract.

ParameterTypeDescriptionMandatory
Method String GenerateRecurrenceBoletoYES 
MktPlaceId Long FitBank provided IDYES 
PartnerId Long FitBank provided IDYES 
BusinessUnitId Long FitBank provided IDYES
GroupTemplate String Send as number 2, by defaultYES
CustomerName String Payer nameYES 
CustomerTaxNumber String CPF/CNPJ of the payerYES 
CustomerMail String E-mail of the payerYES 
CustomerPhone StringPhone number of the payerYES
Neighborhood String Payer neighborhoodNO
PhoneToSendStringPhone To SendNO
MailToSend String Mail To Send YES
City StringPayer CityYES 
State String Payer City (Ex: SP, RJ, BA, etc)YES 
ZipCode String Payer ZipCodeYES 
SupplierTaxNumber String CPF/CNPJ of the Boleto issuing accountYES 
SupplierFullName String Full Name of the Boleto issuing accountYES 
SupplierTradingName String Trading Name of the Boleto issuing accountYES 
SupplierLegalName String Legal Name of the Boleto issuing accountYES 
SupplierMailStringAccount holder's emailNO
SupplierPhoneStringAccount holder's phone numberNO
RateValue Decimal Debit made at the supplier by boleto YES 
RateSent Boolean 0 - Default
1 - Value send at the RateValue field
YES 
AddressLine1 String Payer addressYES 
AddressLine2StringPayer's Address additionalNO
ExternalNumber String External identification numberYES 
Identifier String External identification number (It cannot be repeated)YES
Comments String Boleto CommentsNO 
Products ObjectProduct listYES
SellerPersonType Short Type of Issuer of the boleto
0 - Individuals (natural person)
1 - Company (legal person)
YES
SellerName String Legal Name of the Boleto issuing accountYES
SellerTaxNumber String CPF/CNPJ of the Boleto issuing accountYES
ReceiverPersonType ShortType of receiver of the boleto
0 - Individuals (natural person)
1 - Company (legal person)
YES
ReceiverName StringLegal Name of the Boleto receiverYES
ReceiverTaxNumber String CPF/CNPJ of the Boleto receiverYES
Reference String Transaction descriptionYES
ProductCode String Transaction descriptionYES
ProductName String Transaction descriptionYES
ProductQty Decimal Transaction descriptionYES
ProductValue Decimal Value of boletoYES
ProductRateValue Decimal Value of boletoYES
AutomaticTypeIntSend True, to activate the parameter for automatic Bank TransferNO
AccountTypeInt0 - Checking account
1 - Savings account
NO
BankStringBank CodeNO
BankBranchStringBank BranchNO
BankAccountString Bank AccountNO 
BankAccountDigitStringBank Account DigitNO
ProductRateValueToTransfer DecimalDebit made at the supplier by transferNO
DueDate DateTime (yyyy/mm/dd)YES 
TotalValue Decimal Value of boletoYES 
FineDate DateTime (yyyy/mm/dd)NO 
FinePercent Decimal Fine PercentNO 
InterestValue Decimal InterestValueNO 
DiscountDate DateTime (yyyy/mm/dd)NO 
DiscountValue Decimal Discount ValueNO
RebateValue Decimal Rebate ValueNO 
InstallmentsNumber Int Number of recurrece boletoYES
Carnet Boolean CarnetYES