Skip to main content
GET
/
v1
/
merchants
/
{merchantId}
/
balance
Get banking balance for a specific merchant
curl --request GET \
  --url https://api-sandbox.rinne.com.br/core/v1/merchants/{merchantId}/balance \
  --header 'x-api-key: <api-key>'
{
  "company_id": "507f1f77bcf86cd799439011",
  "provider": "CELCOIN",
  "balance": 100000,
  "blocked_balance": 5000,
  "total_balance": 105000,
  "currency": "BRL"
}

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

Response

Balance retrieved successfully

Banking balance response

​
company_id
string<uuid>
required

Company ID

Example:

"507f1f77bcf86cd799439011"

​
provider
enum<string>
required

Banking provider name

Available options:
CELCOIN,
RINNE
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"