2 - Sending a Collection Order in Brazil

Sending a Collection Order in Brazil

The customer will send a Collection Order through an EndPoint in FitBank’s API, and the Collection Orders must have the required data to order generation, sending, and payment procedures.

Sending a collection order

API Method = GenerateCollectionOrder

This method allows sending collection orders. Upon receiving the data sent by the customer, our API creates a payer that will initially pass for a KYC process. After that, an order will be sent, and the operation will be concluded with the processing of the settlement by the payer.

    "Method": "GenerateCollectionOrder",
    "PartnerId": 65,
    "BusinessUnitId": 63,
    "Identifier": "2019380948908423807893247",
    "CollectionOrderType": 0,
    "PrincipalValue": 0.50,
    "RebateValue": 0.00,
    "InterestValue": 0.00,
    "FineValue": 0.00,
    "FinePercent": 0.00,
    "InterestPercent": 0.00,
    "FineDate": "2022-10-31",
    "DueDate": "2022-11-10",
    "ExpirationDate": "2022-11-29",
    "Payer": {
        "Name": "Hellem Moura",
        "BirthDate": "2002-09-21",
        "ConstitutionDate": "2022-09-21",
        "Gender": 0,
        "MaritalStatus": 0,
        "Ocuppation": "dev",
      	"MotherName": "Maria",
        "Nationality": "Brasileiro",
        "Country": "Brsil",
        "BirthCity": "Crateús",
        "BirthState": "Ceará",
        "CompanyType": 0,
        "CompanyActivity": "Dev",
        "PayerContactInfo": {
            "Mail": "[email protected]",
            "Phone": "88999999999"
        "PayerAccountInfo": {
            "PixKey": "78690450041",
            "TaxNumber": "696159660001",
            "Bank": "",
            "BankBranch": "",
            "BankAccount": "",
            "BankAccountDigit": ""
    "Customer": {
        "Name": "Jose Reinaldo Sales Soares",
        "CustomerAccountInfo": {
            "PixKey": "83964318094",
            "TaxNumber": "69615966000130",
            "Bank": "450",
            "BankBranch": "0001",
            "BankAccount": "5454573",
            "BankAccountDigit": "4"
    "Receivers": {
        "CollectionOrderProductType": 1,
        "Receiver": [
                "SplitValue": 30,
                "Name": "JORDY BARROSO",
                "BirthDate": "2002-09-21",
                "ReceiverContactInfo": {
                    "Mail": "[email protected]",
                    "Phone": "88999999999"
                "ReceiverAccountInfo": {
                    "PixKey": "82781627194",
                    "TaxNumber": "736.333.810-82",
                    "Bank": "450",
                    "BankBranch": "0001",
                    "BankAccount": "198839682",
                    "BankAccountDigit": "4"


ParameterDescriptionTo Identify PayerTo Qualify PayerTypeComments
MethodName of the method to be usedYESYESSTRINGNone
PartnerIdPartner identifier provided by FitBankYESYESBIGINTNone
BusinessUnitIdBusiness unit identifier provided by FitBankYESYESBIGINTNone
IdentifierUnique ID provided by the customer to differentiate transactionsYESYESSTRINGNone
CollectionOrderTypeType of the chargeYESYESINTPixQrCodeDinamicDueDate = 0
Boleto = 1
BoletoPixQRCode = 2
PixQRCodeDinamic = 3
PrincipalValueValue of the Collection OrderYESYESDECIMALNone
RebateValueDiscount amountNONODECIMALNone
InterestValueInterest amountNONODECIMALNone
FineValueFine amountNONODECIMALNone
FinePercentFine percentageNONODECIMALNone
InterestPercentInterest percentageNONODECIMALNone
FineDateFine dateNONODATETIMEYYYY-MM-DD format
DueDateDue date for collectionYESYESDATETIMEYYYY-MM-DD format
ExpirationDateExpiration date of chargeYESYESDATETIMEYYYY-MM-DD format
PayerObject concerning payer's info--OBJECTNone
NamePayer’s name (NP or LP)YESYESSTRINGNone
BirthDatePayer's date of birth (NP only)DERISABLE FOR NPYESDATETIMEYYYY-MM-DD format
ConstituitionDateCompany's date of incorporation (LP only)DERISABLE FOR LPYES FOR LPDATETIMEYYYY-MM-DD format
GenderPayer’s gender (NP only)NOYESINTMale = 0
Female = 1
Other = 2
MaritalStatusPayer’s marital status (NP only)NOYESINTNotMarried = 0
Married = 1
Divorced = 2
Separate = 3
Widower = 4
Single = 5
Other = 6
OccupationPayer’s occupation (NP only)DERISABLE FOR NPYESSTRINGNone
MotherNamePayer's mother's name (NP only)DERISABLE FOR NPYESSTRINGNone
NationalityPayer’s nationality (NP only)DERISABLE FOR NPYESSTRINGNone
CountryPayer’s native countryDERISABLE FOR NPYESSTRINGNone
BirthCityPayer’s native city (NP only)NOYESSTRINGNone
BirthStatePayer’s native state (NP only)NOYESSTRINGNone
CompanyTypeCompany type (LP only)DERISABLE FOR LPYES FOR LPINTSA = 0
LTDA = 1
MEI = 2
ME = 3
Condominium = 5
Closed SA = 6
Simple EIRELI = 7
Outros = 8
CompanyActivityCompany activity (LP only)DERISABLE FOR LPYES FOR LPSTRINGNone
PayerContactInfoObject concerning payer's contact info--OBJECTNone
MailPayer’s e-mailNOYESSTRINGNone
PhonePayer’s phoneNOYESSTRINGNone
PayerAccountInfoObject concerning payer's account info--OBJECTNone
PixKeyPayer’s PIX keyNONOSTRINGNone
BankPayer’s bank codeNOYESSTRINGNone
BankBranchPayer’s bank branchNOYESSTRINGNone
BankAccountPayer's account number without digitNOYESSTRINGNone
BankAccountDigitPayer’s account digitNOYESSTRINGNone
CustomerObject concerning customer's info--OBJECTNone
NameCustomer’s name (NP or LP)YESYESSTRINGNone
CustomerAccountInfoObject concerning customer's account info--OBJECTNone
PixKeyBeneficiary’s (who will do the collection) PIX keyYESYESSTRINGNone
PixKeyTypeBeneficiary’s (who will do the collection) PIX key typeYESYESSTRINGSocialSecurity = 0
TaxNumber = 1
E-mail = 2
PhoneNumber = 3 RandomKeyCode = 4
TaxNumberBeneficiary’s (who will do the collection) CPF/CNPJYESYESSTRINGNone
BankBeneficiary’s (who will do the collection) bank codeYESYESSTRINGNone
BankBranchBeneficiary’s (who will do the collection) bank branchYESYESSTRINGNone
BankAccountBeneficiary’s (who will do the collection) account number without digitYESYESSTRINGNone
BankAccountDigitBeneficiary’s (who will do the collection) account digitYESYESSTRINGNone
ReceiversObject concerning receivers' info--OBJECTNone
ValueAmount to be splitNONODECIMALNone
CollectionOrderProductTypeSplit typeNONOINTAmount = 0
Percentage = 1
ReceiverObject concerning receiver's info--OBJECTNone
NameReceiver’s nameNONOSTRINGNone
BirthDateReceiver’s birth dateNONODATETIMEYYYY-MM-DD format
ReceiverContactInfoObject concerning receiver's contact info--OBJECTNone
MailReceiver’s e-mailNONOSTRINGNone
PhoneReceiver’s e-mail phoneNONOSTRINGNone
ReceiverAccountInfoObject concerning receiver's account info--OBJECTNone
PixKeyReceiver’s PIX keyNONOSTRINGNone
TaxNumberReceiver’s CPF/CNPJNONOSTRINGNone
BankReceiver’s bank codeNONOSTRINGNone
BankBranchReceiver’s bank branchNONOSTRINGNone
BankAccountReceiver’s account number without digitNONOSTRINGNone
BankAccountDigitReceiver’s account digitNONOSTRINGNone



NP = Natural Person

LP = Legal Person

Identified Payer = Identified Payer = Is the initial step, and will meet most cases, without the need for additional information (is the payer who only needs the information required to generate collection orders).

Qualified Payer = Qualification is a more in-depth step that demands more information about the beneficiary. This step will only be required when, after sending the initial request, the system returns a Canceled status with the following reason: Is a qualified person, you must send a Collection Order again, with the data { Name... }. In this situation, a new request must be sent, with the mandatory data for the qualification process (beneficiary who needs to present information previously considered optional for KYC validation).