Функции для работы с финансами

Модуль: finance

Статистика

Показать баланс

Получение баланса лицевого счёта (в копейках). Отображает средства доступные для заказа или продления услуг, а также заблокированные предоставленными услугами.

Функция: show_balance

Пример GET запроса:

https://api.codeblast.ru/finance/show_balance?token_data=data:string

Пример XML ответа:

<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<response>
    <balance_available>205000</balance_available>
    <balance_locked>13050</balance_locked>
    <error_code>OK</error_code>
    <error_text>ошибок нет</error_text>
</response>

Пример JSON ответа:

{
  "balance_available": "205000",
  "balance_locked": "13050",
  "error_code": "OK",
  "error_text": "ошибок нет"
}

Поля запроса:

Поле Тип Описание
token_data string токен

Поля ответа:

Поле Тип Описание
balance_available number средства доступные для заказа или продления услуг
balance_locked number средства заблокированные предоставленными услугами
error_code string код ошибки
error_text string расшифровка

Коды ошибок:

Код ошибки Расшифровка
REG_TOKEN_DATA ошибка ввода токена
"[a-z0-9\-]{36}"
AUTHORIZATION_FAIL ошибка авторизации
MAINTENANCE режим обслуживания
ERROR ошибка системы
OK ошибок нет

Показать зачисление денежных средств

С помощью данной функции можно получить информацию по зачислению денежных средств на счёт договора. Денежные средства зачисляются после оплаты выставленных счётов. Для получения списка id зачислений денежных средств необходимо воспользоваться функцией list_incoming_id.

Функция: show_incoming

Пример GET запроса:

https://api.codeblast.ru/finance/show_incoming?token_data=data:string
                                              &incoming_id=425

Пример XML ответа:

<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<response>
    <incoming_amount>13050</incoming_amount>
    <incoming_reason>Оплата банковской картой</incoming_reason>
    <incoming_datetime>2014-10-22 18:30:12</incoming_datetime>
    <error_code>OK</error_code>
    <error_text>ошибок нет</error_text>
</response>

Пример JSON ответа:

{
  "incoming_amount ": "13050",
  "incoming_datetime": "2014-10-22 18:30:12",
  "incoming_description": "Услуга ...",
  "error_code": "OK",
  "error_text": "ошибок нет"
}

Поля запроса:

Поле Тип Описание
token_data string токен
incoming_id number id зачисления денежных средств

Поля ответа:

Поле Тип Описание
incoming_amount number сумма зачисленная на счёта договора
incoming_reason string основание для зачисления
incoming_datetime datetime дата и время зачисления
error_code string код ошибки
error_text string расшифровка

Коды ошибок:

Код ошибки Расшифровка
REG_TOKEN_DATA ошибка ввода токена
"[a-z0-9\-]{36}"
REG_INCOMING_ID ошибка ввода id зачисления денежных средств
"[0-9]{1,20}"
AUTHORIZATION_FAIL ошибка авторизации
INCOMING_NOT_EXISTS зачисления не существует
MAINTENANCE режим обслуживания
ERROR ошибка системы
OK ошибок нет

Перечислить id зачислений денежных средств

С помощью данной функции можно получить список id зачислений денежных средств.

Функция: list_incoming_id

Пример GET запроса:

https://api.codeblast.ru/finance/list_incoming_id?token_data=data:string

Пример XML ответа:

<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<response>
    <list_incoming_id>
        <incoming_id>425</incoming_id>
        <incoming_id>782</incoming_id>
    </list_incoming_id>
    <error_code>OK</error_code>
    <error_text>ошибок нет</error_text>
</response>

Пример JSON ответа:

{
  "list_incoming_id": [
    "425",
    "782"
  ],
  "error_code": "OK",
  "error_text": "ошибок нет"
}

Поля запроса:

Поле Тип Описание
token_data string токен

Поля ответа:

Поле Тип Описание
incoming_id number id зачисления денежных средств
error_code string код ошибки
error_text string расшифровка

Коды ошибок:

Код ошибки Расшифровка
REG_TOKEN_DATA ошибка ввода токена
"[a-z0-9\-]{36}"
AUTHORIZATION_FAIL ошибка авторизации
MAINTENANCE режим обслуживания
ERROR ошибка системы
OK ошибок нет

Показать списание денежных средств

С помощью данной функции можно получить информацию по списанию денежных средств со счёта договора. Денежные средства списываются со счёта при окончании или прерывании предоставления услуги.

Функция: show_outgoing

Пример GET запроса:

https://api.codeblast.ru/finance/show_outgoing?token_data=data:string
                                              &outgoing_id=425

Пример XML ответа:

<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<response>
    <outgoing_amount>13050</outgoing_amount>
    <outgoing_reason>Услуга ...</outgoing_reason>
    <outgoing_datetime>2014-10-22 18:30:12</outgoing_datetime>
    <error_code>OK</error_code>
    <error_text>ошибок нет</error_text>
</response>

Пример JSON ответа:

{
  "outgoing_amount ": "13050",
  "outgoing_reason": "Услуга ...",
  "outgoing_datetime": "2014-10-22 18:30:12",
  "error_code": "OK",
  "error_text": "ошибок нет"
}

Поля запроса:

Поле Тип Описание
token_data string токен
outgoing_id number id списания денежных средств

Поля ответа:

Поле Тип Описание
outgoing_amount number сумма списанная со счёта договора
outgoing_reason string основание для списания
outgoing_datetime datetime дата и время списания
error_code string код ошибки
error_text string расшифровка

Коды ошибок:

Код ошибки Расшифровка
REG_TOKEN_DATA ошибка ввода токена
"[a-z0-9\-]{36}"
REG_OUTGOING_ID ошибка ввода id списания денежных средств
"[0-9]{1,20}"
AUTHORIZATION_FAIL ошибка авторизации
OUTGOING_NOT_EXISTS списания не существует
MAINTENANCE режим обслуживания
ERROR ошибка системы
OK ошибок нет

Перечислить id списаний денежных средств

С помощью данной функции можно получить список id списаний денежных средств.

Функция: list_outgoing_id

Пример GET запроса:

https://api.codeblast.ru/finance/list_outgoing_id?token_data=data:string
                                                 &outgoing_zero_amount=true

Пример XML ответа:

<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<response>
    <list_outgoing_id>
        <outgoing_id>425</outgoing_id>
        <outgoing_id>782</outgoing_id>
    </list_outgoing_id>
    <error_code>OK</error_code>
    <error_text>ошибок нет</error_text>
</response>

Пример JSON ответа:

{
  "list_outgoing_id": [
    "425",
    "782"
  ],
  "error_code": "OK",
  "error_text": "ошибок нет"
}

Поля запроса:

Поле Тип Описание
token_data string токен
outgoing_zero_amount boolean отображать нулевые списания «true, false»

Поля ответа:

Поле Тип Описание
outgoing_id number id списания денежных средств
error_code string код ошибки
error_text string расшифровка

Коды ошибок:

Код ошибки Расшифровка
REG_TOKEN_DATA ошибка ввода токена
"[a-z0-9\-]{36}"
REG_OUTGOING_ZERO_AMOUNT ошибка ввода отображения нулевых списаний
"(true|false)"
AUTHORIZATION_FAIL ошибка авторизации
MAINTENANCE режим обслуживания
ERROR ошибка системы
OK ошибок нет

Платежи

Создать платёж

Функция позволяет получить идентификатор платежа, который используется в шлюзах оплаты. Сумма указывается в копейках.

Функция: create_payment

Пример GET запроса:

https://api.codeblast.ru/finance/create_payment?token_data=data:string
                                               &payment_amount=25000

Пример XML ответа:

<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<response>
    <payment_id>451</payment_id>
    <error_code>OK</error_code>
    <error_text>ошибок нет</error_text>
</response>

Пример JSON ответа:

{
  "payment_id": "451",
  "error_code": "OK",
  "error_text": "ошибок нет"
}

Поля запроса:

Поле Тип Описание
token_data string токен
payment_amount number сумма платежа

Поля ответа:

Поле Тип Описание
payment_id number id платежа
error_code string код ошибки
error_text string расшифровка

Коды ошибок:

Код ошибки Расшифровка
REG_TOKEN_DATA ошибка ввода токена
"[a-z0-9\-]{36}"
RNG_PAYMENT_AMOUNT ошибка ввода платежа
"[5000, 1500000]"
AUTHORIZATION_FAIL ошибка авторизации
MAINTENANCE режим обслуживания
ERROR ошибка системы
OK ошибок нет

Показать платёж

Функция отображает платежи, как успешные, так и отклонённые.

Функция: show_payment

Пример GET запроса:

https://api.codeblast.ru/finance/show_payment?token_data=data:string
                                             &payment_id=263

Пример XML ответа:

<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<response>
    <payment_id>782</payment_id>
    <payment_amount>25000</payment_amount>
    <payment_success>true</payment_success>
    <payment_system>TINKOFF</payment_system>
    <payment_datetime>2015-10-20 18:26:27</payment_datetime>
    <error_code>OK</error_code>
    <error_text>ошибок нет</error_text>
</response>

Пример JSON ответа:

{
  "payment_id": "782",
  "payment_amount": "25000",
  "payment_success": "true",
  "payment_system": "TINKOFF",
  "payment_datetime": "2015-10-20 18:26:27",
  "error_code": "OK",
  "error_text": "ошибок нет"
}

Поля запроса:

Поле Тип Описание
token_data string токен
payment_id number id платежа

Поля ответа:

Поле Тип Описание
payment_id number id платежа
payment_amount number сумма платежа в копейках
payment_success boolean платёжная операция успешно завершена «true, false»
payment_system string платёжная система
payment_datetime datetime дата и время платежа
error_code string код ошибки
error_text string расшифровка

Коды ошибок:

Код ошибки Расшифровка
REG_TOKEN_DATA ошибка ввода токена
"[a-z0-9\-]{36}"
REG_PAYMENT_ID ошибка ввода id платежа
"[0-9]{1,20}"
AUTHORIZATION_FAIL ошибка авторизации
PAYMENT_NOT_EXISTS платёж не существует
MAINTENANCE режим обслуживания
ERROR ошибка системы
OK ошибок нет

Перечислить id платежей

С помощью данной функции можно получить список id платежей.

Функция: list_payment_id

Пример GET запроса:

https://api.codeblast.ru/finance/list_payment_id?token_data=data:string

Пример XML ответа:

<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<response>
    <list_payment_id>
        <payment_id>425</payment_id>
        <payment_id>782</payment_id>
    </list_payment_id>
    <error_code>OK</error_code>
    <error_text>ошибок нет</error_text>
</response>

Пример JSON ответа:

{
  "list_payment_id": [
    "425",
    "782"
  ],
  "error_code": "OK",
  "error_text": "ошибок нет"
}

Поля запроса:

Поле Тип Описание
token_data string токен

Поля ответа:

Поле Тип Описание
payment_id number id платежа
error_code string код ошибки
error_text string расшифровка

Коды ошибок:

Код ошибки Расшифровка
REG_TOKEN_DATA ошибка ввода токена
"[a-z0-9\-]{36}"
AUTHORIZATION_FAIL ошибка авторизации
MAINTENANCE режим обслуживания
ERROR ошибка системы
OK ошибок нет

Акции и скидки

Запрос промокода

Позволяет запросить промокод для тестирования возможностей хостинга. Промокод можно запросить только один раз.

Функция: request_promo_code

Пример GET запроса:

https://api.codeblast.ru/finance/request_promo_code?token_data=data:string

Пример XML ответа:

<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<response>
    <promo_code>VBYIFASN0D</promo_code>
    <error_code>OK</error_code>
    <error_text>ошибок нет</error_text>
</response>

Пример JSON ответа:

{
  "promo_code": "VBYIFASN0D",
  "error_code": "OK",
  "error_text": "ошибок нет"
}

Поля запроса:

Поле Тип Описание
token_data string токен

Поля ответа:

Поле Тип Описание
promo_code string промокод
error_code string код ошибки
error_text string расшифровка

Коды ошибок:

Код ошибки Расшифровка
REG_TOKEN_DATA ошибка ввода токена
"[a-z0-9\-]{36}"
AUTHORIZATION_FAIL ошибка авторизации
PROMO_CODE_ALREADY_REQUESTED промокод может быть запрошен только один раз
SEND_EMAIL_FAIL ошибка отправки сообщения
MAINTENANCE режим обслуживания
ERROR ошибка системы
OK ошибок нет

Активация промокода

Позволяет активировать промокод. При активации сумма с промокода перечисляется на лицевой счёт клиента. Сумма в поле ответа указана в копейках.

Функция: activate_promo_code

Пример GET запроса:

https://api.codeblast.ru/finance/activate_promo_code?captcha_id=185
                                                    &captcha_text=M94JC
                                                    &token_data=data:string
                                                    &promo_code=VBYIFASN0D

Пример XML ответа:

<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<response>
    <promo_code_amount>50000</promo_code_amount>
    <error_code>OK</error_code>
    <error_text>ошибок нет</error_text>
</response>

Пример JSON ответа:

{
  "promo_code_amount": "50000",
  "error_code": "OK",
  "error_text": "ошибок нет"
}

Поля запроса:

Поле Тип Описание
captcha_id number id капчи
captcha_text string цифро-буквенный код капчи
token_data string токен
promo_code string промокод

Поля ответа:

Поле Тип Описание
promo_code_amount number сумма перечисленная на лицевой счёт клиента
error_code string код ошибки
error_text string расшифровка

Коды ошибок:

Код ошибки Расшифровка
REG_CAPTCHA_ID ошибка ввода id капчи
"[0-9]{1,20}"
REG_CAPTCHA_TEXT ошибка ввода цифро-буквенного кода капчи
"[a-zA-Z0-9]{5}"
REG_TOKEN_DATA ошибка ввода токена
"[a-z0-9\-]{36}"
REG_PROMO_CODE ошибка ввода промокода
"[A-Za-z0-9]{10,20}"
CHECK_CAPTCHA_FAIL ошибка проверки капчи
AUTHORIZATION_FAIL ошибка авторизации
PROMO_CODE_NOT_EXISTS промокод не существует
PROMO_CODE_ALREADY_ACTIVATED промокод уже активирован
MAINTENANCE режим обслуживания
ERROR ошибка системы
OK ошибок нет