Balance

This route can be used to find out your current account balance.

GETv1/balance

Response Object

When GET your balance, this is the payload returned to your application. In case, you haven't made any Cash-In transactions yet, the returned value will be 0.

Attribute	Type	Description
balance_amount	int32 || float	The amount in reais available in your account to make withdrawals (Cash-Out).
balance_transactions	int32	The number of operations carried out on your account, responsible for changing the available balance.
cash_in_amount	int32 || float	The value in reais of all Cash-In operations carried out on your account.
cash_in_transactions	int32	The number of Cash-In transactions carried out on your account.
cash_out_amount	int32 || float	The value in reais of all Cash-Out operations carried out on your account.
cash_out_transactions	int32	The number of Cash-Out transactions performed on your account.

Samples

Current balance

Request

curl -X GET -G "https://api.bet.marlim.co/v1/balance" \
-H "Content-Type: application/json" \
-H "api_key: api_key_value" \

Response200

{
  "balance_amount": 800,
  "balance_transactions": 12,
  "cash_in_amount": 1000,
  "cash_in_transactions": 10,
  "cash_out_amount": 200,
  "cash_out_transactions": 2
}