Skip to main content

List Bank Billet Deposit Batches

GET 
/v1/banking/billet-pix-deposit-batches
Tag: api-baas-get-banking-billet-pix-deposit-batchDescription: Retrieve a list of bank billet deposit batches. 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.

    status string

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

    Status.

    batch_name string

    Batch name.

    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 batches 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 data.

  • Array [
    • id stringrequired

    Bank billet deposit batch ID.

    pix_key_id stringrequired

    Pix key ID.

    batch_name stringrequired

    Batch name.

    status stringrequired

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

    Status.

    email_send_date date-time

    Date on which the bank billets will be sent by email.

    personalized booleanrequired

    Whether the banking billets will be created using a template or not.

    file_id string

    File ID (CSV).

    items_count number

    Quantity of items (banking billets) of the batch

    created_at date-timerequired

    Creation date.

    updated_at date-timerequired

    Update date.

  • ]
Loading...