Skip to main content

Create Banking Billet Pix Deposit Template

POST 
/v1/banking/billet-pix-deposit/templates
Tag: api-baas-post-banking-billet-pix-deposit-templateDescription: Create a banking billet pix deposit template with logo and optional merchandise.

Request​

Header Parameters

    x-transaction-uuid stringrequired

    The transaction ID is a UUID (v4) used to uniquely identify the object that will be created. All objects must have an identifier.

    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.

Body

required
    logo_file_id stringrequired

    Logo file ID.

    merchandise_file_id string

    Merchandise file ID (optional).

    color stringrequired

    Template color.

    merchandise_url string

    Merchandise URL (optional).

    button_title_label string

    Button title label (optional).

Responses​

Banking billet pix deposit template created successfully.

Schema
    id stringrequired

    Banking billet pix deposit template ID.

    user_id stringrequired

    User ID owner of the template.

    wallet_id stringrequired

    Wallet ID related to the template.

    template_name stringrequired

    Template name.

    props objectrequired

    Template properties.

    created_at date-timerequired

    Creation date.

    updated_at date-timerequired

    Update date.

    deleted_at date-time

    Deletion date.

Loading...