API Documentation

Аутентификация и формат запросов

Общие требования

Все запросы к API требуют аутентификации через подпись запроса для обеспечения безопасной передачи данных.

Структура запроса

Все запросы отправляются методом POST. Тело запроса содержит:

data: JSON-объект, закодированный в base64
signature: Подпись (SHA256(SECRET_KEY + data)), закодированная в base64

Получение баланса (USDT)

Баланс отображается исключительно в валюте USDT

URL: https://api.crypto-cash.world/merchant/api/v1/balance/retrieve/

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

publicKey: Публичный ключ мерчанта

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

{
  "code": 200,
  "data": {
    "item": {
      "accountAmount": "15.000",
      "companyAmount": "20.000"
    }
  }
}

Покупка криптовалюты (Вывод криптовалюты)

Вывод осуществляется в любой криптовалюте, конвертация через USDT

URL: https://api.crypto-cash.world/merchant/api/v1/balance/actions/buy/crypto/

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

publicKey: Публичный ключ мерчанта
address: Номер счета
memo (опционально): Дополнительная информация
amount: Сумма покупки в выбранной валюте
currency: Валюта. Необязательный параметр если передан ticker
network: Подсеть. Необязательный параметр если передан ticker
ticker: Тикер. Необязательный параметр если передан currency и network.
externalId: Внешний ID

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

{
  "code": 200,
  "data": {
    "item": {
      "id": "195",
      "externalId": "195"
    }
  }
}

Продажа криптовалюты (Пополнение криптовалюты)

Пополнение осуществляется в любой криптовалюте, конвертация через USDT

URL: https://api.crypto-cash.world/merchant/api/v1/balance/actions/sale/

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

publicKey: Публичный ключ мерчанта
amount: Сумма продажи
currency: Валюта. Необязательный параметр если передан ticker
network: Подсеть. Необязательный параметр если передан ticker
ticker: Тикер. Необязательный параметр если передан currency и network.
externalId: Внешний ID

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

{
    "code": 200,
    "data": {
        "item": {
            "id": "1d09037e-9184-4bb0-a0f1-f149b19797c1",
            "address": "TAkCux1RVumZJoG4v61wMRk9nacBH84aoo",
            "memo": "",
            "externalId": "t1ckac-kc9dcc-as2ockd-cnzywidj"
        }
    }
}

Запрос на получения списка транзакций

URL: https://api.crypto-cash.world/merchant/api/v1/balance/payments/list/

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

publicKey: Публичный ключ мерчанта
page: Получение определённой страницы. Необязательный параметр. По умолчанию 1.
pageSize: Количество объектов на одну страницу. Необязательный параметр. По умолчанию 100.
dateAfter: Фильтр по дате. После указанной даты. Необязательный параметр.
dateBefore: Фильтр по дате. До указанной даты. Необязательный параметр.
transactionType: Фильтр по типу (Возможные значения: buy | sale). Необязательный параметр.

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

{
    "code": 200,
    "data": {
        "items": [
            {
                "id": "72887555-8724-4df4-bf00-bc31d3ab0f80",
                "pair": "USDT/USDT",
                "network": "TRC20",
                "hash": "",
                "amount": "",
                "commission": "",
                "address": "TNrGFAjudfCAicw9csa8Tq051yVLoPqhFY284",
                "externalId": "r_1",
                "transactionType": "Sale",
                "createdAt": "2025-07-12T01:46:11.227000+00:00",
                "updatedAt": "2025-07-12T01:46:11.227000+00:00",
                "status": "New"
            },
            {
                "id": "d53d9306-b21b-4ee2-b2a0-c86007591d45",
                "pair": "NEAR/USDT",
                "network": "NEAR",
                "hash": "",
                "amount": "",
                "commission": "",
                "address": "cslcdoc65f06741b8907scl17f3beef7314460a8a5aa760bbc93168325c410",
                "externalId": "92ee6d39-af41-4b90-b9fd-beb27353ae76",
                "transactionType": "Sale",
                "createdAt": "2025-06-16T16:40:33.632000+00:00",
                "updatedAt": "2025-06-16T16:40:33.632000+00:00",
                "status": "Waiting"
            },
            {
                "id": "d6c82c21-d78b-401e-aee1-5abb954910e6",
                "pair": "USDT/NEAR",
                "hash": "ZKZKxHDbpoqwkMow15wNDscXgtexNvfpl7GUespPYKni3h12svspCrQ",
                "amount": "2.152",
                "commission": "0",
                "externalId": "NEAR_WITHDRAWAL_101",
                "transactionType": "Buy",
                "createdAt": "2025-06-20T00:21:51.306000+00:00",
                "updatedAt": "2025-06-20T00:22:59.267000+00:00",
                "status": "Paid"
            }
        ],
        "pagination": {
            "page": 1,
            "total": 1,
            "pageSize": 7
        }
    }
}

Запрос на получения конкретной транзакции

URL: https://api.crypto-cash.world/merchant/api/v1/balance/payments/retrieve/

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

publicKey: Публичный ключ мерчанта
externalId: Внешний ID. Необязательный параметр если передается internalId
internalId: Внутренний ID. Необязательный параметр если передается externalId

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

{
    "code": 200,
    "data": {
        "item": {
            "id": "a18bf380-c4db-4cea-95d2-0439923ccb1b",
            "pair": "NEAR/USDT",
            "network": "NEAR",
            "hash": "E8kcashhGkhLuzWQ5kTYAM3a6sN2bwrsiAkjQaEbqosSuq9",
            "amount": "1",
            "commission": "0",
            "address": "c9asd7502269a88cakce4416ccm9s96edc86ca8sa483fd395538af64ado",
            "externalId": "92ee6d39-af41-4b90-b9fd-beb27353ae78",
            "transactionType": "Sale",
            "createdAt": "2025-06-19T22:09:44.284000+00:00",
            "updatedAt": "2025-06-19T22:43:28.753000+00:00",
            "status": "Paid"
        }
    }
}

Запрос на возврат средств

URL: https://api.crypto-cash.world/merchant/api/v1/balance/actions/refund/

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

publicKey: Публичный ключ мерчанта
externalId: Внешний ID. Необязательный параметр если передается internalId
internalId: Внутренний ID. Необязательный параметр если передается externalId
address: Кошелек на который будет произведен возврат. (В той же сети и валюте)

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

{
      "code": 200,
      "data": {
        "item": {
           "id": "string",
           "transactionId": "string",
           "address": "string"
        }
      }
}

Внешняя ссылка для получения курсов

URL: https://crypto-cash.world/market/rates/export/xml/

URL: https://crypto-cash.world/market/rates/export/json/

Справочная информация

Список криптовалют

URL: https://api.crypto-cash.world/merchant/api/v1/crypto-currencies/list/

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

publicKey: Публичный ключ мерчанта

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

{
  "code": 200,
  "data": {
    "items": [
      {
        "currency": "BTC",
        "networks": [
          "BITCOIN"
        ],
        "tickers": [
          "BTC"
        ]
      },
      {
        "currency": "ETH",
        "networks": [
          "ZKSYNC",
          "BASE",
          "ARBITRUM",
          "OPTIMISM",
          "LINEA",
          "ERC20"
        ],
        "tickers": [
          "ETHOPTM",
          "ETHARBTM",
          "ETHZKSYNC",
          "ETHLINEA",
          "ETHBASE",
          "ETH"
        ]
      },
      {
        "currency": "USDT",
        "networks": [
          "NEWTON",
          "AVALANCHE",
          "POLYGON",
          "BINANCESMARTCHAIN",
          "TRC20",
          "ARBITRUM",
          "SOLANA",
          "ERC20"
        ],
        "tickers": [
          "USDTPOLYGON",
          "USDTSOL",
          "USDTARBTM",
          "USDTERC20",
          "USDTBEP20",
          "USDTTRC20",
          "USDTTON",
          "USDTAVAXC"
        ]
      }
}

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

New
Waiting
Paid
Not paid
Underpaid
Overpaid
Canceled
AML Frozen
AML KYC

Ошибки

При возникновении ошибок в ответ будет возвращен список из кодов ошибок.

Пример ответа с ошибкой:

{
  "errors": [1000]
}

Список ошибок:

1000 - Неверный запрос
2010 - Ошибка декодирования данных
2011 - Ошибка декодирования подписи
2020 - Неверная подпись
3000 - Компания не найдена
3001 - Заказ не найден
3002 - Транзакция не найдена

Вебхуки

Сервис предоставляет возможность настроить вебхуки, чтобы получать уведомления о событиях, связанных с изменением статуса заказа. Для настройки вебхука необходимо в настройках аккаунта указать URL, на который будут отправляться данные.

Формат вебхука:

data: Поле содержит объект JSON с информацией о заказе, закодированный в строку base64.
signature: Подпись запроса, созданная на основе приватного ключа и данных (SECRET_KEY + data). Подпись кодируется в SHA256 и затем в base64.

Fiat On-Ramp iFrame API Fiat List