Skip to main content

Create Bank Billet for Deposit

POST 
/banking/billet-pix-deposit
Tag: api-paas-post-banking-billet-pix-depositDescription: Create a new bank billet for deposit by providing the required information in the request body and executing the operation.

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
    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 amount or percentage).

    fine_type string

    Possible values: [AMOUNT, PERCENTAGE]

    Fine type.

    discount_value number

    Discount value (in 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).

    payer_name string

    Payer's name.

    personalized booleanrequired

    Whether the billet PDF will be personalized or not.

Responses​

Banking billet for deposit created.

Schema
    id stringrequired

    Bank billet deposit ID.

    operation_id stringrequired

    Bank billet deposit operation ID.

    state stringrequired

    Possible values: [CREATED_PENDING, CREATED_WAITING, CREATED_CONFIRMED, CREATED_FAILED, RECEIVED]

    Bank billet deposit state.

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

    discount_value number

    Discount value (converted to integer amount).

    due_date date-timerequired

    Due date.

    limit_due_date date-timerequired

    Limit due date.

    barcode stringrequired

    Barcode.

    typeable_line stringrequired

    Typeable line.

    created_at date-timerequired

    Creation date.

    personalized booleanrequired

    Whether the billet PDF is personalized or not.

Loading...