API Reference

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

get
https://example.com/pix/indireto/dict/vinculo/

Limitação de requisições

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.


Estatísticas

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.

Path Params
string
required

string representando a chave de endereçamento.

Query Params
boolean

Incluir dados antifraude na resposta.

Headers
string
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.

string

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

string
required
string
required

Auth

string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Updated 9 months ago

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

Updated 9 months ago