Skip to main content

Create Bank Billet Deposit Batch Item

POST 
/v1/banking/billet-pix-deposit-batch-items
Tag: api-baas-post-banking-billet-pix-deposit-batch-itemDescription: Create a new bank billet deposit batch item.

Request​

Header Parameters

    x-transaction-uuid stringrequired

    The transaction ID is a UUID (v4) used to uniquely identify the object that will be created. All objects must have an identifier.

    x-wallet-uuid string

    Sender Wallet UUID (if empty, your default Wallet UUID will be settled)

    nonce stringrequired

    The nonce ID is a UUID (v4) used to uniquely identify the request. All requests must have an identifier.

    x-lang string

    Possible values: [pt-BR, en-US]

    Indicates the preferred language. Defaults to Brazilian Portuguese if unspecified.

    x-product-uuid string

    The product ID is a UUID (v4) used to identify the Z.ro product configuration.

    x-product-target-user-uuid string

    The product target user ID is a UUID (v4) used to identify what user account this request must be executed. Require: x-product-uuid.

Body

required
    banking_billet_pix_deposit_batch_id stringrequired

    Banking billet deposit batch ID

    payer_name string

    Payer name.

    payer_document string

    Payer document.

    payer_email string

    Payer email.

    description stringrequired

    Description.

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

Responses​

Banking billet deposit batch item created.

Schema
    id stringrequired

    Bank billet deposit batch item ID.

    banking_billet_pix_deposit_batch_id stringrequired

    Bank billet deposit batch ID.

    status stringrequired

    Possible values: [BILLET_WAITING, BILLET_CREATED, BILLET_FAILED]

    Bank billet deposit batch item status.

    payer_name stringrequired

    Payer name.

    payer_document stringrequired

    Payer document.

    payer_email string

    Payer email.

    description stringrequired

    Description.

    amount numberrequired

    Amount specified in Brazilian Real (R$) cents.

    interest_perc_value number

    Interest value specified in percentage.

    fine_value number

    Fine value (converted to R$ cents).

    discount_value number

    Discount value (converted to R$ cents).

    due_date date-timerequired

    Due date.

    created_at date-timerequired

    Creation date.

Loading...