Sign in

v1

latestOpenAPI 3.0.12026-07-26254581767.1 KB
Diretorio

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

<br> <b>Idempotência</b>

<br>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. <br>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). <br>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.

post/pix/indireto/dict/vinculo

Headers

api-versionstring required
Authorizationstring required

Auth

Request body

razao'SolicitacaoUsuario' | 'FechamentoConta' | 'TransferenciaAgencia' | 'Reconciliacao' | 'Fraude'

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.

requestIdstring uuid nullable

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.

Response

Quando o vínculo da chave foi criado com sucesso.

correlationIdstring nullable

Retorna ou define o identificador de correlação para o suporte operacional do DICT.

dataCriacaostring date-time

Retorna ou define a data de criação do vínculo.

dataPossestring date-time

Retorna ou define a data a partir da qual o dono tem posse ininterrupta da chave de endereçamento. A posse da chave aqui é definida pela existência de um vínculo associando a chave ao dono, possivelmente com contas distintas.

dataAberturaReivindicacaostring date-time nullable

Retorna ou define a data da abertura do processo de reivindicação de posse ou portabilidade, caso a chave esteja possua um destes processos abertos no momento.