Документация CashCom TopUp PayCenter API

API для пополнения абонентских счетов провайдеров и продажи цифровых товаров в системе PayCenter

Версия: 2.1
Последнее обновление: 17 января 2024 года

Быстрый старт

API‑точка

https://API_URL/joinCashcom/api/cashcom_v2_1

Авторизуйтесь в вашем аккаунте и получите секретный токен.
Все запросы отправляются методом POST в формате JSON и должны содержать HTTP‑заголовки:

Генерация подписи

# пример на Python
srcSign = secretToken + request + pointId + API_PUBLIC_TOKEN
sign = hashlib.sha512(srcSign.encode('utf-8')).hexdigest()

# пример на PHP
$srcSign = $secretToken.$request.$pointId.$API_PUBLIC_TOKEN;
$sign = hash('sha512', $srcSign);

// пример на Java
String srcSign = secretToken + request + pointId + API_PUBLIC_TOKEN;
MessageDigest md = MessageDigest.getInstance("SHA-512");
md.reset();
byte[] buf = srcSign.getBytes();
md.update(buf, 0, buf.length);
buf = md.digest();
StringBuilder builder = new StringBuilder();
for (byte b : buf) {
    builder.append(String.format("%02x", b));
}
String signature = builder.toString();

Подпись вычисляется так:

srcSign = secretToken + request + pointId + API_PUBLIC_TOKEN

Далее строка srcSign хешируется алгоритмом SHA‑512.

Ping

curl -i -X POST https://API_URL/joinCashcom/api/cashcom_v2_1/ping   -H 'CashCom-PointId: <YOUR_POINTID_HERE>'   -H 'CashCom-Authorization-Type: Token'   -H 'CashCom-Signature: <YOUR_SIGNATURE_HERE>'   -H 'Content-Type: application/json'   -d '{}'

Запрос не выполняет бизнес‑операций и служит только для проверки доступности сервера CashCom и корректности авторизации.
URL: https://API_URL/joinCashcom/api/cashcom_v2_1/ping

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

{
  "code": 0,
  "comment": "27.01.2024 14:55:16 EET ver. 2.1"
}

Получить прайс-лист

curl -i -X POST https://API_URL/joinCashcom/api/cashcom_v2_1/getprice   -H 'CashCom-PointId: <YOUR_POINTID_HERE>'   -H 'CashCom-Authorization-Type: Token'   -H 'CashCom-Signature: <YOUR_SIGNATURE_HERE>'   -H 'Content-Type: application/json'   -d '{ "countryCode": "VN" }'

Возвращает список продуктов и их параметры.
URL: https://API_URL/joinCashcom/api/cashcom_v2_1/getprice

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

{
  "code": 0,
  "comment": "ok",
  "products": [
    {
      "productPriceType": "FIXED",
      "countryCodes": ["VN"],
      "productCode": "13",
      "categoryId": 1,
      "providerName": "Gmobile Vietnam",
      "name": "500000 VND",
      "currency": "USD",
      "price": 2778,
      "fields": [
        {
          "name": "Account",
          "code": "account",
          "type": 1,
          "regex_inputing": ".*",
          "regex_complite": "\d{5,12}",
          "direction": "Введите номер телефона без кода страны",
          "display": true,
          "confirm": false
        }
      ]
    }
    // ... другие продукты
  ]
}

Параметры запроса

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

Проверить заказ

curl -i -X POST https://API_URL/joinCashcom/api/cashcom_v2_1/validate   -H 'CashCom-PointId: <YOUR_POINTID_HERE>'   -H 'CashCom-Authorization-Type: Token'   -H 'CashCom-Signature: <YOUR_SIGNATURE_HERE>'   -H 'Content-Type: application/json'   -d '{
    "orders": [{
      "id": "125358",
      "date": 1706409044132,
      "productCode": "201",
      "amount": 100,
      "currency": "USD",
      "attr": {
        "account": "209407828"
      }
    }]
  }'

Запрос проверки заказа выполняется перед покупкой для проверки доступности продукта и корректности параметров.
URL: https://API_URL/joinCashcom/api/cashcom_v2_1/validate

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

{
  "code": 0,
  "comment": "ok",
  "validateResults": [
    {
      "id": "125358",
      "code": 0,
      "needNextStep": false,
      "comment": "Successfully"  
    }
  ]
}

Параметры запроса

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

Совершить покупку

curl -i -X POST https://API_URL/joinCashcom/api/cashcom_v2_1/purchase   -H 'CashCom-PointId: <YOUR_POINTID_HERE>'   -H 'CashCom-Authorization-Type: Token'   -H 'CashCom-Signature: <YOUR_SIGNATURE_HERE>'   -H 'Content-Type: application/json'   -d '{
    "orders": [{
      "id": "125357",
      "date": 1706361413172,
      "productCode": "1269.3885",
      "currency": "USD",
      "attr": {
        "account": "377384504"
      }
    }]
  }'

Запрос purchase отправляет заказы и возвращает их статус.
URL: https://API_URL/joinCashcom/api/cashcom_v2_1/purchase

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

{
  "code": 0,
  "comment": "ok",
  "statuses": [
    {
      "id": "125357",
      "status": 1,
      "isfinal": false,
      "comment": "Processing"
    }
  ]
}

Параметры запроса

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

Получить статус

curl -i -X POST https://API_URL/joinCashcom/api/cashcom_v2_1/getstatus   -H 'CashCom-PointId: <YOUR_POINTID_HERE>'   -H 'CashCom-Authorization-Type: Token'   -H 'CashCom-Signature: <YOUR_SIGNATURE_HERE>'   -H 'Content-Type: application/json'   -d '{ "statuses": [{ "id": "125357" }] }'

Запрос getstatus получает текущие статусы заказов.
URL: https://API_URL/joinCashcom/api/cashcom_v2_1/getstatus

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

{
  "code": 0,
  "comment": "ok",
  "statuses": [
    {
      "id": "125357",
      "status": 100,
      "isfinal": true,
      "comment": "Success"
    }
  ]
}

Параметры запроса

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

Коды возврата

Коды возврата определяют результат обработки запроса.

Внимание! Эти коды описывают только результат запроса, статус заказа см. в Статусы заказа.

Статусы заказа

Коды статусов заказа определяют текущее состояние заказа.

Коды валидации

Коды валидации определяют результат проверки заказа с помощью запроса validate.

Зарезервированные атрибуты

Ниже список зарезервированных атрибутов, передаваемых в поле attr ответа.