Skip to main content

CreateBankingBilletPixAutomaticRecurrenceBodyParam

    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).