1 - Consultar Saldo

cURL

cURL

curl --request POST \
  --url https://api.bmpdigital.moneyp.dev.br/SolicitacaoAnalise/ConsultarSaldo \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'IdempotencyKey: <idempotencykey>' \
  --data '
{
  "dto": {
    "documentoCliente": "<string>"
  }
}
'

200

{
  "msg": "<string>",
  "hasError": true,
  "messages": [
    {
      "messageType": 1,
      "code": "<string>",
      "context": "<string>",
      "description": "<string>",
      "field": "<string>"
    }
  ],
  "saldoCliente": {
    "vlrSaldoCredito": 123,
    "vlrSaldoHotMoney": 123,
    "vlrSaldoRotativo": 123
  }
}

Esse método retorna os valores do saldo disponível para crédito de acordo com o limite de crédito existente, e a partir do documento informado;

Authorizations

Authorization · string · header · required

Informe o token

Headers

IdempotencyKey · string · required

Body

dto · object

Mostrar atributos filhos

dto. documentoCliente · string | null · required

Refere-se ao número do documento federal do cliente.

Maximum string length: 20

Response

200

text/plain

OK

msg · string | null

hasError · boolean

messages · object[] | null

Mostrar atributos filhos

messages. messageType · enum<integer>

Opções disponíveis: 1, 2, 3

messages. code · string | null

messages. context · string | null

messages. description · string | null

messages. field · string | null

saldoCliente · object

Mostrar atributos filhos

saldoCliente. vlrSaldoCredito · number<double>

saldoCliente. vlrSaldoHotMoney · number<double>

saldoCliente. vlrSaldoRotativo · number<double>