Ордер
Вы можете создавать ордера одного из следующих типов:
deposit
- пополнение (депозит)deposit_exchange
- пополнение с обменомdeposit_exchange_withdraw
- пополнение с обменом и выплатойexchange
- обменexchange_withdraw
- обмен с выплатойwithdraw
- выплата
Запрос на создание ордера отличается в зависимости от типа ордера. Но все созданные ордера имеют одинаковый набор полей.
Запрос
- Пополнение
- Пополнение с обменом
- Пополнение с обменом и выплатой
- Обмен
- Обмен с выплатой
- Выплата
POST /v2/order/deposit HTTP/1.1
Content-Type: application/json
Accept: application/json; charset=utf-8
Api-key: {publicApiKey}
Signature: {signature}
{
"order_id": "merchant_unique_order_id",
"currency": "usdt",
"network": "trc20", // card, btc, erc20 ...
"amount": 10,
"callback_url": "", //optional
"description": "order for ...", //optional
"client_info": { //optional
"client_id": "id1234",
"client_ip": "127.0.0.1",
"client_email": "[email protected]"
}
}
Описание параметров в запросе:
order_id
– Уникальный идентификатор платежа в системе мерчантаcurrency
– Валюта ордераnetwork
– Сеть осуществления платежа, card для фиатных валют, название блокчейна для крипто валютamount
– Сумма депозитаdescription
– Описание ордера (необязательно)callback_url
– URL адрес для сервер-сервер сообщения о результате выполнения ордераclient_info
– данные клиента в системе мерчанта: идентификатор, IP, email
POST /v2/order/deposit_exchange HTTP/1.1
Content-Type: application/json
Accept: application/json; charset=utf-8
Api-key: {publicApiKey}
Signature: {signature}
{
"order_id": "merchant_unique_order_id",
"currency_from": "usdt",
"network_from": "trc20",
"amount": 10,
"currency_to": "uah",
"callback_url": "", //optional
"description": "order for ...", //optional
"client_info": { //optional
"client_id": "id1234",
"client_ip": "127.0.0.1",
"client_email": "[email protected]"
}
}
Описание параметров в запросе:
order_id
– Уникальный идентификатор платежа в системе мерчантаcurrency_from
– Валюта пополненияnetwork_from
– Сеть осуществления платежа, card для фиатных валют, название блокчейна для крипто валютamount
– Сумма депозитаcurrency_to
– Валюта, в которую происходит обменdescription
– Описание ордера (необязательно)callback_url
– URL адрес для сервер-сервер сообщения о результате выполнения ордераclient_info
– данные клиента в системе мерчанта: идентификатор, IP, email
POST /v2/order/deposit_exchange_withdraw HTTP/1.1
Content-Type: application/json
Accept: application/json; charset=utf-8
Api-key: {publicApiKey}
Signature: {signature}
{
"order_id": "merchant_unique_order_id",
"currency_from": "usdt",
"network_from": "trc20",
"amount": 29, | "amount_to": 0.0003,
"currency_to": "btc",
"network_to": "btc",
"wallet": "2N9MQVd2rQZF9TEE3SXHzjvBUNgFWr2qf6V",
"wallet_memo": "",
"wallet_details": {} | [] | null, //depends on network_to
"callback_url": "", //optional
"description": "order for ...", //optional
"client_info": { //optional
"client_id": "id1234",
"client_ip": "127.0.0.1",
"client_email": "[email protected]"
}
}
Описание параметров в запросе:
order_id
– Уникальный идентификатор платежа в системе мерчантаcurrency_from
– Валюта пополненияnetwork_from
– Сеть осуществления платежа, card для фиатных валют, название блокчейна для крипто валютamount
– Сумма депозита.Вместо этой суммы вы можете указать сумму к получению в поле
amount_to
, чтобы вывод был точно на указанную сумму. При указанииamount_to
система рассчитывает необходимую сумму депозита, а дальнейшие транзакции производятся на основе фактической суммы депозита и обменного курса на момент обмена. В валютных парах, где обменный курс быстро меняется, фактическая сумма вывода может отличаться отamount_to
.currency_to
– Валюта выплатыnetwork_to
– Сеть выплаты, card для фиатных валют, название блокчейна для крипто валютdescription
– Описание ордера (необязательно)wallet
– Кошелек, на который происходит выплата (номер карты или адрес блокчейна)wallet_memo
– tag/memo адреса в блокчейне, на который происходит выплатаwallet_details
– Массив параметров (необязательно)wallet_details
используется для следующих сетейbank
– ожидаемый параметрbank_code
, например:
{"bank_code": "123123"}
bank_ua
– выплата на IBAN банков Украины, ожидаются параметрыrecipient_bank
,recipient_name
,taxpayer_number
, например:
{
"recipient_bank": "Super bank",
"recipient_name": "Name Surname",
"taxpayer_number": "1234567890"
}sepa
– выплата на IBAN банков Европы, ожидаются параметрыrecipient_email
,recipient_name
, например:
{
"recipient_email": "[email protected]",
"recipient_name": "Name Surname"
}multiple_cards
– выплата на несколько карт, ожидается массив пар параметровamount
иwallet
, которые определяют какая сумма на какую карту должна быть отправлена, например:
[{
"amount": 10,
"wallet": "4242424242424242"
},
{
"amount": 20,
"wallet": "4111111111111111"
}]callback_url
– URL адрес для сервер-сервер сообщения о результате выполнения ордераclient_info
– данные клиента в системе мерчанта: идентификатор, IP, email
POST /v2/order/exchange HTTP/1.1
Content-Type: application/json
Accept: application/json; charset=utf-8
Api-key: {publicApiKey}
Signature: {signature}
{
"order_id": "merchant_unique_order_id",
"currency_from": "btc",
"currency_to": "usdt",
"amount": 0.001415,
"callback_url": "", //optional
"description": "order for ...", //optional
"client_info": { //optional
"client_id": "id1234",
"client_ip": "127.0.0.1",
"client_email": "[email protected]"
}
}
Описание параметров в запросе:
order_id
– Уникальный идентификатор платежа в системе мерчантаcurrency_from
– Валюта из которой происходит обменcurrency_to
– Валюта, в которую происходит обменamount
– Сумма обмена в валютеcurrency_from
description
– Описание ордера (необязательно)callback_url
– URL адрес для сервер-сервер сообщения о результате выполнения ордераclient_info
– данные клиента в системе мерчанта: идентификатор, IP, email
POST /v2/order/exchange_withdraw HTTP/1.1
Content-Type: application/json
Accept: application/json; charset=utf-8
Api-key: {publicApiKey}
Signature: {signature}
{
"order_id": "merchant_unique_order_id",
"currency_from": "uah",
"amount": 375.93, | "amount_to": 10,
"currency_to": "usdt",
"network_to": "trc20",
"delay_order_for_minutes": 5, //optional
"wallet": "Tvb4KtWABb9vyzMhiLm3cgFaE11MCZfvQu",
"wallet_memo": "",
"wallet_details": {} | [] | null, //depends on network_to
"callback_url": "", //optional
"description": "order for ...", //optional
"client_info": { //optional
"client_id": "id1234",
"client_ip": "127.0.0.1",
"client_email": "[email protected]"
}
}
Описание параметров в запросе:
order_id
– Уникальный идентификатор платежа в системе мерчантаcurrency_from
– Валюта из которой происходит обменamount
– Сумма обмена вcurrency_from
.Вместо этой суммы вы можете указать сумму к получению в поле
amount_to
, чтобы вывод был точно на указанную сумму. При указанииamount_to
система рассчитывает необходимую сумму депозита, а дальнейшие транзакции производятся на основе фактической суммы депозита и обменного курса на момент обмена. В валютных парах, где обменный курс быстро меняется, фактическая сумма вывода может отличаться отamount_to
.currency_to
– Валюта выплатыnetwork_to
– Сеть выплаты, card для фиатных валют, название блокчейна для крипто валютdescription
– Описание ордера (необязательно)wallet
– Кошелек, на который происходит выплата (номер карты или адрес блокчейна)wallet_memo
– tag/memo адреса в блокчейне, на который происходит выплатаwallet_details
– Массив параметров (необязательно)wallet_details
используется для следующих сетейbank
– ожидаемый параметрbank_code
, например:
{"bank_code": "123123"}
bank_ua
– выплата на IBAN банков Украины, ожидаются параметрыrecipient_bank
,recipient_name
,taxpayer_number
, например:
{
"recipient_bank": "Super bank",
"recipient_name": "Name Surname",
"taxpayer_number": "1234567890"
}sepa
– выплата на IBAN банков Европы, ожидаются параметрыrecipient_email
,recipient_name
, например:
{
"recipient_email": "[email protected]",
"recipient_name": "Name Surname"
}multiple_cards
– выплата на несколько карт, ожидается массив пар параметровamount
иwallet
, которые определяют какая сумма на какую карту должна быть отправлена, например:
[{
"amount": 10,
"wallet": "4242424242424242"
},
{
"amount": 20,
"wallet": "4111111111111111"
}]callback_url
– URL адрес для сервер-сервер сообщения о результате выполнения ордераclient_info
– данные клиента в системе мерчанта: идентификатор, IP, email
POST /v2/order/withdraw HTTP/1.1
Content-Type: application/json
Accept: application/json; charset=utf-8
Api-key: {publicApiKey}
Signature: {signature}
{
"order_id": "merchant_unique_order_id",
"currency": "btc",
"network": "btc",
"delay_order_for_minutes": 5, //optional
"wallet": "2N9MQVd2rQZF9TEE3SXHzjvBUNgFWr2qf6V",
"wallet_memo": "",
"wallet_details": {} | [] | null, //depends on network
"amount": 0.0025,
"callback_url": "", //optional
"description": "order for ...", //optional
"client_info": { //optional
"client_id": "id1234",
"client_ip": "127.0.0.1",
"client_email": "[email protected]"
}
}
Описание параметров в запросе:
order_id
– Уникальный идентификатор платежа в системе мерчантаcurrency
– Валюта ордераnetwork
– Сеть выплаты, card для фиатных валют, название блокчейна для крипто валютdelay_order_for_minutes
– Задержать исполнение ордера на указанное число минутwallet
– Кошелек, на который происходит выплата (номер карты или адрес блокчейна)wallet_memo
– tag/memo адреса в блокчейне, на который происходит выплатаwallet_details
– Массив параметров (необязательно)wallet_details
используется для следующих сетейbank
– ожидаемый параметрbank_code
, например:
{"bank_code": "123123"}
bank_ua
– выплата на IBAN банков Украины, ожидаются параметрыrecipient_bank
,recipient_name
,taxpayer_number
, например:
{
"recipient_bank": "Super bank",
"recipient_name": "Name Surname",
"taxpayer_number": "1234567890"
}sepa
– выплата на IBAN банков Европы, ожидаются параметрыrecipient_email
,recipient_name
, например:
{
"recipient_email": "[email protected]",
"recipient_name": "Name Surname"
}multiple_cards
– выплата на несколько карт, ожидается массив пар параметровamount
иwallet
, которые определяют какая сумма на какую карту должна быть отправлена, например:
[{
"amount": 10,
"wallet": "4242424242424242"
},
{
"amount": 20,
"wallet": "4111111111111111"
}]amount
– Сумма выплатыdescription
– Описание ордера (необязательно)callback_url
– URL адрес для сервер-сервер сообщения о результате выполнения ордераclient_info
– данные клиента в системе мерчанта: идентификатор, IP, email
Ответ
Вы должны рассматривать любой не 200 или 400 HTTP статус ответа как непредвиденное поведение.
Например, если вы получили 5xx http статус во время запроса на создание выплаты, вы должны обрабатывать эту выплату как возможно созданную.
Вы должны проверить статус этой выплаты вызвав метод /v2/order/status
Успешный ответ будет содержать набор полей, структурированный следующим образом:
- Пополнение
- Пополнение с выплатой
- Пополнение с обменом и выплатой
- Обмен
- Обмен с выплатой
- Выплата
HTTP/1.1 200 OK
Content-Type: application/json
{
/* The overall status of the request, not the order status */
"status": "success",
"data": {
"order_uuid": "99c7f491-62ea-47fa-89c8-6043720374bf",
"order_type": "deposit",
"user_order_id": "merchant_unique_order_id",
"description": null,
"expected_amount_from": "10",
"amount_from": null,
"currency_from": "usdt",
"network_from": "trc20",
"deposit_from_user": null | "fpid-e03682a76e65",
"wallet_from": null,
"wallet_memo_from": null,
"expected_amount_to": "9.9",
"amount_to": null,
"strict_withdrawal_amount": false,
"currency_to": "usdt",
"network_to": "trc20",
"withdraw_to_user": null,
"wallet_to": null,
"wallet_memo_to": null,
"wallet_to_details": null,
"wallet_to_transactions": [],
"amount_from_fee": "0.1",
"amount_to_fee": null,
"deposit_url": null,
"deposit_address": "TT8y4xoTZ9yUL7FTqnC5z1Gb9ZTCvQDhHz",
"deposit_memo": null,
"deposit_address_title": null,
"deposit_address_initial_order_uuid": null,
"blockchain_deposit_hash": null,
"blockchain_withdrawal_hash": null,
"exchange_rate_initial": null,
"exchange_rate_actual": null,
"client_info": {
"client_id": "id1234",
"client_ip": "127.0.0.1",
"client_email": "[email protected]"
},
/* Order status */
"status": "new",
"error_code": 0,
"error_message": "",
"created_at": "1970-01-01 14:48:53",
"updated_at": "1970-01-01 14:48:54",
"finalized_at": null,
"start_order_at": null,
"currency_from_precision": 2,
"currency_to_precision": 2
}
}
Описание параметров в ответе:
order_uuid
– ID ордера в системе FlyPayorder_type
– Тип ордераuser_order_id
– Уникальный идентификатор платежа в системе мерчантаdescription
– Описание ордераexpected_amount_from
– Ожидаемая сумма депозитаamount_from
– Фактическая сумма депозитаcurrency_from
– Валюта пополненияnetwork_from
– Сеть депозитаdeposit_from_user
– ID пользователя в системе FlyPay, если пополнение в результате трансфера, иначе nullwallet_from
– Кошелек, из которого выполнен депозит (номер карты или адрес в блокчейне)wallet_memo_from
– tag/memo адреса в блокчейне, из которого выполнен депозитexpected_amount_to
– Ожидаемая сумма зачисления на баланс мерчантаamount_to
– Фактическая сумма зачисления на баланс мерчантаstrict_withdrawal_amount
– Используется для обменов с выплатойcurrency_to
– Валюта зачисленияnetwork_to
– Сеть платежаwithdraw_to_user
– ID пользователя в системе FlyPay, если выплата в результате трансфера, иначе nullwallet_to
– nullwallet_memo_to
– nullwallet_to_details
– Используется только в ордерах с выплатойwallet_to_transactions
– Используется только в ордерах с выплатойamount_from_fee
– Сумма комиссииamount_to_fee
– nulldeposit_url
– URL на который нужно перенаправить клиента для совершения платежаdeposit_address
– Адрес в блокчейне, на который нужно отправить депозитdeposit_memo
– tag/memo адреса в блокчейне, на который нужно отправить депозитdeposit_address_title
– Название депозит адреса, если это постоянный депозит адрес, и для него было создано названиеdeposit_address_initial_order_uuid
– order_uuid первого ордера в системе, где был использован данный депозит адрес, если естьblockchain_deposit_hash
– Хэш транзакции в блокчейне для завершенного депозита в крипто валютеblockchain_withdrawal_hash
– nullexchange_rate_initial
– Ожидаемый курс обмена при создании ордера (для ордеров с обменом)exchange_rate_actual
– Фактический курс обмена (для ордеров с обменом)status
– Статус ордера (new)error_code
– Код ошибкиerror_message
– Текст сообщения об ошибкеcreated_at
– Дата и время создания ордера в формате "Y-m-d H:i:s"updated_at
– Дата и время обновления ордера в формате "Y-m-d H:i:s"finalized_at
– Дата и время финализации ордера в формате "Y-m-d H:i:s"start_order_at
– Используется только для выплат, дата и время начала исполнения ордера в формате "Y-m-d H:i:s" | nullcurrency_from_precision
– Точность валюты депозита или обмена, количество знаков после запятойcurrency_to_precision
– Точность валюты выплаты, количество знаков после запятой
HTTP/1.1 200 OK
Content-Type: application/json
{
/* The overall status of the request, not the order status */
"status": "success",
"data": {
"order_uuid":"3e7d0f84-d655-4069-991c-ad4739874ca5",
"order_type":"deposit_exchange",
"user_order_id":"merchant_unique_order_id ",
"description": null,
"expected_amount_from":"10",
"amount_from":null,
"currency_from":"usdt",
"network_from":"trc20",
"deposit_from_user": null,
"wallet_from":null,
"wallet_memo_from":null,
"expected_amount_to":"370.06",
"amount_to":null,
"strict_withdrawal_amount": false,
"currency_to":"uah",
"network_to":null,
"withdraw_to_user": null,
"wallet_to":null,
"wallet_memo_to":null,
"wallet_to_details": null,
"wallet_to_transactions": [],
"amount_from_fee":"0",
"amount_to_fee":null,
"deposit_url":null,
"deposit_address":"TVb4KtWABb9vyzMhiLm3cgFaE11MCZfvQu",
"deposit_memo":null,
"blockchain_deposit_hash": null,
"blockchain_withdrawal_hash": null,
"exchange_rate_initial":"37.006",
"exchange_rate_actual":null,
/* Order status */
"status":"new",
"error_code":0,
"error_message":"",
"created_at":"1970-01-01 17:11:28",
"updated_at":"1970-01-01 17:11:29",
"finalized_at":null,
"start_order_at": null,
"currency_from_precision": 2,
"currency_to_precision": 2
}
}
Описание параметров в ответе:
order_uuid
– ID ордера в системе FlyPayorder_type
– Тип ордераuser_order_id
– Уникальный идентификатор платежа в системе мерчантаdescription
– Описание ордераexpected_amount_from
– Ожидаемая сумма депозитаamount_from
– Фактическая сумма депозитаcurrency_from
– Валюта пополненияnetwork_from
– Сеть депозитаdeposit_from_user
– nullwallet_from
– Кошелек, из которого выполнен депозит (номер карты или адрес в блокчейне)wallet_memo_from
– tag/memo адреса в блокчейне, из которого выполнен депозитexpected_amount_to
– Ожидаемая сумма результата обменаamount_to
– Фактическая сумма результата обменаstrict_withdrawal_amount
– falsecurrency_to
– Валюта, в которую происходит обменnetwork_to
– nullwithdraw_to_user
– nullwallet_to
– nullwallet_memo_to
– nullwallet_to_details
– nullwallet_to_transactions
– nullamount_from_fee
– Сумма комиссии в валюте депозитаamount_to_fee
– nulldeposit_url
– URL на который нужно перенаправить клиента для совершения платежаdeposit_address
– Адрес в блокчейне, на который нужно отправить депозитdeposit_memo
– tag/memo адреса в блокчейне, на который нужно отправить депозитdeposit_address_title
– Название депозит адреса, если это постоянный депозит адрес, и для него было создано названиеdeposit_address_initial_order_uuid
– order_uuid первого ордера в системе, где был использован данный депозит адрес, если естьblockchain_deposit_hash
– Хэш транзакции в блокчейне для завершенного депозита в крипто валютеblockchain_withdrawal_hash
– nullexchange_rate_initial
– Ожидаемый курс обмена при создании ордераexchange_rate_actual
– Фактический курс обменаstatus
– Статус ордера (new)error_code
– Код ошибкиerror_message
– Текст сообщения об ошибкеcreated_at
– Дата и время создания ордера в формате "Y-m-d H:i:s"updated_at
– Дата и время обновления ордера в формате "Y-m-d H:i:s"finalized_at
– Дата и время финализации ордера в формате "Y-m-d H:i:s"start_order_at
– nullcurrency_from_precision
– Точность валюты депозита или обмена, количество знаков после запятойcurrency_to_precision
– Точность валюты выплаты, количество знаков после запятой
HTTP/1.1 200 OK
Content-Type: application/json
{
/* The overall status of the request, not the order status */
"status": "success",
"data": {
"order_uuid":"3e7d0f84-d655-4069-991c-ad4739874ca5",
"order_type":"deposit_exchange_withdraw",
"user_order_id":"merchant_unique_order_id",
"description": null,
"expected_amount_from":"29",
"amount_from":null,
"currency_from":"usdt",
"network_from":"trc20",
"deposit_from_user": null,
"wallet_from":null,
"wallet_memo_from":null,
"expected_amount_to":"0.00103988",
"amount_to":null,
"strict_withdrawal_amount": false | true,
"currency_to":"btc",
"network_to":"btc",
"withdraw_to_user": null,
"wallet_to":"2N9MQVd2rQZF9TEE3SXHzjvBUNgFWr2qf6V",
"wallet_memo_to":null,
"wallet_to_details": null | {},
"wallet_to_transactions": [],
"amount_from_fee":null,
"amount_to_fee":"0",
"deposit_url":null,
"deposit_address":"TVb4KtWABb9vyzMhiLm3cgFaE11MCZfvQu",
"deposit_memo":null,
"blockchain_deposit_hash": null,
"blockchain_withdrawal_hash": null,
"exchange_rate_initial":"0.000035858",
"exchange_rate_actual":null,
"client_info": {
"client_id": "id1234",
"client_ip": "127.0.0.1",
"client_email": "[email protected]"
},
/* Order status */
"status":"new",
"error_code":0,
"error_message":"",
"created_at":"1970-01-01 19:17:37",
"updated_at":"1970-01-01 19:17:38",
"finalized_at":null,
"start_order_at": null,
"currency_from_precision": 2,
"currency_to_precision": 8
}
}
Описание параметров в ответе:
order_uuid
– ID ордера в системе FlyPayorder_type
– Тип ордераuser_order_id
– Уникальный идентификатор платежа в системе мерчантаdescription
– Описание ордераexpected_amount_from
– Ожидаемая сумма депозитаamount_from
– Фактическая сумма депозитаcurrency_from
– Валюта пополненияnetwork_from
– Сеть депозитаdeposit_from_user
– nullwallet_from
– Кошелек, из которого выполнен депозит (номер карты или адрес в блокчейне)wallet_memo_from
– tag/memo адреса в блокчейне, из которого выполнен депозитexpected_amount_to
– Ожидаемая сумма зачисления на кошелек (карту или адрес в блокчейне)amount_to
– Фактическая сумма зачисления на кошелек (карту или адрес в блокчейне)strict_withdrawal_amount
– true еслиamount_to
была указана при создании ордераcurrency_to
– Валюта выплатыnetwork_to
– Сеть выплатыwithdraw_to_user
– nullwallet_to
– Кошелек, на который происходит выплата (номер карты или адрес блокчейна)wallet_memo_to
– tag/memo адреса в блокчейне, на который происходит выплатаwallet_to_details
– Содержит данные выплаты, которые указывались при запросе в параметреwallet_details
wallet_to_transactions
– Содержит данные выплаты на несколько карт, иначе nullamount_from_fee
– Сумма комиссии в валюте депозитаamount_to_fee
– Сумма комиссии в валюте выплатыdeposit_url
– URL на который нужно перенаправить клиента для совершения платежаdeposit_address
– Адрес в блокчейне, на который нужно отправить депозитdeposit_memo
– tag/memo адреса в блокчейне, на который нужно отправить депозитdeposit_address_title
– Название депозит адреса, если это постоянный депозит адрес, и для него было создано названиеdeposit_address_initial_order_uuid
– order_uuid первого ордера в системе, где был использован данный депозит адрес, если естьblockchain_deposit_hash
– Хэш транзакции в блокчейне для завершенного депозита в крипто валютеblockchain_withdrawal_hash
– Хэш транзакции в блокчейне для завершенной выплаты в крипто валютеexchange_rate_initial
– Ожидаемый курс обмена при создании ордераexchange_rate_actual
– Фактический курс обменаstatus
– Статус ордера (new)error_code
– Код ошибкиerror_message
– Текст сообщения об ошибкеcreated_at
– Дата и время создания ордера в формате "Y-m-d H:i:s"updated_at
– Дата и время обновления ордера в формате "Y-m-d H:i:s"finalized_at
– Дата и время финализации ордера в формате "Y-m-d H:i:s"start_order_at
– nullcurrency_from_precision
– Точность валюты депозита или обмена, количество знаков после запятойcurrency_to_precision
– Точность валюты выплаты, количество знаков после запятой
HTTP/1.1 200 OK
Content-Type: application/json
{
/* The overall status of the request, not the order status */
"status": "success",
"data": {
"order_uuid":"eb7ac61f-18da-4983-a8a9-280c25f12ef4",
"order_type":"exchange",
"user_order_id":"merchant_unique_order_id",
"description": null,
"expected_amount_from":"0.001415",
"amount_from":null,
"currency_from":"btc",
"network_from":null,
"deposit_from_user": null,
"wallet_from":null,
"wallet_memo_from":null,
"expected_amount_to":"39.36",
"amount_to":null,
"strict_withdrawal_amount": false,
"currency_to":"usdt",
"network_to":null,
"withdraw_to_user": null,
"wallet_to":null,
"wallet_memo_to":null,
"wallet_to_details": null,
"wallet_to_transactions": [],
"amount_from_fee":null,
"amount_to_fee":null,
"deposit_url":null,
"deposit_address":null,
"deposit_memo":null,
"blockchain_deposit_hash": null,
"blockchain_withdrawal_hash": null,
"exchange_rate_initial":"27814.2473",
"exchange_rate_actual":null,
/* Order status */
"status":"processing",
"error_code":0,
"error_message":"",
"created_at":"1970-01-01 12:29:22",
"updated_at":"1970-01-01 12:29:22",
"finalized_at":null,
"start_order_at": null,
"currency_from_precision": 8,
"currency_to_precision": 2
}
}
Описание параметров в ответе:
order_uuid
– ID ордера в системе FlyPayorder_type
– Тип ордераuser_order_id
– Уникальный идентификатор платежа в системе мерчантаdescription
– Описание ордераexpected_amount_from
– Ожидаемая сумма обменаamount_from
– Фактическая сумма обменаcurrency_from
– Валюта из которой происходит обменnetwork_from
– nulldeposit_from_user
– nullwallet_from
– nullwallet_memo_from
– nullexpected_amount_to
– Ожидаемая сумма результата обменаamount_to
– Фактическая сумма результата обменаstrict_withdrawal_amount
– falsecurrency_to
– Валюта, в которую происходит обменnetwork_to
– nullwithdraw_to_user
– nullwallet_to
– nullwallet_memo_to
– nullwallet_to_details
– nullwallet_to_transactions
– nullamount_from_fee
– nullamount_to_fee
– nulldeposit_url
– nulldeposit_address
– nulldeposit_memo
– nulldeposit_address_title
– nulldeposit_address_initial_order_uuid
– nullblockchain_deposit_hash
– nullblockchain_withdrawal_hash
– nullexchange_rate_initial
– Ожидаемый курс обмена при создании ордераexchange_rate_actual
– Фактический курс обменаstatus
– Статус ордера (processing)error_code
– Код ошибкиerror_message
– Текст сообщения об ошибкеcreated_at
– Дата и время создания ордера в формате "Y-m-d H:i:s"updated_at
– Дата и время обновления ордера в формате "Y-m-d H:i:s"finalized_at
– Дата и время финализации ордера в формате "Y-m-d H:i:s"start_order_at
– nullcurrency_from_precision
– Точность валюты депозита или обмена, количество знаков после запятойcurrency_to_precision
– Точность валюты выплаты, количество знаков после запятой
HTTP/1.1 200 OK
Content-Type: application/json
{
/* The overall status of the request, not the order status */
"status": "success",
"data": {
"order_uuid":"1ed5ee07-6ea1-4563-8679-b3f9d2272a8b",
"order_type":"exchange_withdraw",
"user_order_id":"merchant_unique_order_id",
"description": null,
"expected_amount_from":"413.54",
"amount_from":null,
"currency_from":"uah",
"network_from":null,
"deposit_from_user": null,
"wallet_from":null,
"wallet_memo_from":null,
"expected_amount_to":"10",
"amount_to":null,
"strict_withdrawal_amount": false | true,
"currency_to":"usdt",
"network_to":"trc20",
"withdraw_to_user": null,
"wallet_to":"Tvb4KtWABb9vyzMhiLm3cgFaE11MCZfvQu",
"wallet_memo_to":null,
"wallet_to_details": null | {},
"wallet_to_transactions": [],
"amount_from_fee":null,
"amount_to_fee":"1",
"deposit_url":null,
"deposit_address":null,
"deposit_memo":null,
"blockchain_deposit_hash": null,
"blockchain_withdrawal_hash": null,
"exchange_rate_initial":"0.0266",
"exchange_rate_actual":null,
/* Order status */
"status":"processing",
"error_code":0,
"error_message":"",
"created_at":"1970-01-01 17:16:12",
"updated_at":"1970-01-01 17:16:12",
"finalized_at":null,
"start_order_at": null,
"currency_from_precision": 2,
"currency_to_precision": 2
}
}
Описание параметров в ответе:
order_uuid
– ID ордера в системе FlyPayorder_type
– Тип ордераuser_order_id
– Уникальный идентификатор платежа в системе мерчантаdescription
– Описание ордераexpected_amount_from
– Ожидаемая сумма обменаamount_from
– Фактическая сумма обменаcurrency_from
– Валюта из которой происходит обменnetwork_from
– nulldeposit_from_user
– nullwallet_from
– nullwallet_memo_from
– nullexpected_amount_to
– Ожидаемая сумма зачисления на кошелек (карту или адрес в блокчейне)amount_to
– Фактическая сумма зачисления на кошелек (карту или адрес в блокчейне)strict_withdrawal_amount
– true еслиamount_to
была указана при создании ордераcurrency_to
– Валюта выплатыnetwork_to
– Сеть выплатыwithdraw_to_user
– nullwallet_to
– Кошелек, на который происходит выплата (номер карты или адрес блокчейна)wallet_memo_to
– tag/memo адреса в блокчейне, на который происходит выплатаwallet_to_details
– Содержит данные выплаты, которые указывались при запросе в параметреwallet_details
wallet_to_transactions
– Содержит данные выплаты на несколько карт, иначе nullamount_from_fee
– Сумма комиссии в валюте депозитаamount_to_fee
– Сумма комиссии в валюте выплатыdeposit_url
– nulldeposit_address
– nulldeposit_memo
– nulldeposit_address_title
– nulldeposit_address_initial_order_uuid
– nullblockchain_deposit_hash
– nullblockchain_withdrawal_hash
– Хэш транзакции в блокчейне для завершенной выплаты в крипто валютеexchange_rate_initial
– Ожидаемый курс обмена при создании ордераexchange_rate_actual
– Фактический курс обменаstatus
– Статус ордера (processing)error_code
– Код ошибкиerror_message
– Текст сообщения об ошибкеcreated_at
– Дата и время создания ордера в формате "Y-m-d H:i:s"updated_at
– Дата и время обновления ордера в формате "Y-m-d H:i:s"finalized_at
– Дата и время финализации ордера в формате "Y-m-d H:i:s"start_order_at
– Дата и время начала исполнения ордера в формате "Y-m-d H:i:s", если при создании ордера был указан параметрdelay_order_for_minutes
, иначе nullcurrency_from_precision
– Точность валюты депозита или обмена, количество знаков после запятойcurrency_to_precision
– Точность валюты выплаты, количество знаков после запятой
HTTP/1.1 200 OK
Content-Type: application/json
{
/* The overall status of the request, not the order status */
"status": "success",
"data": {
"order_uuid":"e7f9f137-395d-4ecc-8061-42e65b56f46b",
"order_type":"withdraw",
"user_order_id":"merchant_unique_order_id",
"description": null,
"expected_amount_from":"0.0047",
"amount_from":null,
"currency_from":"btc",
"network_from":"btc",
"deposit_from_user": null,
"wallet_from":null,
"wallet_memo_from":null,
"expected_amount_to":"0.0025",
"amount_to":null,
"strict_withdrawal_amount": false,
"currency_to":"btc",
"network_to":"btc",
"withdraw_to_user": null | "fpid-e03682a76e65",
"wallet_to":"2N9MQVd2rQZF9TEE3SXHzjvBUNgFWr2qf6V",
"wallet_memo_to":"",
"wallet_to_details": null | {},
"wallet_to_transactions": [],
"amount_from_fee":"0.0022",
"amount_to_fee":null,
"deposit_url":null,
"deposit_address":null,
"deposit_memo":null,
"blockchain_deposit_hash": null,
"blockchain_withdrawal_hash": null,
"exchange_rate_initial":null,
"exchange_rate_actual":null,
"client_info": {
"client_id": "id1234",
"client_ip": "127.0.0.1",
"client_email": "[email protected]"
},
/* Order status */
"status":"processing",
"error_code":0,
"error_message":"",
"created_at":"1970-01-01 12:32:47",
"updated_at":"1970-01-01 12:32:47",
"finalized_at":null,
"start_order_at": null,
"currency_from_precision": 8,
"currency_to_precision": 8
}
}
Описание параметров в ответе:
order_uuid
– ID ордера в системе FlyPayorder_type
– Тип ордераuser_order_id
– Уникальный идентификатор платежа в системе мерчантаdescription
– Описание ордераexpected_amount_from
– Ожидаемая сумма списания с баланса мерчантаamount_from
– Фактическая сумма списания с баланса мерчантаcurrency_from
– Валюта выплатыnetwork_from
– Сеть выплатыdeposit_from_user
– ID пользователя в системе FlyPay, если пополнение в результате трансфера, иначе nullwallet_from
– nullwallet_memo_from
– nullexpected_amount_to
– Ожидаемая сумма зачисления на кошелек (карту или адрес в блокчейне)amount_to
– Фактическая сумма зачисления на кошелек (карту или адрес в блокчейне)strict_withdrawal_amount
– Используется для обменов с выплатойcurrency_to
– Валюта выплатыnetwork_to
– Сеть выплатыwithdraw_to_user
– ID пользователя в системе FlyPay, если выплата в результате трансфера, иначе nullwallet_to
– Кошелек, на который происходит выплата (номер карты или адрес блокчейна)wallet_memo_to
– tag/memo адреса в блокчейне, на который происходит выплатаwallet_to_details
– Содержит данные выплаты, которые указывались при запросе в параметреwallet_details
wallet_to_transactions
– Содержит данные выплаты на несколько карт, иначе nullamount_from_fee
– Сумма комиссииamount_to_fee
– nulldeposit_url
– nulldeposit_address
– nulldeposit_memo
– nulldeposit_address_title
– nulldeposit_address_initial_order_uuid
– nullblockchain_deposit_hash
– nullblockchain_withdrawal_hash
– Хэш транзакции в блокчейне для завершенной выплаты в крипто валютеexchange_rate_initial
– Ожидаемый курс обмена при создании ордера (для ордеров с обменом)exchange_rate_actual
– Фактический курс обмена (для ордеров с обменом)status
– Статус ордера (processing)error_code
– Код ошибкиerror_message
– Текст сообщения об ошибкеcreated_at
– Дата и время создания ордера в формате "Y-m-d H:i:s"updated_at
– Дата и время обновления ордера в формате "Y-m-d H:i:s"finalized_at
– Дата и время финализации ордера в формате "Y-m-d H:i:s"start_order_at
– Дата и время начала исполнения ордера в формате "Y-m-d H:i:s", если при создании ордера был указан параметрdelay_order_for_minutes
, иначе nullcurrency_from_precision
– Точность валюты депозита или обмена, количество знаков после запятойcurrency_to_precision
– Точность валюты выплаты, количество знаков после запятой