Get Balance
GET {{url_contbank}}/partner-bff/s2s/balance?account_number=123456&result_level=DETAILED
Endpoint responsável por retornar os saldos das contas correntes.
Header
O CPF/CNPJ deve ser repassado no X-Current-Identity, no header da requisição.
Response Schema - 200 Ok
| Key | Value |
|---|---|
| branch_number | Indica o número da agência da conta. |
| account_number | Número da conta. |
| balance_date | Data do saldo |
| available.currency | Moeda do saldo disponível. BRL indica em reais. |
| available.amount | Saldo atual disponível. Valor monetário. |
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
account_number | number | Número da conta | |
result_level | string | BASIC ou DETAILED |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
X-Current-Identity | number | CNPJ/CPF do cliente |
RESPONSES
status: OK
{"branch_number":"0001","account_number":"123456","balance_date":"2024-05-12T00:00:00.000000000Z","available":{"currency":"BRL","amount":15213.91}}