Skip to main content

Get balance

In order to get the balance of a business entity, you need to send a POST request to the following endpoint:

POST https://www.mimbla.com/api/v1/merchant/balance

The request body can have the following parameters:

ParameterTypeDescriptionRequiredDefault value
with_ratesstringInclude the current Mimbla rates of the cryptocurrencies in USD, EUR, and GBPNofalse
with_balancestringInclude the balance of the cryptocurrencies in the accountNofalse

Example Request

POST https://www.mimbla.com/api/v1/merchant/balance
Content-Type: application/json
MB-API-KEY: <YOUR_API_KEY>

Example Successful Response

If your request is successful, you will receive a response with the http status code 200 Ok and the following body:

{
"BTC": 0.01,
"BCH": 0.06410256,
"LTC": 0,
}

If you include the with_rates parameter in the request, you will receive the rates of the cryptocurrencies in USD, EUR, and GBP:

{
"BTC": {
"balance": 0.01,
"rates": {
"USD": 50000,
"EUR": 42000,
"GBP": 36000
}
},
"BCH": {
"balance": 0.06410256,
"rates": {
"USD": 500,
"EUR": 420,
"GBP": 360
}
},
"LTC": {
"balance": 0,
"rates": {
"USD": 0,
"EUR": 0,
"GBP": 0
}
}
}

If you include the with_balance parameter in the request, you will receive the balance of the cryptocurrencies with a value greater than 0:

{
"BTC": 0.01,
"BCH": 0.06410256,
}

Example Error Response

If your request is unsuccessful, you will receive a response with the http status code 401 Unauthorized and the following body:

{
"error": "Unauthorized"
}