Sign in

v1

latestOpenAPI 3.0.12026-07-26254581767.1 KB
Diretorio

Obtém um vínculo contendo os detalhes de conta transacional associados a uma chave de endereçamento.

<b>Limitação de requisições</b>

A consulta a chaves está sujeita à política de limitação (rate-limiting) de requisições. A limitação funciona com base em cabeçalhos enviados na requisição. Os cabeçalhos de requisição são obrigatórios para todos os tipos de chaves.

O parâmetro Documento é o identificador do usuário final e é usado para aplicar as políticas de limitação com escopo de usuário. Deve ser preenchido com o CPF ou CNPJ (apenas dígitos), a depender do tipo da entidade titular da conta pagadora.

</br>

<b>Estatísticas</b>

Através do parâmetro opcional IncluirEstatisticas, é possível indicar se as informações de contadores antifraude devem ou não ser incluídas na resposta.

get/pix/indireto/dict/vinculo/{chave}

Path parameters

chavestring required

string representando a chave de endereçamento.

Query parameters

incluirEstatisticasboolean

Incluir dados antifraude na resposta.

Headers

documentostring required

string representando o número identificador do pagador que originou a requisição. Corresponde ao número do CPF do pagador para pessoa física ou o número do CNPJ do pagador para pessoa jurídica.

endToEndIdstring

string representando o identificador fim-a-fim do pagamento associado a essa requisição. Corresponde ao campo EndToEndId na mensagem pacs.008.

api-versionstring required
Authorizationstring required

Auth

Response

Quando a consulta do vínculo for executada com sucesso.

correlationIdstring nullable

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

dataCriacaostring date-time nullable

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

dataPossestring date-time nullable

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.