Skip to main content
GET
Get banking balance for a specific merchant

Authorizations

x-api-key
string
header
required

Company API key for authentication

Path Parameters

merchantId
string
required

The merchant ID

Query Parameters

provider
enum<string>

Banking provider name (accepts lowercase and uppercase, returns uppercase, defaults to CELCOIN)

Available options:
CELCOIN,
RINNE,
CAPPTA

Response

Balance retrieved successfully

Banking balance response

company_id
string<uuid>
required

Company ID

Example:

"123e4567-e89b-12d3-a456-426614174000"

provider
enum<string>
required

Banking provider name

Available options:
CELCOIN,
RINNE,
CAPPTA
Example:

"CELCOIN"

balance
integer
required

Available balance in cents

Example:

100000

blocked_balance
integer
required

Blocked balance in cents

Example:

5000

total_balance
integer
required

Total balance in cents

Example:

105000

currency
enum<string>
required

Currency code

Available options:
BRL
Example:

"BRL"