Skip to main content

DecodeAndCreateByPixKeyPaymentRestResponse

    decoded_pix_key object
    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 stringrequired

    Bank ISPB.

    bank_name stringrequired

    Bank name.

    payment object
    id stringrequired

    Payment UUID.

    operation_id string

    Operation UUID. Used to get receipt and track the transaction. This will not be returned if the payment has been scheduled.

    state stringrequired

    Possible values: [PENDING, SCHEDULED, WAITING, WAITING_DELAYED, CONFIRMED, FAILED, CANCELED]

    Payment state.

    end_to_end_id stringrequired
    value numberrequired

    Value in R$ cents.

    payment_date date-timenullable

    Schedule a day to execute payment. Use null to send payment right now.

    description stringnullable

    User defined payment description.

    created_at date-timerequired

    Payment created date.

    failed_code string

    Possible values: [DOCUMENT_NOT_ALLOWED, BANK_NOT_ALLOWLIST, BANK_IN_BLACKLIST]

    Reason that decoded pix key is invalid. Check this field to know if decoded and payment are valid.