AI-ready version:

Retrieve Application Balance

Description

This API allows you to retrieve the application balance using a specific app_token.

Endpoint

GET https://impact.dots.eco/api/v1/application-balance/{app_token}

Refer to Headers and Authorization for required headers and authorization details.

Parameters

URL Path Parameter

Name	Required	Type	Description
`app_token`	Yes	`string`	The unique token representing your application.

Headers

Name	Required	Type	Description
`Content-Type`	Yes	`string`	Must be `application/json`.
`auth-token`	Yes	`string`	The authorization token for API requests.

Example Request

Minimal Example

curl --location --request GET 'https://impact.dots.eco/api/v1/application-balance/APP_TOKEN' \
--header 'Content-Type: application/json' \
--header 'auth-token: YOUR_AUTH_TOKEN'

Responses

Successful Response

A successful request returns the balance associated with the provided app_token.

Response Body

{
    "balance": 15
}

Response Fields

Field	Type	Description
`balance`	`number`	The balance associated with the application.

HTTP Status Codes

Code	Description
200	Request completed successfully.

Errors

404 Not Found

Indicates that the app_token is invalid.

Possible Error Message

Message	Cause
`"The app_token is invalid."`	Provided token is invalid.

Example Error Response

{
    "message": "The app_token is invalid."
}

HTTP Status Codes

Code	Description
404	The provided app_token is invalid.

403 Forbidden

Indicates that the associated company is not activated for production requests. Contact your account manager at Dots.eco for assistance.

Possible Error Message

Message	Cause
`"Your company is not yet activated for production requests. Please contact your account manager at Dots.eco..."`	Company is not activated for production requests.

Example Error Response

{
    "message": "Your company is not yet activated for production requests. Please contact your account manager at Dots.eco to activate it."
}

HTTP Status Codes

Code	Description
403	The company is not activated for production requests.

Notes

Ensure your company is activated for production-level requests before using this API.
A valid auth-token is required for successful authentication.

For more details on authentication and required headers, refer to Headers and Authorization.