Авторизация и начало работы

Cryptoswap API использует ключи для авторизации запросов и индивидуальные URL для доступа к API. Для получения ключа и эндпойнта обратитесь к @CryptoSwappp.

Для авторизации запросов к API необходимо указать заголовок x-api-key со значением вашего ключа.

При ошибке авторизации будет отправлен код 401 UNAUTHORIZED.

Все запросы к API осуществляются методом POST с "Content-Type": "application/json" с частотой не более 100 запросов в минуту.

Ответы API имеют вид application/json тела, содержащего поле result в случае успешной обработки запроса или error в случае ошибки. result содержит поле data, error cодержит поле message.

const apiKey = "ваш-ключ";
const apiUrl = "https://ваш-эндпойнт/api";

const orderData = {
  // ... данные заказа ...
};

fetch(`${apiUrl}/orders/create`, {
  method: "POST",
  headers: {
    "Content-Type": "application/json",
    "X-api-key": apiKey,
  },
  body: JSON.stringify(orderData),
})
  .then((response) => {
    const { result, error } = response.json();
    if (!!error) {
      throw new Error(error.message);
    }
    return result.data;
  })
  .then((data) => {
    console.log("Заказ успешно создан:", data);
  })
  .catch((error) => {
    console.error("Ошибка:", error);
  });

Заявки

Создать Заявку

Этот эндпойнт создает заявку на прием номинала.

HTTP Request

POST /orders/create

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

Тип ответа

Получить заявки, таблица

Этот эндпойнт возвращает таблицу всех заявок на вашем ключе, отсортированный по дате создания в порядке убывания. Размер страницы фиксированный - 50.

HTTP Request

POST /api/orders/list

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

Тип ответа

Получить заявки, список

Этот эндпойнт возвращает список запрошенных заявок, максимум - 50.

HTTP Request

POST /api/orders/get

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

Тип ответа

Отменить транзакцию

Этот эндпойнт отменяет транзакцию.

HTTP Request

POST /api/orders/cancel

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

Тип ответа

Ошибки

При ошибке создания заявки сервис отправит поле error вместо result и data, в данном поле доступно message. В случае ответа 400 BAD REQUEST сообщение в поле message начинается с кода ошибки.

Ключ

Баланс

Этот эндпойнт возвращает общий баланс всех кошельков ключа.

HTTP Request

POST /api/keys/balance

Тип ответа

Создать кошелек

Этот эндпойнт позволяет создать кошелек.

HTTP Request

POST /api/keys/createWallet

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

Тип ответа

Получить кошелек

Этот эндпойнт позволяет получить данные конкретного кошелька.

HTTP Request

POST /api/keys/getWallet

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

Тип ответа

Получить кошельки, список

Этот эндпойнт возвращает все кошельки

HTTP Request

POST /api/keys/listWallets

Тип ответа

Обновить кошелек

Этот эндпойнт позволяет обновить имя кошелька и параметры для выплат.

HTTP Request

POST /api/keys/updateWallet

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

Тип ответа

Получить список доступных платежных методов

Этот эндпойнт позволяет обновить имя кошелька и параметры для выплат.

HTTP Request

POST /api/keys/listAvailableMethods

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

Тип ответа

Поддержка

Создать обращение в поддержку.

HTTP Request

POST /api/keys/support

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

Тип ответа

Webhooks

При запросе на доступ к API вы можете указать адрес для получения webhook-уведомлений. Ваш сервер должен отвечать статусом 200 при успешной обработке вебхука, в противном случае он будет отправлен повторно. Всего будет предпринято 4 попытки доставки уведомления.

Уведомления отправляются POST - запросом c application/json телом следующего вида:

Типы уведомлений (MessageType)

Типы данных уведомления

order.update

Типы

Заявка (Order)

Доступные методы оплаты (AvailableMethods)

Валюты (Currency)

Locale (Locale)

Методы оплаты (PaymentMethod)

Статус заявки (OrderStatus)

Страничные данные (Pagination)

Кошелек (Wallet)

Инструкции по осуществлению платежей

Платежи по НСПК

Платежи на реквизиты Таджикистана по номеру телефона

Трансграничные платежи по номеру карты

Платежи на реквизиты Абхазии ab доступны со счетов Т-Банка, ПСБ, БСПБ, Газпром Банка, YooMoney и осуществляются переводом на номер карты с указанием ФИО получателя.

Платежи на реквизиты Азербайджана az, Таджикистана tj и Узбекистана uz доступны со счетов Т-Банка и Сбербанка.