Skip to main content

Create a Pix account config (block) for accounts.

POST 
/v1/pix/account-config

Owner-only endpoint that creates a PixAccountConfig of the informed name (always ACTIVE) for the selected accounts. Set apply_to_all=true to reach every wallet/pix account of every target user under the owner product, or send an explicit items array to target specific wallet+pix_account pairs. Existing configs are left untouched (use the update endpoint to change their state).

Request​

Header Parameters

    x-include-replay-protection-schema string

    The replay-protection-schema allows the user to choose between 3 options:

    • If there's no value: The default protection checks that the values in this request are equal: { method, params, path, query, body, userId }. This means that if a request repeats the same values, it will be blocked.
    • 'nonce': The nonce and { method, params, path, query, body, userId } value are checked. When the protection schema is this, requests will be OK if this nonce value is different in each request.
    • 'x-transaction-uuid': The transactionId and { method, params, path, query, body, userId } value are checked. Requests will be OK if this x-transaction-uuid value is different in each request.
    • 'x-transaction-uuid&nonce' or 'nonce&x-transaction-uuid': The nonce, transactionId value and { method, params, path, query, body, userId } are checked, i.e. if requests are repeated the same value in both fields, they will be blocked. But if any field has a different value, the request is OK.

    nonce stringrequired

    The nonce ID is a UUID (v4) used to uniquely identify the request. All requests must have an identifier.

    x-product-uuid stringrequired

    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.

    x-lang string

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

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

Body

required
    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.

  • ]

Responses​

Pix account config created successfully.

Schema
    affected_count numberrequired

    Number of pix account configs created.

Loading...