---
title: "Generate Collection Order"
method: POST
path: "/GenerateCollectionOrder"
tags: ["Collection"]
---

# Generate Collection Order

`POST /GenerateCollectionOrder`

## Request body

- object
  - `Method` string, required — Method name
  - `PartnerId` integer, required — Partner identifier provided by Fitbank
  - `BusinessUnitId` integer, required — Number Of The BusinessUnit
  - `Identifier` string, required — Identifier Of The Transaction
  - `CollectionOrderType` '0 - DynamicPixQrCodeDueDate' | '1 - Boleto' | '2 - BoletoPixQrCode' | '3 - DynamicPixQRCode', enum — Collection Order Type
  - `PrincipalValue` number, float, required — Collection Order Value
  - `RebateValue` number, float — Rebate amount
  - `InterestValue` number, float — Interest Value
  - `FineValue` number, float — Fine Value
  - `FinePercent` number, float, required — Fine Percent
  - `InterestPercent` number, float, required — Interest Percent
  - `FineDate` string, date — Fine Date (format YYYY-MM-DD)
  - `DueDate` string, date — Date of Due (format YYYY-MM-DD)
  - `ExpirationDate` string, date, required — Expiration Date (format YYYY-MM-DD)
  - `InterestDate` string, date — Interest Date (format YYYY-MM-DD)
  - `Payer` Payer, required
    - `TaxNumber` string, required — Tax Number
    - `Bank` string — Bank code
    - `BankAccount` string — Bank account
    - `BankAccountDigit` string — Bank account digit
    - `BankBranch` string — Bank branch
  - `Customer` Customer, required — Collection order customer person
    - `Name` string, required — Customer name
    - `CustomerAccountInfo` CustomerAccountInfo, required — Person bank data
      - `PixKey` string, required — PIX Key
      - `TaxNumber` string, required — Account holder document
      - `Bank` string, required — Bank code
      - `BankBranch` string, required — Bank Branch code
      - `BankAccount` string, required — Bank Account code
      - `BankAccountDigit` string, required — Bank Account Digit
  - `MinPaymentValue` number — MinPaymentValue
  - `MaxPaymentValue` number — MaxPaymentValue
  - `DivergentPaymentType` '1 - AnyValue' | '2 - MinAndMaxValue' | '3 - NotAllowed' | '4 - OnlyMinValue', enum — Divergent Payment Type
  - `OperationVars` object[] — Custom fields for the PDF
    - `Key` string
    - `Value` string
  - `InstructionsToPayer` string — Payment instructions
  - `NeedSplitConfirmation` boolean — Signals whether the split will be done after confirmation
  - `Receivers` Receivers — Collection order receivers person
    - `CollectionOrderProductType` '0 - Ammount' | '1 - Percentage', required — Split Type
    - `Receiver` object[], required — Collection order receiver person
      - `SplitValue` number, float, required
      - `Name` string, required
      - `Nickname` string
      - `BirthDate` string, date — Date format: YYYY-MM-DD
      - `LegalName` string
      - `TradingName` string
      - `ConstitutionDate` string, date — Date format: YYYY-MM-DD
      - `ReceiverContactInfo` ReceiverContactInfo, required — The person contacts
        - `Mail` string
        - `Phone` string
      - `ReceiverAccountInfo` ReceiverAccountInfo, required — Person bank data
        - `PixKey` string — PIX Key
        - `TaxNumber` string, required — Account holder document
        - `Bank` string — Bank code
        - `BankBranch` string — Bank Branch code
        - `BankAccount` string — Bank Account code
        - `BankAccountDigit` string — Bank Account Digit
  - `Discount` Discount
    - `Type` integer
    - `DiscountRange` object[]
      - `DiscountDate` string, date
      - `DiscountValue` number, float
  - `Rate` Rate — Collection order rate
    - `Sent` boolean
    - `Value` number

## Response `200`

Results

- object
  - `Success` string
  - `DocumentNumber` integer
  - `Message` string
  - `ErrorCode` integer

---

[API](https://skmtc.net/fitbank/apis/onboarding.md) · [All operations](https://skmtc.net/fitbank/apis/onboarding/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/fitbank/onboarding/versions/f94d262a8f58/schema)