GET /v3/account — Retrieve Account and Credit Balance

Use GET /v3/account to retrieve safe account information for the API key you are using. This endpoint is useful for internal dashboards, credit monitoring, and alerts before sending OTP traffic. The response never includes credentials such as your API key, password, webhook secret, or internal database IDs.

Endpoint

GET https://api.otp.id/v3/account

Request headers

Header	Value	Required
`Authorization`	`Bearer <api_key>`	✅ Yes

Response fields

string

Your public merchant ID.

string

The account owner or merchant name.

string

The brand name configured for OTP messages.

string

The brand email configured on the merchant account.

string

The login/contact email for the merchant account.

integer

Your remaining OTP.ID credits.

Example

curl https://api.otp.id/v3/account \
  -H "Authorization: Bearer YOUR_API_KEY"

const response = await fetch('https://api.otp.id/v3/account', {
  headers: {
    Authorization: `Bearer ${process.env.OTPID_API_KEY}`
  }
});

const result = await response.json();
console.log(result.data.saldo);

Success response:

{
  "success": true,
  "data": {
    "merchant_id": "MC20260807ABCD",
    "name": "Dewa",
    "brand_name": "MyApp",
    "brand_email": "support@myapp.example",
    "email": "owner@myapp.example",
    "saldo": 250000
  },
  "error": null
}

Errors

HTTP Status	Error Code	Description
401	`UNAUTHORIZED`	The `Authorization` header is missing or the API key is invalid.
429	`RATE_LIMITED`	You exceeded the global API-key rate limit.
500	`INTERNAL_ERROR`	An unexpected server-side error occurred.

Account & Billing

OTP

Webhooks

GET /v3/account — Retrieve Account and Credit Balance

Endpoint

Request headers

Response fields

Example

Errors

​Endpoint

​Request headers

​Response fields

​Example

​Errors

Endpoint

Request headers

Response fields

Example

Errors