Consulta de chaves de uma conta

Requisição (Request)

Requisição HTTP

GET https://sandbox.hiperbanco.com.br/pix/{{accountNumber}}

--request GET 'https://sandbox.hiperbanco.com.br/pix/{{accountNumber}}' \
--header 'version: cutting-edge' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {{token}}' \

Cabeçalhos (Headers)

Nome	Propriedade	Descrição
version	cutting-edge	Essa propriedade garante que o response da API seja retornado no formato JSON

Parâmetros da rota (Path)

No path desta requisição envie os seguintes campos:

Nome	Tipo	Descrição	Especificação
accountNumber	path	Obrigatório. Número da conta a ser consultada.	Informe somente números.

Resposta (Response)

O status code 200 indicará sucesso na consulta.Sendo bem-sucedido, o retorno irá trazer uma lista de objetos contendo as propriedades das chaves cadastradas, em formato JSON:

[
    {
        "type": "EMAIL",
        "value": "[email protected]"
    }
]

Erros

Este endpoint não retorna erros específicos. Porém, ele poderá retornar alguns erros comuns entre todos os endpoints.

Eventos

Este endpoint não possui eventos relacionados a ele.