CreateBankingBilletPixDepositBody

amount numberrequired

Amount specified in Brazilian Real (R$) cents.

interest_perc_value number

Interest value specified in percentage by month.

fine_value number

Fine value (in (R$) amount or percentage).

fine_type string

Possible values: [AMOUNT, PERCENTAGE]

Fine type.

discount_value number

Discount value (in (R$) amount or percentage).

discount_type string

Possible values: [AMOUNT, PERCENTAGE]

Discount type.

due_date date-timerequired

Due date. Format: YYYY-MM-DD.

pix_key stringrequired

Pix key.

description stringrequired

Description.

payer_document string

Payer's document (CPF or CNPJ) (required when pix_automatic_recurrence is provided).

payer_name string

Payer's name (required when pix_automatic_recurrence is provided).

payer_email string

Payer email.

personalized booleanrequired

Whether the billet PDF will be personalized or not

pix_automatic_recurrence object

frequency stringrequired

Possible values: [WEEKLY, MONTHLY, QUARTERLY, SEMI_ANNUALLY, ANNUALLY]

Frequency.

start_date date-timerequired

Date of the first payment of the automatic pix recurrence.

end_date date-time

Date for when the automatic pix recurrence will be ended.

value number

Recurrence fixed value for the charges in Brazilian Real (R$) cents.

floor_max_value number

Maximum floor value in Brazilian Real (R$) cents. Must not be provided if (fixed) value is provided.

owner_ispb stringrequired

Possible values: non-empty and <= 8 characters

Owner (payer) Bank ISPB.

debtor_document stringrequired

Debtor document (CPF or CNPJ).

debtor_name stringrequired

Debtor name.

contract_number stringrequired

Contract number or reference code.

contract_description string

Contract description.

tags string[]

Tags (max: 5).