Consulta de chaves de uma conta
stable
Este endpoint permite consultar a lista de chaves de endereçamento vinculadas a uma conta de pagamento.
Requisição
Requisição HTTP
GET https://api-mtls.sandbox.bankly.com.br/accounts/{{accountNumber}}/addressing-keyss
--request GET \
--url https://api-mtls.sandbox.bankly.com.br/accounts/{{accountNumber}}/addressing-keys \
--header 'Authorization: Bearer {{token}}' \
--header 'accept: application/json' \
--header 'api-version: 1' \
--header 'x-bkly-pix-user-id: {{userDocument}}' \
--header 'x-correlation-id: {{GUID}}'
Autorização
Para garantir a segurança nas requisições, todos os endpoints do Bankly utilizam scopes como parte do seu fluxo de autorização.
Esta requisição requer o scope descrito a seguir:
| Scope | Descrição |
|---|---|
pix.account.read | Concede acesso para consultar as chaves vinculadas a uma conta. |
Cabeçalhos (Headers)
| Nome | Descrição | Especificação |
|---|---|---|
api-version | Obrigatório. Versão da API. Atualmente estamos na versão 1.0. | — |
Authorization | Obrigatório. Token de autorização do tipo Bearer. | — |
x-bkly-pix-user-id | Obrigatório. Número do documento do usuário que está fazendo a requisição. | Insira somente números, sem formatação. |
x-correlation-id | Informe um GUID v4. A cada requisição, deve-se gerar um novo GUID. | — |
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. |
Corpo da requisição (Body)
Não é necessário enviar campos no body desta requisição.
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:
| Nome | Tipo | Descrição |
|---|---|---|
type | string | Tipo de chave de endereçamento, o qual pode ser: CPF, CNPJ, EMAIL, PHONE ou EVP. |
value | string | Valor da chave. |
[
{
"type": "CPF",
"value": "47742663023"
}
]
Dica
Para simular uma requisição nesse endpoint, acesse o API Reference.
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.
Updated 13 days ago