Consulta de contas

Este endpoint retorna todos os dados de uma conta, seja de pagamentos ou corrente, de clientes pessoa física.

Requisição (Request)

Requisição HTTP

GET https://api-mtls.sandbox.bankly.com.br/customers/{documentNumber}/accounts

--request GET
--url 'https://api-mtls.sandbox.bankly.com.br/customers/47742663023/accounts?code=413?ispb=01858774?branch=2020?type=checking?status=active' \
--header 'accept: application/json' \
--header 'api-version: 1.0' \
--header 'Authorization: Bearer {{Token}}' \

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
`account.read`	Concede acesso para consultar informações (status, saldo etc.) sobre uma conta de pagamentos.

Cabeçalhos (Headers)

Nome	Descriçã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.

Parâmetros da rota (Path)

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

Nome	Tipo	Descrição
`documentNumber`	`path`	Obrigatório. Número do CPF do cliente.
`code`	`query`	Código do banco da conta consultada.
`branch`	`query`	Número da agência associada à conta consultada.
`type`	`query`	Tipo de conta, que pode ser "CHECKING" ou "PAYMENT".
`status`	`query`	Situação da conta, que pode ser "ACTIVE" ou "CLOSED".

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 contas com os seguintes campos em formato JSON:

Nome	Tipo	Descrição
`status`	`string`	Situação da conta, que pode ser "ACTIVE" ou "CLOSED".
`branch`	`string`	Número da agência associada à conta.
`number`	`string`	Número da conta.
`type`	`string`	Tipo de conta, que pode ser "CHECKING" (corrente) ou "PAYMENT" (pagamento).
`bank`	`object`	Objeto que contém informações sobre o banco ao qual a conta pertence.
`bank.ispb`	`string`	ISPB (Identificador de Sistema de Pagamentos Brasileiro) do banco.
`bank.code`	`string`	Código do banco.
`bank.name`	`string`	Nome do banco.
`programId`	`string`	Identificador do programa de contas que determina o tipo de conta.

[
    {
        "status": "ACTIVE",
        "branch": "0001",
        "number": "11111",
        "type": "Checking",
        "bank": {
            "ispb": "01858774",
            "code": "413",
            "name": "Acesso Soluções De Pagamento SA - Instituição de Pagamento"
        },
        "programId": "d83c37b2-fb71-477c-b689-8ec95ab810c8"
    },
    {
        "status": "ACTIVE",
        "branch": "0001",
        "number": "15164",
        "type": "Payment",
        "bank": {
            "ispb": "13140088",
            "code": "332",
            "name": "Acesso Soluções De Pagamento SA - Instituição de Pagamento"
        },
        "programId": "9e7360f2-bb55-4990-bdbb-3e0d32152a33"
    }
]

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.