Consulta dos dados de todas as pockets
stable
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 (Request)
Requisição HTTP
GET https://api-mtls.sandbox.bankly.com.br/accounts/{accountNumber}/pockets?pocketType={pocketType}?status={status}'?pageSize={pageSize}?page={page}?branch={branch}
--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:
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 os seguintes campos:
Nome | Tipo | Descrição |
---|---|---|
accountNumber | path | Obrigatório. Número da conta de pagamento com o dígito. |
pocketType | query | Tipo da conta e sigla da moeda utilizada. Exemplo: POCKET_BRL. |
status | query | Status das contas pockets que deseja visualizar. |
pageSize | query | Quantidade de itens a serem retornados por página. |
page | query | Número da página a ser retornada na consulta. |
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. |
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:
Nome | Tipo | Descrição |
---|---|---|
data[] | array of objects | Lista de objetos contendo informações sobre as pockets. |
data[].number | string | Número da conta pocket. |
data[].label | string | Nome da pocket criada. |
data[].suffix | string | Sufixo atribuído ao número da pocket. Exemplo: BRL. |
data[].currency | string | Código da moeda com base na ISO-4217. Exemplo: “BRL”. |
data[].type | string | Tipo da conta e código da moeda utilizada. Exemplo: POCKET_BRL. |
data[].status | string | Status das contas pockets no momento da consulta. |
data[].reason | string | Motivo da situação da conta pocket, que pode ser "HOLDER_REQUEST" (solicitação do titular) ou "COMMERCIAL_DISAGREEMENT" (desacordo comercial). |
data[].category | string | Categoria da conta. |
data[].useCase | enum | Especificação da finalidade da pocket, que pode ser “CORPORATE_EXPENSES” (despesas corporativas), “FLEXIBLE_BENEFITS” (benefícios diversos) e “BALANCE_SEGREGATION” (saldo reservado). |
data[].createdAt | string | Data de criação da conta pocket, no formato ISO 8601 - UTC. |
data[].updatedAt | string | Data de atualização da conta pocket, no formato ISO 8601 - UTC. |
data[].user | objetc | Objeto que contém informações sobre o usuário da conta pocket. |
data[].user.name | string | Nome do usuário. |
data[].user.document | object | Objeto que contém informações sobre o 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. |
{
"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 about 1 month ago