Consulta de saldo de uma conta pocket
Este endpoint permite realizar a consulta do saldo de uma conta pocket específica.
Requisição (Request)
Requisição HTTP
GET 'https://api-mtls.sandbox.bankly.com.br/pockets/{pocketNumber}/balances'
--request GET \
--url 'https://api-mtls.sandbox.bankly.com.br/pockets/1516482BR/balances' \
--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. |
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 os seguintes campos em formato JSON:
| Nome | Tipo | Descrição |
|---|---|---|
data | object | Objeto que contém informações sobre o saldo da conta pocket. |
data.total | object | Objeto que contém informações sobre o valor total do saldo. |
data.total.value | number | Valor total do saldo. |
data.total.currency | string | Código da moeda com base na ISO-4217. Exemplo: “BRL”. |
data.available | object | Objeto que contém informações sobre o valor disponível para uso. |
data.available.value | number | Valor disponível para uso. |
data.available.currency | string | Código da moeda com base na ISO-4217. Exemplo: “BRL”. |
data.hold | object | Objeto que contém informações sobre o valor em processamento para ingressar na conta pocket. |
data.hold.value | number | Valor em processamento. |
data.hold.currency | string | Código da moeda com base na ISO-4217. Exemplo: “BRL”. |
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. |
metadata | dictionary<string, object> | Dicionário de metadados que trará dados adicionais da requisição. |
{
"data": {
"total": {
"value": 125,50,
"currency": "BRL"
},
"available": {
"value": 50,
"currency": "BRL"
},
"hold": {
"value": 100,
"currency": "BRL"
},
"links": [
{
"url": "string",
"rel": "string",
"method": "string"
}
],
"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.
Updated 23 days ago