Skip to main content

Create Decoded Pix Account ID

POST 
/pix/payment/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 requisition. All requisitions must have an identifier.

Body

required
    person_type string

    Possible values: [NATURAL_PERSON, LEGAL_PERSON]

    Person type:

    • NATURAL_PERSON.
    • LEGAL_PERSON.

    document stringrequired

    Person's document (CPF or CNPJ).

    bank_ispb string

    Bank ISPB code (8 digits)

    branch string

    Account branch (4 digits).

    account_number string

    Account number (between 1 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]

    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.

Loading...