1.3 Collection Order - Hybrid (Boleto with PIX QR Code)

Introduction

This offers the possibility of having hybrid billing, where it is possible, for the same biller, to choose the payment method that will be used offering an evolution of traditional billing and payment methods.

Instead of just having the conventional barcode, users will now have a QR Code to scan and make instant payments through Pix. This method offers significant advantages, especially for companies, who have lots to gain by using a more agile payment method.

The idea is to combine the practicality of Pix with the full functionality of bank slips, providing an efficient and comprehensive payment solution.

🚧

Version 1

This documentation is under construction and may be changed

How it works

Using our EndPoint GenerateCollectionOrder, indicating the CollectionOrderType = 2, you will be able to generate a Boleto with QR Code and give your customers the option of how to pay, either through Pix or barcode.

Receive notifications on the status of each payment

As soon as the payment is made, either through the payment of the barcode or PIX, you will receive the receipt information. You can also monitor changes in the status of boletos by receiving our webhooks.

Sending a hybrid 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.

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 through 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": 0,
  "businessUnitId": 0,
  "identifier": "string",
  "collectionOrderType": 2,
  "principalValue": 0,
  "rebateValue": 0,
  "interestValue": 0,
  "fineValue": 0,
  "finePercent": 0,
  "interestPercent": 0,
  "dueDate": "2024-04-15T18:47:44.190Z",
  "expirationDate": "2024-04-15T18:47:44.190Z",
  "fineDate": "2024-04-15T18:47:44.190Z",
  "interestDate" : "2024-04-15T18:47:44.190Z",
  "discount": {
    "type": 1,
    "discountRange": [
      {
        "discountDate": "2024-04-15T18:47:44.190Z",
        "discountValue": 0
      }
    ]
  },
  "payer": {
    "name": "string",
    "gender": 0,
    "maritalStatus": 0,
    "ocuppation": "string",
    "motherName": "string",
    "nationality": "string",
    "country": "string",
    "birthCity": "string",
    "birthState": "string",
    "city": "string",
    "state": "string",
    "zipCode": "string",
    "birthDate": "string",
    "companyType": 0,
    "companyActivity": "string",
    "constitutionDate": "2024-04-15T18:47:44.190Z",
    "payerContactInfo": {
      "mail": "string",
      "phone": "string"
    },
    "payerAccountInfo": {
      "pixKey": "string",
      "pixKeyType": 0,
      "taxNumber": "string",
      "bank": "stri",
      "bankBranch": "string",
      "bankAccount": "string",
      "bankAccountDigit": "s"
    },
  },
  "customer": {
    "name": "string",
    "customerAccountInfo": {
      "pixKey": "string",
      "pixKeyType": 0,
      "taxNumber": "string",
      "bank": "stri",
      "bankBranch": "string",
      "bankAccount": "string",
      "bankAccountDigit": "s"
    }
  },
  "receivers": {
    "collectionOrderProductType": 0,
    "receiver": [
      {
        "splitValue": 0.01,
        "name": "string",
        "nickname": "string",
        "birthDate": "string",
        "tradingName": "string",
        "legalName": "string",
        "constitutionDate": "2024-04-15T18:47:44.190Z",
        "receiverContactInfo": {
          "mail": "string",
          "phone": "string"
        },
        "receiverAccountInfo": {
          "pixKey": "string",
          "pixKeyType": 0,
          "taxNumber": "string",
          "bank": "stri",
          "bankBranch": "string",
          "bankAccount": "string",
          "bankAccountDigit": "s"
        }
      }
    ]
  }
}

Description:

📘

Explanation

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).

Collection order status: