Merchant's Account Balance

This endpoint retrieves the balance amount of an specific Account or Sub Account when using Beta's Payments Product.

Retrieve the balance of an specific asset for a specific account or subaccount

GET https://live.betaapp.com/v1/balance

Query Parameters

Name	Type	Description
asset*	String	Fiat Asset used on your settlement preference.

Headers

Name	Type	Description
Authorization*	String	Bearer {access_token}
x-sub-account-id	String	ID of your subaccount, If you have one.
accept*	String	application/json

200: OK Sucess

{
  "message": "string",
  "number_of_orders_associated": 0,
  "total_asset": "string",
  "total_amount": 0,
  "total_fees": 0
}

400: Bad Request Error message

{
  "message": "string"
}

Request Example:

curl -X 'GET' \
  'https://live.betaapp.com/v1/balance?asset=BRL' \
  -H 'accept: application/json' \
  -H 'X-sub-account-id: 22376b76...3543083b' \
  -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6InJlaEF1NURPY...ctfx2I4g'

Response Example:

{
  "total_amount": 18500,
  "total_fees": 185,
  "number_of_orders_associated": 22
}

The total_fees parameter represents the amount in fees that will be discounted during the settlement process.

The number_of_orders_associated parameter represents how many orders compose the total_amount.

Settlements

Merchants are required to request settlements through the Dashboard. It could be requested automatically based on your initial settings setup, or it could be requested manually when you follow these steps:

1. Click on the three dots on the right side of your balance amount

You will be redirected to the Settlement History page, where you can see an overview of the amount ready for settlement.

1. Click on More Info located on the top-right side of the Settlement Overview

Settlement Menu on Dashboard

1. Request your Settlement

Request Settlement