Generate Collection Order

post

https://sandboxapi.fitbank.com.br/main/execute/GenerateCollectionOrder

Body Params

Method

string

required

Method name

PartnerId

int64

required

Partner identifier provided by Fitbank

BusinessUnitId

int64

required

Business unit identifier

Identifier

string

required

Unique ID provided by client to differentiate transactions

CollectionOrderType

string

enum

Collection Order Type

Allowed:

PrincipalValue

float

required

Collection Order Value

RebateValue

float

Rebate amount

InterestValue

float

Interest Value

FineValue

float

Fine Value

FinePercent

float

required

Fine Percent

InterestPercent

float

required

Interest Percent

FineDate

date

Fine Date (format YYYY-MM-DD)

DueDate

date

Date of Due (format YYYY-MM-DD)

ExpirationDate

date

required

Expiration Date (format YYYY-MM-DD)

InterestDate

date

Interest Date (format YYYY-MM-DD)

Payer

object

required

Collection order payer person

Customer

object

required

Collection order customer person

MinPaymentValue

number

MinPaymentValue

MaxPaymentValue

number

MaxPaymentValue

DivergentPaymentType

string

enum

Divergent Payment Type

Allowed:

OperationVars

array of objects

Custom fields for the PDF

OperationVars

InstructionsToPayer

string

length ≤ 1000

Payment instructions

NeedSplitConfirmation

boolean

Signals whether the split will be done after confirmation

Receivers

object

Collection order receivers person

Discount

object

Rate

object

Collection order rate

Response

Language

Credentials

Basic

base64

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Results