Cria um novo vínculo de chave com uma conta transacional.


Idempotência


A operação de criação de vínculo é idempotente. Isso significa que é seguro realizar uma nova tentativa em caso de falhas temporárias, como erros de conexão ou término abrupto de processos. A resposta retornada para uma requisição repetida é equivalente à resposta dada à primeira requisição processada.
Para garantir a idempotência da operação, a requisição tem um campo RequestId. Esse campo é um UUID versão 4 e deve ser único no contexto de um mesmo participante. O RequestId fica associado ao vínculo criado e é usado no cálculo do seu CID (ver seção de reconciliação na documentação).
Uma requisição de criação é considerada repetida quando o CID do vínculo contido na requisição já existe no DICT. Caso seja feita uma requisição com um RequestId previamente usado, mas com parâmetros diferentes para o vínculo, será retornado o erro RequestIdAlreadyUsed.

Body Params

Representa o corpo da requisição POST para criação do novo vínculo de chave com a conta transacional.

Representa o corpo de uma requisição para criação de um novo vínculo de chave com conta transacional.

vinculo
object

Representa um vínculo entre uma chave de endereçamento do Pix no DICT, uma conta transacional e seu dono.

string
enum

Representa o tipo definindo os motivos de criação, atualização, remoção, reivindicação de posse ou reivindicação de portabilidade de vínculos de chaves de endereçamento do Pix no DICT.

Allowed:
uuid | null

Retorna ou define a chave de idempotência da requisição de criação de vínculo da chave de endereçamento do Pix no DICT, representado por um UUID versão 4.

Headers
string
required
string
required

Auth

string
enum
Defaults to application/json

Generated from available response content types

Allowed:
string
enum
Defaults to application/json-patch+json

Generated from available request content types

Allowed:
Responses

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
text/plain
application/json
text/json