Skip to main content

List Bank Billet Deposits

GET 
/banking/billet-pix-deposit
Tag: api-paas-get-banking-billet-pix-depositDescription: Retrieve a list of bank billet deposits. 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.

    state string

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

    State.

    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

    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.

Responses​

The deposits 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 data.

  • Array [
    • 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

    Bank billet pix deposit interest value in percentage.

    fine_value number

    Bank billet pix deposit fine (converted to integer amount).

    discount_value number

    Bank billet pix deposit 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.

    key stringrequired

    Pix key.

    key_id string

    Pix key id.

    emv string

    Emv.

    transaction_tag string

    Transaction tag.

    file_id string

    Bank billet pix deposit file ID.

    personalized boolean

    Whether the billet PDF is personalized or not.

    created_at date-timerequired

    Creation date.

    confirmed_at date-time

    Confirmation date.

  • ]
Loading...