Skip to main content

Get Bank Billet Deposit Batch Item by ID

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

Request​

Path Parameters

    id stringrequired

    Batch item 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​

The billet batch item returned successfully.

Schema
    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

    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.

    banking_billet_pix_deposit_id string

    Banking billet pix deposit ID.

    barcode string

    Barcode.

    emv string

    EMV code.

    created_at date-timerequired

    Creation date.

    updated_at date-timerequired

    Update date.

Loading...