Skip to main content
GET
/
v1
/
holder
/
{holderId}
/
organization
/
{organizationId}
/
balance
cURL
curl --request GET \
  --url https://search.tratum.com.br/v1/holder/{holderId}/organization/{organizationId}/balance \
  --header 'Authorization: Bearer <token>'
{
  "sucess": true,
  "reason": "<string>",
  "total": 123,
  "balance": [
    {
      "balance": {
        "available": 123,
        "consume": 123,
        "plan": {
          "limitIni": 123,
          "hasMindMap": true,
          "planName": "<string>",
          "limitEnd": 123,
          "isVisible": true,
          "limitQtdDocument": 123,
          "typePlan": "<string>",
          "createdAt": "2023-11-07T05:31:56Z",
          "planId": 123,
          "typeOrganization": "<string>",
          "hasCertification": true,
          "typePlanCash": "<string>",
          "updatedAt": "2023-11-07T05:31:56Z"
        }
      }
    }
  ]
}

Documentation Index

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

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

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
holderId
integer<int64>
required

ID do parceiro

​
organizationId
integer<int64>
required

ID da organização

Response

Consulta de saldo e plano atual

​
sucess
boolean

Indica se a operação foi bem-sucedida

​
reason
string

Razão de falha, se aplicável

​
total
integer

Total de registros

​
balance
object[]