v1

latestOpenAPI 3.0.0Apache 2.02026-07-263079321.1 MB

Collection

Generate Collection Order

post/GenerateCollectionOrder

Request body

Methodstring required

Method name

PartnerIdinteger required

Partner identifier provided by Fitbank

BusinessUnitIdinteger required

Number Of The BusinessUnit

Identifierstring required

Identifier Of The Transaction

CollectionOrderType'0 - DynamicPixQrCodeDueDate' | '1 - Boleto' | '2 - BoletoPixQrCode' | '3 - DynamicPixQRCode' enum

Collection Order Type

PrincipalValuenumber float required

Collection Order Value

RebateValuenumber float

Rebate amount

InterestValuenumber float

Interest Value

FineValuenumber float

Fine Value

FinePercentnumber float required

Fine Percent

InterestPercentnumber float required

Interest Percent

FineDatestring date

Fine Date (format YYYY-MM-DD)

DueDatestring date

Date of Due (format YYYY-MM-DD)

ExpirationDatestring date required

Expiration Date (format YYYY-MM-DD)

InterestDatestring date

Interest Date (format YYYY-MM-DD)

MinPaymentValuenumber

MinPaymentValue

MaxPaymentValuenumber

MaxPaymentValue

DivergentPaymentType'1 - AnyValue' | '2 - MinAndMaxValue' | '3 - NotAllowed' | '4 - OnlyMinValue' enum

Divergent Payment Type

InstructionsToPayerstring

Payment instructions

NeedSplitConfirmationboolean

Signals whether the split will be done after confirmation

Example request

{
  "Method": "GenerateCollectionOrder",
  "PartnerId": 30324,
  "BusinessUnitId": 4548,
  "Identifier": "PurchaseTest1106new4",
  "PrincipalValue": 5,
  "RebateValue": 1,
  "InterestValue": 1,
  "FineDate": "2022-10-24",
  "DueDate": "2022-10-24",
  "ExpirationDate": "2022-10-25",
  "InterestDate": "2022-10-24",
  "Payer": {
    "TaxNumber": "83833430000111",
    "Bank": "001",
    "BankAccount": "01241455",
    "BankAccountDigit": "1",
    "BankBranch": "0001"
  },
  "Customer": {
    "Name": "Jhon",
    "CustomerAccountInfo": {
      "PixKey": "966fd70b-7a8d-4080-b42d-d63051e51adb",
      "TaxNumber": "24.841.311/0001-41",
      "Bank": "450",
      "BankBranch": "0001",
      "BankAccount": "5454573",
      "BankAccountDigit": "9"
    }
  },
  "OperationVars": [
    {
      "Key": "Boleto rates"
    }
  ],
  "InstructionsToPayer": "Dear payer, remember the outstanding debt. Please regularize it to avoid complications.",
  "NeedSplitConfirmation": true,
  "Receivers": {
    "Receiver": [
      {
        "SplitValue": 3,
        "Name": "Maurilson Silva",
        "Nickname": "Maurilson",
        "BirthDate": "2000-10-14",
        "LegalName": "Amazon LTDA",
        "TradingName": "Amazon LTDA",
        "ConstitutionDate": "2000-10-14",
        "ReceiverContactInfo": {
          "Mail": "contato@fitbank.com.br",
          "Phone": "(99) 99999-9999"
        },
        "ReceiverAccountInfo": {
          "PixKey": "966fd70b-7a8d-4080-b42d-d63051e51adb",
          "TaxNumber": "24.841.311/0001-41",
          "Bank": "450",
          "BankBranch": "0001",
          "BankAccount": "5454573",
          "BankAccountDigit": "9"
        }
      }
    ]
  },
  "Discount": {
    "Type": 1,
    "DiscountRange": [
      {
        "DiscountDate": "2024-04-11",
        "DiscountValue": 0.02
      }
    ]
  },
  "Rate": {
    "Sent": true
  }
}

Response

Results

Successstring

DocumentNumberinteger

Messagestring

ErrorCodeinteger