Consulta de contas do cliente pessoa jurídica

beta

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

Requisição

Requisição HTTP

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

curl --request GET \
     --url 'https://api-mtls.sandbox.bankly.com.br/customers/34183937000161/accounts' \
     --header 'accept: application/json' \
     --header 'x-bkly-license: 24ac71da-4309-4348-9cc0-a0c88f867993' \

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.
`x-bkly-license`	Obrigatório. Id da licença bancária vinculada ao produto.

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 CNPJ do cliente.

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`	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 os dados bancários da conta.
`bank.ispb`	`string`	ISPB 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": "2020",
        "number": "502000028434",
        "type": "Checking",
        "bank": {
            "ispb": "01858774",
            "code": "413",
            "name": "BCO BV S.A."
        },
        "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.