Create DICT Key Transaction

⚠️ Important: To use this endpoint, include the header X-Trace-Version with the value 2.

DICT Key Types and Requirements The DICT Key must be one of the following valid types: CNPJ, CPF, email, phone number, or UUID version 4. Each type has specific formatting and validation rules as outlined below.

Key TypeRequirementValidation Pattern
CNPJNo formatting; must contain 14 characters14 numeric characters only
CPFNo formatting; must contain 11 characters11 numeric characters only
EmailMust be a valid email formatStandard email validation
CellphoneMust follow international format with '+' prefix^\+[1-9]\d{1,14}$
UUID v4Must be a valid UUID version 4Standard UUID v4 validation

Protection Feature To safeguard the system against misuse and to prevent depletion of user tokens from BACEN's DICT control, a protection mechanism is implemented. If an invalid DICT Key is submitted, it will automatically be added to a blacklist for a duration of one hour. This feature helps to prevent repeated attempts with invalid keys.

Cache Mechanism To prevent potential blocks from the BACEN DICT Control, the system caches bank account data after the first transaction using a specific DICT Key. Subsequent transactions with the same DICT Key utilize the cached data, returning a transaction type of BANK_INSTRUCTION instead of DICT_KEY.

Asynchronous Enrichment In the response of this request, both endToEnd and destination fields will be returned as null. These fields will be asynchronously populated at a later stage of the processing cycle. Additionally, due to the asynchronous nature of this processing, the transaction will initially be returned with REQUESTED status. Once the necessary data has been populated and the transaction has progressed, the status will be updated accordingly in subsequent stages.

Body Params
uuid

The bank account from which the PIX transaction will originate. Mutually exclusive with virtualAccountId - exactly one must be provided.

string

The virtual account from which the PIX transaction will originate. Mutually exclusive with bankAccountId - exactly one must be provided.

string
required

PIX DITC Key can be a random key, e-mail, phone number, CPF or CNPJ

amount
object
required

Monetary value

string
required

An idempotent identifier provided by the client to ensure that a request is processed only once. If a request with an existing IdempotentId is received, the processing is terminated and an error is returned to indicate that the request cannot be processed again.

validations
array of objects
validations
string | null

Optional message that can be sent to the recipient along with a PIX transaction. The message can be up to 140 characters long and must not contain the | (pipe) character.

Headers
string

Access Token

const
enum
required

Indicates the version of Trace Finance's API to be used. This header should be included by clients using version 2 of the API

Allowed:
Responses

Language
Credentials
OAuth2
URL
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json