Skip to main content

List Bank Billet Deposit Batch Items

GET 
/v1/banking/billet-pix-deposit-batch-items
Tag: api-baas-get-banking-billet-pix-deposit-batch-item-by-batch-idDescription: Retrieve a list of bank billet deposit batch items by batch ID. Use optional filter parameters to refine your search.

Request​

Query Parameters

    page number

    Default value: 1

    Page number.

    size number

    Possible values: <= 100

    Default value: 20

    Page size. Max size is 100.

    sort string

    Possible values: [created_at]

    Page sort attribute.

    order string

    Possible values: [asc, desc]

    Default value: asc

    Page order.

    banking_billet_pix_deposit_batch_id stringrequired

    Batch ID.

    status string

    Possible values: [BILLET_WAITING, BILLET_CREATED, BILLET_FAILED]

    Status.

    created_at_period_start date-time

    Start date of the created at period in the format YYYY-MM-DD.

    created_at_period_end date-time

    End date of the created at period in the format YYYY-MM-DD.

Header Parameters

    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.

Responses​

The billet batch items returned successfully.

Schema
    page numberrequired

    Page number.

    page_size numberrequired

    Page size.

    page_total numberrequired

    Page total.

    total numberrequired

    Total of elements.

    data object[]required

    Bank billet pix deposit batch items data.

  • Array [
    • id stringrequired

    Bank billet deposit batch item ID.

    payer_name stringrequired

    Payer name.

    payer_document stringrequired

    Payer document (CPF/CNPJ).

    payer_email string

    Payer email.

    description stringrequired

    Description.

    amount numberrequired

    Amount in cents

    interest_perc_value number

    Interest percentage value.

    fine_value number

    Fine value in cents.

    discount_value number

    Discount value in cents.

    status stringrequired

    Possible values: [BILLET_WAITING, BILLET_CREATED, BILLET_FAILED]

    Status.

    email_status string

    Possible values: [SCHEDULED, SENT, FAILED]

    Email status.

    due_date date-timerequired

    Due date.

    banking_billet_pix_deposit_batch_id stringrequired

    Bank billet deposit batch ID.

    created_at date-timerequired

    Creation date.

    updated_at date-timerequired

    Update date.

  • ]
Loading...