Skip to main content

Generate or update the Banking Billet Pix Deposit PDF

GET 
/banking/billet-pix-deposit/:id/pdf
Tag: api-paas-get-banking-billet-pix-deposit-pdfDescription: Generates or updates the Banking Billet Pix Deposit PDF for the current wallet. Provide the deposit ID in the path and optionally set the personalize query to apply the wallet template. The response returns file metadata. Use storage/files/id/download to download the PDF.

Request​

Path Parameters

    id stringrequired

    Bank billet pix deposit ID.

Query Parameters

    personalize boolean

    When true, tries to apply the wallet personalized template (default: false).

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​

Banking Billet Pix Deposit PDF generated or updated.

Schema
    id stringrequired

    Bank billet pix deposit ID.

    file_name string

    Bank billet pix deposit file name.

    created_at date-time

    Bank billet pix deposit created at.

Loading...