Consulta dos dados de uma conta pocket

Este endpoint permite realizar a consulta dos dados de uma conta pocket específica.

Requisição

Requisição HTTP

GET https://api-mtls.sandbox.bankly.com.br/pockets/{pocketNumber}?resultLevel={resultLevel}

curl --request GET \
     --url 'https://api-mtls.sandbox.bankly.com.br/pockets/1516482BR?resultLevel=DETAILED' \
     --header 'accept: application/json'
     --header 'api-version: 2' \
     --header 'authorization: Bearer'

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
`pocket.read`	Concede acesso para a consulta de dados das contas pockets.

Cabeçalhos (Headers)

Nome	Descrição
`api-version`	Obrigatório. A versão desta API é a 2.0.
`Authorization`	Obrigatório. Token de autorização do tipo Bearer.

Parâmetros da rota (Path)

No path desta requisição, envie o seguinte campo:

Nome	Tipo	Descrição
`pocketNumber`	`path`	Obrigatório. Número da conta pocket.
`resultLevel`	`query`	Nível de detalhamento da resposta (DETAILED ou BASIC).

📘
Nota
Caso o parâmetro resultLevel não seja enviado, a resposta trará os dados referentes a uma consulta do tipo BASIC.

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 busca.

A consulta básica (resultLevel=BASIC ou não informado) trará os seguintes campos em formato JSON:

Nome	Tipo	Descrição
`data`	`object`	Objeto que contém os dados de uma pocket.
`data.number`	`string`	Número da conta pocket.
`data.label`	`string`	Nome da pocket.
`data.suffix`	`string`	Sufixo atribuído ao número da pocket. Exemplo: BRL.
`data.currency`	`string`	Sigla da moeda utilizada, de acordo com a ISO 4217.
`data.type`	`string`	Tipo da conta e sigla da moeda utilizada. Exemplo: POCKET_BRL.
`data.status`	`string`	Estado das contas pockets no momento da consulta. Suas possibilidades de preenchimento se encontram na tabela Status da conta pocket.
`data.reason`	`string`	Motivo da situação da conta pocket. Os possíveis valores de retornados são: "HOLDER_REQUEST" (solicitação do titular) e "COMMERCIAL_DISAGREEMENT" (desacordo comercial).
`data.category`	`string`	Categoria da conta.
`data.useCase`	`enum`	Especificação da finalidade da pocket. As possibilidades de preenchimento são: “CORPORATE_EXPENSES” (despesas corporativas), “ACCOUNT_FOR_UNDER_AGE” (conta para menor de idade), “FLEXIBLE_BENEFITS” (benefícios diversos) e “BALANCE_SEGREGATION” (saldo reservado).
`data.createdAt`	`string`	Data de criação da pocket (formato DateTime).
`data.updatedAt`	`string`	Data de atualização da pocket (formato DateTime).
`data.user`	`objetc`	Objeto que contém os dados do usuário da conta pocket.
`data.user.name`	`string`	Nome do usuário.
`data.user.document`	`object`	Objeto que contém os dados do documento do usuário.
`data.user.document.value`	`string`	Número do documento.
`data.user.document.type`	`string`	Tipo do documento (CPF ou CNPJ).
`data.user.birthDate`	`string`	Data de nascimento do usuário, no formato ISO 8601 - UTC.
`links[]`	`array of objects`	Links de próximos estados válidos da entidade/recurso.
`links[].url`	`string`	URLs que podem ser utilizadas em um próximo estado da entidade.
`links[].rel`	`string`	Descrição de como a URL se relaciona com o recurso atual.
`links[].method`	`string`	Tipo de verbo que deve ser utilizado para acessar a URL. Nesse caso, é o GET.
`metadata`	`dictionary<string, object>`	Dicionário de metadados que trará dados adicionais da requisição.

A consulta detalhada (resultLevel=DETAILED) retornará todos os campos citados anteriormente e também os seguintes:

Nome	Tipo	Descrição
`data.account`	`object`	Objeto que contém os dados da conta de pagamento à qual a pocket está atrelada.
`data.account.branch`	`string`	Número da agência da conta de pagamento à qual a conta pocket está atrelada.
`data.account.number`	`string`	Número da conta de pagamento.
`data.account.status`	`string`	Situação da conta de pagamento que, nesse caso, será “ACTIVE”.
`data.account.reason`	`string`	Motivo da situação da conta de pagamento.
`data.account.createdAt`	`string`	Data de criação da conta de pagamento, no formato ISO 8601 - UTC.
`data.account.bank`	`object`	Objeto que contém os dados do banco da conta de pagamento.
`data.account.bank.ispb`	`string`	ISPB (Identificador de Sistema de Pagamentos Brasileiro) do banco.
`data.account.bank.code`	`string`	Código do banco.
`data.account.bank.name`	`string`	Nome do banco.
`data.account.holder`	`object`	Objeto que contém informações sobre o titular da conta de pagamento.
`data.account.holder.document`	`object`	Objeto que contém dados do documento do titular da conta de pagamento.
`data.account.holder.document.value`	`string`	Número do documento.
`data.account.holder.document.type`	`string`	Tipo de documento (CPF ou CNPJ).
`data.account.holder.type`	`string`	Tipo do cadastro do titular da conta de pagamento (“CUSTOMER” ou “BUSINESS”).
`data.account.holder.name`	`string`	Nome do titular da conta de pagamento.
`data.account.holder.status`	`string`	Situação do cadastro do titular.
`data.account.holder.createdAt`	`string`	Data de criação do cadastro do titular no formato ISO 8601 - UTC.

Status da conta pocket

Status	Descrição
“ACTIVE”	Indica que a conta pocket foi criada com sucesso.
“DORMANT”	Indica que a conta não recebeu nenhuma movimentação no período de 60 dias.
“LOCKED”	Indica que a conta não pode realizar movimentações (cash-in ou cash-out).
“CLOSED”	Status exibido quando o cancelamento da pocket foi solicitado.

{
    "data": {
        "number": "1516482BRL",
        "label": "Viagem",
        "suffix": "BRL",
        "currency": "BRL",
        "type": "POCKET_BRL",
        "status": "ACTIVE",
        "reason": "HOLDER_REQUEST",
        "category": "POCKET",
        "useCase": "CORPORATE_EXPENSES",
        "createdAt": "2022-11-23T13:50:34.826Z",
        "updatedAt": "2022-11-23T13:50:34.826Z",
        "user": {
            "name": "Nísia Floresta",
            "document": {
                "value": "47742663023",
                "type": "CPF"
            },
            "birthDate": "1810-10-12T00:00:00Z"
        }
    },
    "links": [
        {
            "url": "/pockets/249378139BRL/balances",
            "rel": "get_pocket_balances",
            "method": "GET"
        },
        {
            "url": "/pockets/249378139BRL/transactions/redeems",
            "rel": "create_pocket_transaction_redeems",
            "method": "POST"
        },
        {
            "url": "/pockets/249378139BRL/transactions/savings",
            "rel": "create_pocket_transaction_savings",
            "method": "POST"
        },
        {
            "url": "/pockets/249378139BRL/closure",
            "rel": "close_pocket",
            "method": "PATCH"
        }
    ],
    "metadata": {
        "additionalProp": {}
    }
  }

{
    "data": {
        "number": "1516482BRL",
        "label": "Viagem",
        "suffix": "BRL",
        "currency": "BRL",
        "type": "POCKET_BRL",
        "status": "ACTIVE",
        "reason": "HOLDER_REQUEST",
        "category": "POCKET",
        "useCase": "CORPORATE_EXPENSES",
        "createdAt": "2022-11-23T13:50:34.826Z",
        "updatedAt": "2022-11-23T13:50:34.826Z",
        "user": {
            "name": "Nísia Floresta",
            "document": {
                "value": "47742663023",
                "type": "CPF"
            },
            "birthDate": "1810-10-12T00:00:00Z"
        },
        "account": {
            "number": "15164",
            "branch": "0001",
            "status": "ACTIVE",
            "reason": "HOLDER_REQUEST",
            "createdAt": "2022-11-16T16:52:48.5972Z",
            "bank": {
                "ispb": "13140088",
                "code": "332",
                "name": "Acesso Soluções De Pagamento S.A."
            },
            "holder": {
                "document": {
                    "value": "47742663023",
                    "type": "CPF"
                },
                "type": "CUSTOMER",
                "name": "Nísia Floresta",
                "status": "ACTIVE",
                "createdAt": "2022-11-16T16:52:17.6625Z"
            }
        }
    },
    "links": [
        {
            "url": "/pockets/249378139BRL/balances",
            "rel": "get_pocket_balances",
            "method": "GET"
        },
        {
            "url": "/pockets/249378139BRL/transactions/redeems",
            "rel": "create_pocket_transaction_redeems",
            "method": "POST"
        },
        {
            "url": "/pockets/249378139BRL/transactions/savings",
            "rel": "create_pocket_transaction_savings",
            "method": "POST"
        },
        {
            "url": "/pockets/249378139BRL/closure",
            "rel": "close_pocket",
            "method": "PATCH"
        }
    ],
    "metadata": {
        "additionalProp": {}
    }
  }

👍
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.

Consulta dos dados de uma conta pocket

Requisição

Requisição HTTP

Autorização

Cabeçalhos (Headers)

Parâmetros da rota (Path)

📘
Nota

Corpo da requisição (Body)

Resposta (Response)

Status da conta pocket

👍
Dica

Erros

Eventos

Requisição

Requisição HTTP

Autorização

Cabeçalhos (Headers)

Parâmetros da rota (Path)

📘Nota

Corpo da requisição (Body)

Resposta (Response)

Status da conta pocket

👍Dica

Erros

Eventos

📘
Nota

👍
Dica