Skip to main content

Create Decoded Pix Key ID

GET 
/pix/payment/decode/by-key
deprecated

This endpoint has been deprecated and may be replaced or removed in future versions of the API.

Generate a new Decoded Pix Key ID to facilitate pix payments by pix key. Provide the pix key's information in the request body and execute to obtain its ID (decoded_pix_key_id), which is required for creating pix payments using a pix key.

Request​

Query Parameters

    key stringrequired

    Pix key.

    type stringrequired

    Possible values: [CNPJ, CPF, PHONE, EMAIL, EVP]

    Pix Key state:

    • CPF: Key type CPF.
    • EVP: Key type EVP.
    • EMAIL: Key type EMAIL.
    • PHONE: Key type PHONE.
    • CNPJ: Key type CNPJ.

    endToEndId string

    If one is not provided, it'll be generated by DICT and returned in the response

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

    x-lang string

    Possible values: [pt-BR, en-US]

    Indicates the preferred language. Defaults to Brazilian Portuguese if unspecified.

Responses​

Pix key decoded successfully.

Schema
    id stringrequired

    Unique decoded pix key UUID.

    type stringrequired

    Possible values: [CNPJ, CPF, PHONE, EMAIL, EVP]

    Pix Key state:

    • CPF: Key type CPF.
    • EVP: Key type EVP.
    • EMAIL: Key type EMAIL.
    • PHONE: Key type PHONE.
    • CNPJ: Key type CNPJ.

    person_type stringrequired

    Possible values: [NATURAL_PERSON, LEGAL_PERSON]

    key stringrequired

    Pix key.

    document stringrequired

    Owner document number.

    name stringrequired

    Owner name.

    trade_name string

    Company's trade name.

    end_to_end_id stringrequired
    ispb string

    Bank ISPB.

    bank_name string

    Bank name.

Loading...