Skip to main content

Get Bank Billet Pix Deposit Batch By ID

GET 
/v1/banking/billet-pix-deposit-batches/:id
Tag: api-baas-get-banking-billet-pix-deposit-batch-by-idDescription: Get a bank billet pix deposit batch by ID.

Request​

Path Parameters

    id stringrequired

    Bank billet pix deposit batch ID.

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​

Bank billet pix deposit batch found.

Schema
    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...