curl --request GET \
  --url https://api.ext.dbs.moneyp.dev.br/api/v3/Conta/Saldo \
  --header 'Authorization: <api-key>'
{
  "sucesso": true,
  "mensagem": "<string>",
  "dtUltAtualizacao": "2023-11-07T05:31:56Z",
  "vlrSaldo": 123,
  "vlrBloqueado": 123,
  "vlrAgendado": 123
}

Through this endpoint, partners can check the account balance. The system will return information regarding the amounts present in the partner’s account, including scheduled transactions and blocked balance.

Authorizations

​
Authorization
string
header
required

Copie 'Bearer ' + token

Query Parameters

​
NumeroBanco
integer
required

Número do banco.

Observação:

  • O 'número do banco' (numeroBanco) pode ter no máximo 3 caracteres.
​
Conta.Agencia
string
required

Número da agência bancária.

Maximum length: 4
​
Conta.AgenciaDigito
string

Dígito verificador da agência bancária.

Maximum length: 1
​
Conta.Conta
string

Número da conta bancária.

Observações:

  • Para que seja possível localizar a conta, é necessário informar o 'número da conta com dígito' (contaPgto) ou o 'número da conta' (conta) e o 'dígito verificador' (contaDigito).
  • Caso o 'número da conta com dígito' (contaPgto) seja informado, não é necessário preencher os campos 'número da conta' (conta) e 'dígito verificador' (contaDigito).
  • Caso nenhum dos campos referentes ao número da conta seja informado, ocorrerá erro na requisição devido à falta de informação vital.
Maximum length: 12
​
Conta.ContaDigito
string

Dígito verificador do número da conta bancária.

Maximum length: 1
​
Conta.ContaPgto
string

Número da conta bancária seguido do dígito verificador.

Maximum length: 20
​
Conta.TipoConta
enum<integer>
required

1 = Corrente<br>2 = Poupanca<br>3 = Pagamento<br>4 = Salario 1 = Corrente; 2 = Poupanca; 3 = Pagamento; 4 = Salario

Available options:
1,
2,
3,
4
​
Conta.ModeloConta
enum<integer>
required

1 = Movimento<br>2 = Escrow<br>3 = Vinculada 1 = Movimento; 2 = Escrow; 3 = Vinculada

Available options:
1,
2,
3

Response

200 - application/json

Success

The response is of type object.