Skip to main content
GET
/
v1
/
banking
/
balance
Get account balance for a company
curl --request GET \
  --url https://api-sandbox.rinne.com.br/core/v1/banking/balance \
  --header 'x-api-key: <api-key>'
{
  "company_id": "123e4567-e89b-12d3-a456-426614174000",
  "provider": "CELCOIN",
  "balance": 5300,
  "blocked_balance": 100,
  "total_balance": 5400,
  "currency": "BRL"
}

Documentation Index

Fetch the complete documentation index at: https://docs.rinne.com.br/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
x-api-key
string
header
required

Company API key for authentication

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

​
company_id
string<uuid>
Example:

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

​
provider
string
Example:

"CELCOIN"

​
balance
integer
Example:

5300

​
blocked_balance
integer
Example:

100

​
total_balance
integer
Example:

5400

​
currency
string
Example:

"BRL"