Skip to main content

Get Bank Billet Pix Deposit By ID

GET 
/banking/billet-pix-deposit/:id
Tag: api-paas-get-banking-billet-pix-deposit-by-idDescription: Get a bank billet pix deposit by ID.

Request​

Path Parameters

    id stringrequired

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

    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​

Bank billet pix deposit found.

Schema
    id stringrequired

    Bank billet pix deposit ID.

    state stringrequired

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

    amount numberrequired

    Bank billet pix deposit amount in cents.

    interest_perc_value number

    Bank billet pix deposit interest value in percentage.

    fine_value number

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

    operation_id stringrequired

    Operation ID.

    file_id string

    banking billet pix deposit PDF file id

    transaction_tag string

    Transaction tag.

    personalized boolean

    Whether the billet PDF is personalized or not.

    created_at date-timerequired

    Created at.

    confirmed_at date-time

    Confirmed at.

    pix_key stringrequired

    Pix key.

    emv string

    EMV code.

Loading...