CreatePixAutomaticRecurrenceBodyParam

journey stringrequired

Possible values: [JOURNEY_1, JOURNEY_2, JOURNEY_3, JOURNEY_4]

Automatic pix journey. JOURNEY_1: An automatic pix recurrence will be created and a notification to the payer will be sent. JOURNEY_2: A QRCode will be generated to be shared with the payer to approve the automatic pix recurrence. JOURNEY_3: A QRCode will be generated to be shared with the payer to approve the automatic pix recurrence and pay an immediate charge. JOURNEY_4: A QRCode will be generated to be shared with the payer to pay or schedule the payment of the charge and approve (optional) the automatic pix recurrence.

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.

owner_name string

Owner (payer) name (required if journey 3 or 4).

owner_document stringrequired

Owner (payer) document (CPF or CNPJ).

owner_bank_branch string

Possible values: non-empty and <= 5 characters

Owner (payer) Bank branch (required if journey 1).

owner_bank_account string

Owner (payer) Bank account number (required if journey 1).

debtor_document stringrequired

Debtor document (CPF or CNPJ) (required if journey 2, 3 or 4).

debtor_name string

Debtor name (required if journey 2, 3 or 4).

contract_number stringrequired

Contract number or reference code.

contract_description string

Contract description.

tags string[]

Tags (max: 5).

request_expiration_date date-time

Expiration date (required if journey 1).

pix_key_id string

Pix key ID (required if journey 3 or 4).

charge_value number

Charge value (required if journey 3 or 4).

charge_due_date date-time

Charge due date (required if journey 4).

interest_perc_value number

Interest value specified in percentage by month. Available only for journey 4.

fine_value number

Fine value (in (R$) amount or percentage). Available only for journey 4.

fine_type string

Possible values: [AMOUNT, PERCENTAGE]

Fine type. Available only for journey 4.

discount_value number

Discount value (in (R$) amount or percentage). Available only for journey 4.

discount_type string

Possible values: [AMOUNT, PERCENTAGE]

Discount type. Available only for journey 4.