Skip to main content

Create Decoded Pix Account ID

POST 
/v1/pix/payments/decode/by-account

Generate a new Decoded Pix Account ID to enable pix payments by bank account. Enter the bank account's information in the request body below and execute to obtain its ID (decoded_pix_account_id), which is required for creating pix payments using a bank account.

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.

    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
    person_type stringrequired

    Possible values: [NATURAL_PERSON, LEGAL_PERSON]

    Person type:

    • NATURAL_PERSON.
    • LEGAL_PERSON.

    document stringrequired

    Person's document (CPF or CNPJ).

    bank_ispb stringrequired

    Bank ISPB code (8 digits)

    branch stringrequired

    Account branch (4 digits).

    account_number stringrequired

    Account number (between 2 and 20 digits).

    account_type string

    Possible values: [CACC, CASH, CHAR, CISH, COMM, CPAC, LLSV, LOAN, MGLD, MOMA, NREX, ODFT, ONDP, OTHR, SACC, SLRY, SVGS, TAXE, TRAN, TRAS, CC, PG, CD, CG, CI, PP]

    Account type:

    • CACC: Checking account.
    • SLRY: Salary.
    • SVGS: Savings.

Responses​

Decoded account returned successfully.

Schema
    id stringrequired

    Pix decoded account ID.

    name stringrequired

    Person full name or company tax name.

    trade_name string

    Company trade name.

    ispb stringrequired

    Bank ISPB.

    bank_name stringrequired

    Bank name.

Loading...