InstitucionalBlogService DeskStatus Page

Consulta dos dados de todas as pockets

stable

Suggest Edits

Este endpoint possibilita listar os dados de todas as pockets associadas a uma conta de pagamento. A busca permite filtrar pelo tipo e status da pocket.

Requisição

Requisição HTTP

GET https://api-mtls.sandbox.bankly.com.br/accounts/{accountNumber}/pockets?pocketType={pocketType}?status={status}'?pageSize={pageSize}?page={page}?branch={branch}

 curl --request GET \
     --url 'https://api-mtls.sandbox.bankly.com.br/accounts/15164/pockets?pocketType=Pocket_BRL&status=ACTIVE&pageSize=1&page=1' \
     --header 'accept: application/json'
     --header 'api-version: 2' \
     --header 'authorization: Bearer' \
     --header 'idempotency-key: f5ff2ba3-76c0-4aa0-8015-a93b62a6c100'

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:

ScopeDescrição
pocket.readConcede acesso para a consulta de dados das contas pockets.

Cabeçalhos (Headers)

NomeDescrição
api-versionObrigatório. A versão desta API é a 2.0.
AuthorizationObrigatório. Token de autorização do tipo Bearer.

Parâmetros da rota (Path)

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

NomeTipoDescrição
accountNumberpathObrigatório. Número da conta de pagamento com o dígito.
pocketTypequeryTipo da conta e sigla da moeda utilizada. Exemplo: POCKET_BRL.
statusqueryStatus das contas pockets que deseja visualizar. Suas possibilidades de preenchimento se encontram na tabela Status da conta pocket.
pageSizequeryQuantidade de itens a serem retornados por página.
pagequeryNúmero da página a ser retornada na consulta.

Status da conta pocket

StatusDescriçã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.

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.

Sendo bem-sucedido, o retorno irá trazer uma lista contendo os seguintes campos em formato JSON:

NomeTipoDescrição
data[]array of objectsLista de objetos que contém os dados de uma pocket.
data[].numberstringNúmero da conta pocket.
data[].labelstringNome da pocket criada.
data[].suffixstringSufixo atribuído ao número da pocket. Exemplo: BRL.
data[].currencystringSigla da moeda utilizada, de acordo com a ISO 4217.
data[].typestringTipo da conta e sigla da moeda utilizada. Exemplo: POCKET_BRL.
data[].statusstringEstado das contas pockets no momento da consulta. Suas possibilidades de preenchimento se encontram na tabela Status da conta pocket.
data[].reasonstringMotivo 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[].categorystringCategoria da conta.
data[].useCaseenumEspecificaçã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[].createdAtstringData de criação da conta pocket, no formato ISO 8601 - UTC.
data[].updatedAtstringData de atualização da conta pocket, no formato ISO 8601 - UTC.
data[].userobjetcObjeto que contém os dados do usuário da conta pocket.
data[].user.namestringNome do usuário.
data[].user.documentobjectObjeto que contém os dados do documento do usuário.
data[].user.document.valuestringNúmero do documento.
data[].user.document.typestringTipo do documento (CPF ou CNPJ).
data[].user.birthDatestringData de nascimento do usuário, no formato ISO 8601 - UTC.
links[]array of objectsLinks de próximos estados válidos da entidade/recurso.
links[].urlstringURLs que podem ser utilizadas em um próximo estado da entidade.
links[].relstringDescrição de como a URL se relaciona com o recurso atual.
links[].methodstringTipo de verbo que deve ser utilizado para acessar a URL. Nesse caso, é o GET.
metadatadictionary<string, object>Dicionário de metadados que trará dados adicionais da requisição.
{
    "data": [
        {
            "number": "1516482BRL",
            "label": "Viagem",
            "suffix": "BRL",
            "currency": "BRL",
            "type": "POCKET_BRL",
            "status": "ACTIVE",
            "reason": "HOLDER_REQUEST",
            "category": "POCKET",
            "useCase": "CORPORATE_EXPENSES",
            "createdAt": "2022-10-07T21:33:48.6659Z",
            "updatedAt": "2022-11-24T14:56:26.3881Z",
            "user": {
                "name": "Nísia Floresta",
                "document": {
                    "value": "47742663023",
                    "type": "CPF"
                },
                "birthDate": "1810-10-12T00:00:00Z"
            },
        }
    ],
    "links": [],
    "metadata": {
        "totalRecords": 1,
        "nextPage": 3,
        "previewPage": 2
    }
}

👍

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 12 days ago