Skip to main content

List Pix Account

GET 
/v1/pix/accounts

Retrieve a pix account.

Request​

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​

The pix account returned successfully.

Schema
    id stringrequired

    Pix account ID.

    user_id stringrequired

    User UUID.

    user_document stringrequired

    User document.

    onboarding_id stringrequired

    Onboarding UUID.

    account_number stringrequired

    Account number.

    branch_number stringrequired

    Branch number.

    active booleanrequired

    Pix account is active.

    default booleanrequired

    Pix account default flag.

    created_at date-timerequired

    Pix account created at.

Loading...