Skip to main content

CreatePixAccountConfigBody

    name stringrequired

    Possible values: [block_pix_devolution, block_pix_deposit_without_qrcode, block_pix_deposit_from_third_party, block_pix_devolution_received, force_reverse_deposit]

    Config type (block) to create. Choose one of the values below:

    • block_pix_devolution: Blocks the Z.ro user from sending Pix refunds. When the user receives a transfer, he is prevented from returning the funds to the payer.
    • block_pix_deposit_without_qrcode: Blocks Pix deposits received without a QR Code. Deposits addressed to the Z.ro user by Pix key or account data are rejected.
    • block_pix_deposit_from_third_party: Blocks Pix deposits from third-party payers. On static QR Codes with a defined expected payer, deposits from any other payer are rejected.
    • block_pix_devolution_received: Blocks Pix refunds received by the Z.ro user. When the user is the payer, refunds initiated by the external receiving institution are rejected.

    apply_to_all booleanrequired

    When true, creates the config for every wallet/Pix account belonging to the owner targets within the product. When false, the items array is required.

    items object[]

    Required non-empty array when apply_to_all is false; omit when true.

  • Array [
    • wallet_id stringrequired

    UUID of the wallet that owns the Pix account.

    pix_account_id stringrequired

    Pix account UUID belonging to the wallet.

  • ]