Consultar saldo disponível na conta

POST

/api/ContaDigital/Saldo

ContaDigital

Funcionalidade principal

O endpoint Saldo tem como objetivo retornar o valor disponível em tempo real na conta digital do cliente. Ele reflete o montante que o usuário possui para realizar pagamentos, transferências ou saques, considerando os lançamentos já liquidados.

Casos de uso comuns

Home do aplicativo: Exibição imediata do saldo disponível assim que o usuário faz login.

Validação pré-transação: Consulta automática pelo sistema antes de abrir a tela de transferência (Pix/TED) para garantir que o usuário tem fundos suficientes.

Conciliação de Extrato: Verificação pontual para confirmar se um depósito de cash-in (como o feito via boleto no endpoint /Deposito) já foi processado.

Requisição

Authorization

Adicionar o parâmetro

Authorization

a Cabeçalhos, cujo valor é concatenar o Token após o Bearer.

Exemplo:

Authorization: Bearer ********************

Parâmetros Header

Parâmetros Bodyapplication/jsonNecessário

Examples

Respostas

🟢200Correto

application/json

Bodyapplication/json

Request Example

Shell

JavaScript

Java

Swift

curl --location '/api/ContaDigital/Saldo' \
--header 'UserName;' \
--header 'RequestOrigin;' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
    "Data": {
        "CodigoCanal": 0,
        "CodigoCliente": 0
    }
}'

Response Example

{
    "Data": {
        "Saldo": 0
    },
    "ResultCode": 0,
    "Message": "string",
    "ValidationData": {
        "ResultCode": 0,
        "Message": "string",
        "Errors": [
            {
                "ErrorMessage": "string",
                "FieldName": "string"
            }
        ]
    }
}

Modificado em 2026-03-03 15:03:29

Página anterior

Gerar boleto de recarga de conta

Próxima página

Consultar extrato da conta

Consultar saldo disponível na conta

Funcionalidade principal#

Casos de uso comuns#

Requisição

Respostas

Funcionalidade principal

Casos de uso comuns