Обмен и прием
криптовалют.

Повышайте оборачиваемость средств, привлекайте клиентов.
Подчините себе стихию криптовалют с помощью Flyp.me.

Содержание

Версия API: 1.1.3

Введение

Flyp.me API — быстрый, эффективный и надежный способ приема более чем 30 криптовалют, везде и всегда. Его очень просто интегрировать с вашим веб-сайтом, платформой или существующей службой. Вам понравится, и вашим клиентам тоже.

Если у вас есть технические вопросы по Flyp.me API, пишите по адресу api@flyp.me. По вопросам партнерства и аналогичным вопросам пишите по адресу business@flyp.me.

1. Создать

Инициировать новый заказ

curl -X POST -d @file.txt https://flyp.me/api/v1/order/new --header "Content-Type:application/json"

file.txt:

{
  "order": {
    "from_currency": "LTC",
    "to_currency": "ZEC",
    "ordered_amount": "0.01"
  }
}

Примечания:

При первоначальном запросе можно также указать invoiced_amount вместо ordered_amount.

Response will always include based with values `INVOICED` or `ORDERED` respectively.

Можно опционально указать в запросе destination и refund_address.

Можно опционально указать в запросе referral_code. Обратите внимание, что нужно указывать проверенный реферал, в противном случае заказ завершится ошибкой.

result.txt:

{
  "order": {
    "uuid": "eeeeb105-d30d-43f1-bbb8-a9f8a237acf5",
    "destination": null,
    "exchange_rate": "0.4840738172",
    "ordered_amount": "0.01",
    "invoiced_amount": "0.02189749",
    "charged_fee": "0.0006",
    "based": "ORDERED",
    "from_currency": "LTC",
    "to_currency": "ZEC"
  },
  "refund_address": "LajyQBeZaBA1NkZDeY8YT5RYYVRkXMvb2T",
  "expires": 1199
}

Получите оттуда значение uuid, чтобы продолжить процедуру.

2. Обновить

Обновить заказ

curl -X POST -d @file.txt https://flyp.me/api/v1/order/update --header "Content-Type:application/json"

file.txt:

{
  "order": {
    "uuid": "eeeeb105-d30d-43f1-bbb8-a9f8a237acf5",
    "ordered_amount": "0.02",
    "destination": "t1SBTywpsDMKndjogkXhZZSKdVbhadt3rVt",
    "refund_address": "LajyQBeZaBA1NkZDeY8YT5RYYVRkXMvb2T"
  }
}

Примечания:

Имеет те же параметры, что и при создании заказа, но from_currency и to_currency теперь опциональны и добавлен новый обязательный параметр uuid.

Можно опционально указать в запросе referral_code. Обратите внимание, что нужно указывать проверенный реферал, в противном случае заказ завершится ошибкой.

result.txt:

{
  "order": {
    "uuid": "eeeeb105-d30d-43f1-bbb8-a9f8a237acf5",
    "destination": "t1SBTywpsDMKndjogkXhZZSKdVbhadt3rVt",
    "exchange_rate": "0.4881512527",
    "ordered_amount": "0.02",
    "invoiced_amount": "0.04220004",
    "charged_fee": "0.0006",
    "based": "ORDERED",
    "from_currency": "LTC",
    "to_currency": "ZEC"
  },
  "refund_address": "LajyQBeZaBA1NkZDeY8YT5RYYVRkXMvb2T",
  "expires": 1199
}

Примечания:

Возвращаемый параметр charged_fee содержит начисленную плату за сеть в единицах to_currency.

3. Принять

Принять заказ

curl -X POST -d @file.txt https://flyp.me/api/v1/order/accept --header "Content-Type:application/json"

file.txt:

{"uuid": "eeeeb105-d30d-43f1-bbb8-a9f8a237acf5"}

result.txt:

{
  "order": {
    "uuid": "eeeeb105-d30d-43f1-bbb8-a9f8a237acf5",
    "destination": "t1SBTywpsDMKndjogkXhZZSKdVbhadt3rVt",
    "exchange_rate": "0.4888796682",
    "ordered_amount": "0.02",
    "invoiced_amount": "0.04213716",
    "charged_fee": "0.0006",
    "based": "ORDERED",
    "from_currency": "LTC",
    "to_currency": "ZEC"
  },
  "expires": 1145,
  "deposit_address": "M88aw1wCKvVP7EAmqviV8ggxM5ds8BypvQ",
  "refund_address": "LajyQBeZaBA1NkZDeY8YT5RYYVRkXMvb2T"
}

4. Проверить

Проверить статус заказа по uuid

Возможные статусы:: WAITING_FOR_DEPOSIT, DEPOSIT_RECEIVED, DEPOSIT_CONFIRMED, EXECUTED, NEEDS_REFUND, REFUNDED, CANCELED and EXPIRED

curl -X POST -d @file.txt https://flyp.me/api/v1/order/check --header "Content-Type:application/json"

file.txt:

{"uuid": "9a14a8c2-cc2e-4156-bbdd-96437ef81bf6"}

result.txt:

{"status": "WAITING_FOR_DEPOSIT", payment_status: "PENDING"}

Результат также будет включать "txid" и "txurl", если заказ имеет статус EXECUTED.

Результат также будет включать "confirmations", если платеж имеет статус XXX_RECEIVED.

{"status": "EXECUTED", "txid": "XXXXX", "txurl": "https://etherscan.io/tx/XXX"}

Возможные значения payment_status: PENDING, UNDERPAY_RECEIVED, UNDERPAY_CONFIRMED, PAYMENT_RECEIVED, PAYMENT_CONFIRMED, OVERPAY_RECEIVED, OVERPAY_CONFIRMED. Заказы с недоплатой или переплатой будут возмещаться системой.

5. Информация

Получить полную информацию о заказе

Эта команда имеет ограничения по частоте вызова, поэтому ее нельзя использовать для непрерывного мониторинга заказа, используйте вместо этого "check"

curl -X POST -d @file.txt https://flyp.me/api/v1/order/info --header "Content-Type:application/json"

file.txt:

{"uuid": "9a14a8c2-cc2e-4156-bbdd-96437ef81bf6"}

result.txt:

{
  "order": {
    "uuid": "eeeeb105-d30d-43f1-bbb8-a9f8a237acf5",
    "destination": "t1SBTywpsDMKndjogkXhZZSKdVbhadt3rVt",
    "exchange_rate": "0.4888796682",
    "ordered_amount": "0.02",
    "invoiced_amount": "0.04213716",
    "charged_fee": "0.0006",
    "based": "ORDERED",
    "from_currency": "LTC",
    "to_currency": "ZEC"
  },
  "expires": 746,
  "status": "WAITING_FOR_DEPOSIT",
  "payment_status": "PENDING",
  "deposit_address": "M88aw1wCKvVP7EAmqviV8ggxM5ds8BypvQ",
  "refund_address": "LajyQBeZaBA1NkZDeY8YT5RYYVRkXMvb2T"
}

Результат также будет включать "txid" и "txurl", если заказ имеет статус EXECUTED.

Результат также будет включать "confirmations", если платеж имеет статус XXX_RECEIVED.

{
  "order": {
    "uuid": "eeeeb105-d30d-43f1-bbb8-a9f8a237acf5",
    (...)
    },
    (...)
    "deposit_address": "M88aw1wCKvVP7EAmqviV8ggxM5ds8BypvQ",
    "txid": "XXXXX",
    "txurl": "https://etherscan.io/tx/..."
}

6. Отменить заказ

Отменить ожидающий заказ

curl -X POST -d @file.txt https://flyp.me/api/v1/order/cancel --header "Content-Type:application/json"

file.txt:

{"uuid": "9a14a8c2-cc2e-4156-bbdd-96437ef81bf6"}

result.txt:

{"result":"ok"}

7. Добавить возмещение для заказа

Добавить адрес возмещения для заказов, которые его не имеют.

curl -X POST -d @file.txt https://flyp.me/api/v1/order/addrefund --header "Content-Type:application/json"

file.txt:

{"uuid": "9a14a8c2-cc2e-4156-bbdd-96437ef81bf6", "address": "LajyQBeZaBA1NkZDeY8YT5RYYVRkXMvb2T"}

result.txt:

{"result":"ok"}

8. Запросить курсы

Получить курсы обмена

curl https://flyp.me/api/v1/data/exchange_rates

result.txt:

{"LTC-BTC":"0.0156975877",
 "BTC-LTC":"60.5139402396",
 "PPC-BTC":"0.0004053465",
 (...)
 "PPC-LTC":"0.024900034",
 "BTC-PPC":"2338.8025331034"}

Примечания:

Можно опционально добавить параметр referral_code, чтобы получить курсы для конкретного реферала.

9. Запросить активные валюты

Получить информацию о доступных валютах

curl https://flyp.me/api/v1/currencies
Для параметров валюты exchange и send необходимо установить значение "true", чтобы валюта была доступна для обмена без использования счетов. Параметр "Confirmation time" — это ожидаемое время в минутах (примерно). Остальные параметры не нуждаются в объяснении.

result.txt:

{"BTC": {"code":"BTC", "precision":8, "display_precision":4, "created_at":"2014-02-04T02:28:37.000Z", "updated_at":"2017-10-20T14:02:11.000Z", "name":"Bitcoin", "website":"https://bitcoin.org/", "confirmation_time":20, "default":false, "charged_fee":"0.0006", "currency_type":"CRYPTO", "exchange":true, "send":true},
 (...)
 "CREA": {"code":"CREA", "precision":8, "display_precision":4, "created_at":"2017-10-24T09:36:39.000Z", "updated_at":"2017-10-24T13:05:29.000Z", "name":"Creativecoin", "website":"https://www.creativechain.org", "confirmation_time":5, "default":false, "charged_fee":"0.01", "currency_type":"CRYPTO", "exchange":false, "send":false}}

10. Запросить лимиты

Получите максимальный и минимальный лимиты в {to_currency}.

Примечание. Чтобы получить лимиты в {from_currency}, необходимо вычислить их по курсу обмена.

GET - /api/v1/order/limits/{from_currency}/{to_currency}
curl -X GET https://flyp.me/api/v1/order/limits/BTC/LTC

result.txt:

{"min":"0.015","max":"52.11198655"}

11. История изменений

1.1.3: 2018/11/19 - Add NEEDS_REFUND status for orders.
                  - Add refund_address in order results.
                  - Add /order/addrefund api call to add a refund address.
                  - Add payment_status inside order/info and order/check.
                  - Add referral_code parameter to data/exchange_rates.
1.1.2: 2018/05/19 - Add txurl to order/info and order/check results.
1.1.1: 2018/03/12 - Add referral code parameter to create order.
1.1.0: 2017/12/13 - Introduce new limits and order creation api.
                  - Introduce new order/new, order/update and GET order/limits methods.
                  - order/create *deprecated* in favour of order/new and order/update pair.
                    - This allows presenting the exact rate to the user before he accepts.
                  - POST order/limits *deprecated* in favour of GET order/limits.
                    - The new api gives more exact limits since it accepts limits between two
                      currencies instead of limits for just one currency.
                  - Add txid to order/info and order/check results.
1.0.0: 2017/11/21 - First api version on flyp.me release.

NOTE about deprecated methods: We prefer api implementors will not be using these, so we removed
documentation about them. Still the methods are not removed for backwards compatibility for now.

По вопросам партнерства или по любым другим
вопросам обращайтесь к нам.

Обращайтесь к нам