Informações da conta + Saldo

Este endpoint permite consultar os dados de uma conta específica.

Pré-requisitos

Para que seja possível utilizar este endpoint, é necessário que:

O cliente do parceiro possua uma conta ativa.
O parceiro esteja autenticado.

Requisição (Request)

Requisição HTTP

GET https://sandbox.hiperbanco.com.br/AccountsInternal/{{loginAccountNumber}}

--request GET 'https://sandbox.hiperbanco.com.br/AccountsInternal/{{loginAccountNumber}}' \
--header 'version: cutting-edge' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {{token}}'

Cabeçalhos (Headers)

Nome	Propriedade	Descrição
`version`	`cutting-edge`	Obrigatório. Essa propriedade garante que o response da API seja retornado no formato JSON
`Authorization`	`Bearer token`	Obrigatório. Token de autorização do tipo Bearer.

Parâmetros da rota (Path)

Nome	Tipo	Descrição	Especificação
`loginAccountNumber`	`path`	Obrigatório. Número da conta logada.	Use somente numeros.

Corpo da requisição (Body)

Não é necessário enviar campos no body desta requisição.

Resposta (Response)

O status code 200 indica sucesso. Retorno em formato JSON:

Nome	Tipo	Descrição
`balance`	`object`	Objeto que contém informações sobre o saldo da conta.
`balance.inProcess`	`object`	Objeto que contém informações sobre o saldo em processamento.
`balance.inProcess.amount`	`number`	Valor do saldo em processamento.
`balance.inProcess.currency`	`string`	Código da moeda com base na ISO-4217. Exemplo: “BRL”.
`balance.available`	`object`	Objeto que contém informações sobre o saldo disponível na conta.
`balance.available.amount`	`number`	Valor do saldo disponível.
`balance.available.currency`	`string`	Código da moeda com base na ISO-4217. Exemplo: “BRL”.
`balance.blocked`	`object`	Este objeto está obsoleto e, portanto, deve ser desconsiderado, pois sempre retornará o valor zero. Para obter informações sobre o saldo bloqueado, por favor, abra um chamado no Service Desk ou utilize os eventos de webhook de bloqueio de saldo.
`balance.blocked.amount`	`number`	Valor do saldo bloqueado, o qual sempre retornará 0.
`balance.blocked.currency`	`string`	Código da moeda com base na ISO-4217. Exemplo: “BRL”.
`status`	`string`	Situação da conta, que pode ser "ACTIVE" ou "CLOSED".
`branch`	`string`	Número da agência associada à conta consultada.
`number`	`string`	Número da conta consultada.
`type`	`string`	Tipo de conta. Neste caso, "PAYMENT".
`bank`	`object`	Objeto que contém informações sobre o banco ao qual a conta pertence.
`bank.ispb`	`string`	ISPB (Identificador de Sistema de Pagamentos Brasileiro) 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.

{
    "branch": "0001",
    "number": "1101568743",
    "programId": "78fd959d-5aa5-49c0-b30c-f604db77499c",
    "bank": {
        "ispb": "13140088",
        "code": "332",
        "name": "Acesso Soluções De Pagamento SA - Instituição de Pagamento"
    },
    "status": "ACTIVE",
    "type": "Payment",
    "balance": {
        "inProcess": {
            "amount": 194.8,
            "currency": "BRL"
        },
        "available": {
            "amount": 83593.45,
            "currency": "BRL"
        },
        "blocked": {
            "amount": 0,
            "currency": "BRL"
        }
    }
}

Erros

Este endpoint pode retornar alguns erros específicos, conforme a tabela a seguir:

Status Code	Código	Mensagem	Descrição
`404`	`ACCOUNT_NOT_FOUND`	Account not found with number...	Conta não encontrada.

Recordamos que esta API também poderá retornar erros comuns entre todos os endpoints que acompanham os erros 400 (se houver).

Eventos

Este endpoint não possui eventos relacionados a ele.