Skip to main content

Create Bank Billet Pix Deposit Batch

POST 
/v1/banking/billet-pix-deposit-batches
Tag: api-baas-post-banking-billet-pix-deposit-batchDescription: Create a new bank billet pix deposit batch by uploading a CSV file with the required information. The CSV must contain the following columns: payer_name, payer_document, description, amount, due_date. Optional columns: payer_email, interest_perc_value, fine_value, discount_value, fine_type, discount_type.

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

    UUID (v4) of the product that the request should use. Send it explicitly when the authenticated user has more than one product or when the integration must select a specific product. If omitted and the endpoint does not require it, the API uses the authenticated user's default product.

    x-product-target-user-uuid string

    UUID (v4) of the user on whose behalf the request should run within the selected product. If omitted, the request runs as the authenticated user. Requires x-product-uuid.

Body

required
    batch_name stringrequired

    Batch name.

    pix_key stringrequired

    Pix key.

    personalized booleanrequired

    Whether the billet PDF will be personalized or not.

    email_send_date date-time

    Email send date. Format: YYYY-MM-DD.

    file_id stringrequired

    CSV file ID

Responses​

Banking billet pix deposit batch created.

Schema
    id stringrequired

    Bank billet deposit batch ID.

    batch_name stringrequired

    Batch name.

    status stringrequired

    Possible values: [UNDER_ANALYSIS, VALIDATED, REJECTED, GENERATED, FAILED]

    Bank billet deposit batch status.

    personalized booleanrequired

    Whether the billet PDF is personalized or not.

    pix_key stringrequired

    Pix key.

    file_id stringrequired

    File ID of uploaded CSV.

    email_send_date date-time

    Email send date.

    created_at date-timerequired

    Creation date.

Loading...