Herald
OpenapiExt

Get_balance_ext

GET
/api/ext/points/{realmId}/balance

Authorization

api_key
X-API-Key<token>

Client-app API key (third-party external API).

In: header

Path Parameters

realmId*string

Realm ID

Query Parameters

userId?string

User ID (optional)

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/api/ext/points/string/balance"
{  "balance": 0,  "currency": "string",  "expiresAt": "string",  "freePeriodicBalance": 0,  "grantedBalance": 0,  "registrationBalance": 0,  "subscriptionBalance": 0,  "topupBalance": 0,  "totalConsumed": 0,  "totalPaidGranted": 0,  "totalRecharged": 0,  "unit": "string",  "updatedAt": "string",  "userId": "string"}
{  "code": "string",  "details": null,  "message": "string",  "requestId": "string",  "status": 0}
{  "code": "string",  "details": null,  "message": "string",  "requestId": "string",  "status": 0}
{  "code": "string",  "details": null,  "message": "string",  "requestId": "string",  "status": 0}
{  "code": "string",  "details": null,  "message": "string",  "requestId": "string",  "status": 0}
{  "code": "string",  "details": null,  "message": "string",  "requestId": "string",  "status": 0}