Saldo

Está rota pode ser usada para saber o saldo atual da sua conta.

GETv1/balance

Response Object

Ao fazer o GET do seu saldo esse é o payload retornado para a sua aplicação. Caso, você não tenha feito nenhuma transação de Cash-In ainda, o valor retornado será 0.

Atributo	Tipo	Descrição
balance_amount	int32 || float	O valor em reais disponível na sua conta para realizar saques (Cash-Out).
balance_transactions	int32	A quantidade de operações realizadas na sua conta, responsáveis por alterar o saldo disponível.
cash_in_amount	int32 || float	O valor em reais de todas as operações de Cash-In realizados em sua conta.
cash_in_transactions	int32	A quantidade de operações de Cash-In realizados em sua conta.
cash_out_amount	int32 || float	O valor em reais de todas as operações de Cash-Out realizados em sua conta.
cash_out_transactions	int32	A quantidade de operações de Cash-Out realizados em sua conta.

Samples

Saldo atual

Request

curl -X GET -G "https://api.pix.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
}