Check account balance

GET https://api.somossimpay.com.br/v2/finance/get-balance/?account_branch_identifier=xxxx&account_number=xxxxx

This endpoint is used to query the bank account balance.

Params (Query Params)

Parameter	Value	Description	Example
account_branch_identifier	Number	Required. The bank branch identifier/agency code	Ex: 0001
account_number	Number	Required. The account number	Ex: 401050

Headers

Parameter	Type	Description	Example
Authorization	String	Bearer + Access_token	Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ0b2tlbl90eXBlIjoiYWNjZXNzIiwiZXhwIjoxNzEzMzAwOTMxLCJpYXQiOjE3MTMyOTczMzEsImp0aSI6Ijc2ZWI4ZTE5ZjM4YjQ4NmZiODdmNzNjNTdkMWVmNDJhIiwidXNlcl9pZCI6MjQ2fQ.5zekMa7CUj9p-MvNHns5ke4ZPhYV3Y1CLOsYL7hDUUo

Response Details

Response

{
    "worked": true,
    "amount": 15.4,
    "amount_blocked": 0.0,
    "amount_schedule": 0.0,
    "last_update": "2024-04-11T13:46:00.447",
    "account_branch": "0001",
    "account_number": "401050"
}

Field	Description
worked	Returns true or false, confirming whether the query was successfully returned or not
amount	This field returns the available balance in the bank account.
amount_blocked	This field returns the blocked balance in the bank account.
amount_schedule	This field returns the value/balance of scheduled transfers and/or payments in the bank account.
last_update	This field returns the last update (Data/Time) regarding the balances in the bank account.
account_branch	Returns the information of the consulted originating branch (The same information sent in the body).
account_number	Returns the information of the consulted originating account (The same information sent in the body).