Перейти к содержимому

API Запроса Баланса

API запроса баланса используется для получения информации о текущем балансе аккаунта eKYCPro и доступной квоте обнаружения в реальном времени.

Конечная точка API

GET https://api.ekycpro.com/v1/balance

Метод запроса

Заголовки запроса

ПараметрОбязательныйОписание
X-API-KeyДаВаш ключ API

Примеры ответов

Успешный ответ

{
"status": "OK",
"balance": 1000.50,
"credit": 5000,
"used_today": 250.50,
"daily_limit": 10000,
"reset_time": "2026-03-20T00:00:00Z"
}

Описание полей

ПолеТипОписание
statusstringСтатус ответа, OK означает успех
balancenumberТекущий баланс аккаунта (USD)
creditnumberДоступный кредит
used_todaynumberИспользованная сегодня квота
daily_limitnumberДневной лимит
reset_timestringВремя сброса квоты

Коды статуса

КодОписание
200Запрос выполнен успешно
401Ошибка аутентификации, неверный ключ API
429Слишком частые запросы
500Ошибка сервера, повторите попытку позже

Примеры кода

cURL

Окно терминала
curl --location 'https://api.ekycpro.com/v1/balance' \
--header 'X-API-Key: YOUR_API_KEY'

Python

import requests
api_key = 'YOUR_API_KEY'
response = requests.get(
'https://api.ekycpro.com/v1/balance',
headers={'X-API-Key': api_key}
)
print(response.json())

JavaScript

const apiKey = 'YOUR_API_KEY';
fetch('https://api.ekycpro.com/v1/balance', {
headers: {
'X-API-Key': apiKey
}
})
.then(response => response.json())
.then(data => console.log(data))
.catch(error => console.error(error));