Перейти к основному содержимому

Криптовалютные выплаты на персональный кошелек Qostiq​

Crypto transfer - Этот метод позволяет совершить криптовалютные выплаты с криптовалютного баланса магазина на персональный Qostiq кошелек.

Предварительный расчет выплаты на кошелек Qostiq [/crypto/transfer/try]​

URL: https://core.qostiq.com/crypto/transfer/try

Метод: POST

Обязательные параметры: amount, amount_type, now, payer_currency, shop_currency, shop_id

Данный запрос не является обязательным для создания выплаты на криптовалютный кошелек Qostiq. Запрос уточняет возможность создания выплаты с указанными параметрами, возвращает суммы списания с магазина и получения на кошелек получателя после расчета комиссии или конвертации.

Пример Запроса:

{
    "amount": 10,
    "amount_type": "writeoff_amount",
    "now": 1691400155,
    "payee_currency": "TRX",
    "shop_currency": "TRX",
    "shop_id": 6,
    "sign": "e77dc50d3e4bc3b307924aaefeab1887d38e1aa0d73ba17a2bdad99893b984e6"
}

Где,

ПараметрОписаниеФорматПример
amountсумма выплатыString или number, количество знаков после запятой смотрите детальней в пункте "Указание суммы операции""1.00000001" или 1.00000001
amount_typeуказывает на тип суммы amount, возможны значения: receive_amount – сумма к получению на кошелек в валюте payer_currency, writeoff_amount - сумма к списанию с баланса магазина в валюте shop_currencyString"receive_amount" или "writeoff_amount"
nowвремя запроса, в формате unixtimestampInteger1691400155
payer_currencyвалюта получения средств на кошелек клиентаString"TRX"
shop_currencyвалюта списания средств с баланса магазинаString"TRX "
shop_idидентификатор магазина в системе QostiqInteger6
signподпись, см. п. Правила формирования подписи для операций с криптовалютой (sign)String"e77dc50d3e4bc3b307924aaefeab1887d38e1aa0d73ba17a2bdad99893b984e6"

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

{
    "data": {
        "fee": "0.0",
        "payee_currency": "TRX",
        "receive_amount": "10.0",
        "shop_currency": "TRX",
        "write_off_amount": "10.0"
    },
    "error_code": 0,
    "message": "Ok",
    "result": true
}

Где,

fee - комиссия за выплату;

payee_currency - валюта получения выплаты;

receive_amount - сумма к получению на счет в валюте с параметра payee_currency;

shop_currency - валюта списания с баланса магазина;

write_off_amount - сумма списания с магазина в валюте с параметра shop_currency.

Предварительный расчет выплаты на кошелек Qostiq [POST]​

  • Request

      ```json
      {
      "amount":10,
      "amount_type":"writeoff_amount",
      "now":1691400155,
      "payee_currency":"TRX",
      "shop_currency":"TRX",
      "shop_id":6,
      "sign": "e77dc50d3e4bc3b307924aaefeab1887d38e1aa0d73ba17a2bdad99893b984e6"
      }
      ```

  • Response 200 ()

      ```json
      {
          "data": {
              "fee": "0.0",
              "payee_currency": "TRX",
              "receive_amount": "10.0",
              "shop_currency": "TRX",
              "write_off_amount": "10.0"
          },
          "error_code": 0,
          "message": "Ok",
          "result": true
      }
      ```

Создание выплаты на кошелек Qostiq [/crypto/transfer/create]​

URL: https://core.qostiq.com/crypto/transfer/create

Метод: POST

Обязательные параметры: amount, amount_type, now, payee_account, payer_currency, shop_currency, shop_id, shop_payment_id

Данный запрос создает сущность выплаты на Qostiq кошелек клиента.

Значение параметра shop_payment_id должен быть уникальным для каждого нового перевода.

В запросе могут передаваться дополнительные параметры, например, description – описание выплаты.

Внимание! На текущий момент совершение выплат с конвертаций недоступно. При создании должна быть указанная одинаковая валюта в параметрах "payee_currency" и "shop_currency" иначе запрос получит ошибку "message": "Currencies must be the same".

Пример Запроса:

{
    "amount": 10,
    "amount_type": "writeoff_amount",
    "now": 1691484449,
    "payee_account": "31645670435",
    "payee_currency": "TRX",
    "shop_currency": "TRX",
    "shop_id": 6,
    "shop_payment_id": "bfe31d10-adea-40f4-9249-d2dafa2e09db",
    "sign": "6a3a94b38df2d2041ad75b44d3f259b75064b3deebba8f6c50c784cbe686b9bf"
}

Где,

ПараметрОписаниеФорматПример
amountсумма выплатыString или number, количество знаков после запятой смотрите детальней в пункте "Указание суммы операции""1.00000001" или 1.00000001
amount_typeуказывает на тип суммы amount, возможны значения: receive_amount – сумма к получению на кошелек в валюте payer_currency, writeoff_amount - сумма к списанию с баланса магазина в валюте shop_currencyString"receive_amount" или "writeoff_amount"
nowвремя запроса, в формате unixtimestampInteger1691484449
payee_accountаккаунт получателя средств в системе Qostiq, может быть передан как номер кошелька, так и email пользователяString"31645670435" или "example@mail.com";
payer_currencyвалюта получения средств на кошелек клиентаString"TRX"
shop_currencyвалюта списания средств с баланса магазинаString"TRX "
shop_idидентификатор магазина в системе QostiqInteger6
shop_payment_idуникальный идентификатор платежа на стороне магазинаString"bfe31d10-adea-40f4-9249-d2dafa2e09db"
signподпись, см. п. Правила формирования подписи для операций с криптовалютой (sign)String"6a3a94b38df2d2041ad75b44d3f259b75064b3deebba8f6c50c784cbe686b9bf"

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

{
    "data": {
        "fee": "0.0",
        "id": 1266,
        "payee_currency": "TRX",
        "receive_amount": "10.0",
        "shop_currency": "TRX",
        "write_off_amount": "10.0"
    },
    "error_code": 0,
    "message": "Ok",
    "result": true
}

Где,

fee - комиссия за выплату;

id - уникальный идентификатор перевода на стороне Qostiq;

payee_currency - валюта получения выплаты;

receive_amount - сумма к получению на счет в валюте с параметра payee_currency;

shop_currency - валюта списания с баланса магазина;

write_off_amount - сумма списания с магазина в валюте с параметра shop_currency.

Внимание! У операции transfer отсутствует статус, т.к. если он создался и в ответе вернулся ID перевода, то перевод считается успешно проведенным, дополнительных запросов не требуется.

Создание выплаты на кошелек Qostiq [POST]​

  • Request

      ```json
      {
      "amount":10,
      "amount_type":"writeoff_amount",
      "now":1691484449,
      "payee_currency":"TRX",
      "payee_account":"31645670435",
      "shop_currency":"TRX",
      "shop_payment_id":"bfe31d10-adea-40f4-9249-d2dafa2e09db",
      "shop_id":6,
      "sign": "6a3a94b38df2d2041ad75b44d3f259b75064b3deebba8f6c50c784cbe686b9bf"
      }
      ```

  • Response 200 ()

      ```json
      {
          "data": {
              "fee": "0.0",
              "id": 1266,
              "payee_currency": "TRX",
              "receive_amount": "10.0",
              "shop_currency": "TRX",
              "write_off_amount": "10.0"
          },
          "error_code": 0,
          "message": "Ok",
          "result": true
      }
      ```

Запрос статуса выплаты на кошелек Qostiq [/crypto/transfer/status]​

Запрос статуса по переводу transfer выполняется по номеру платежа магазина.

В случае получения time-out или других ошибок на запрос создания transfer, можно сделать запрос статуса выплаты с помощью данного метода. Если в ответе вернулся идентификатор и данные по переводу, то значит выплата была успешно создана и проведена. В противном случае вернется ошибка, что выплата не найдена и необходимо будет повторить запрос на создание выплаты.

URL: https://core.qostiq.com/crypto/transfer/status

Метод: POST

Обязательные параметры: now, shop_id, shop_payment_id

ПараметрОписаниеФорматПример
nowвремя запросаInteger1691491958
shop_payment_idномер счета на стороне Вашего сервисаString"bfe31d10-adea-40f4-9249-d2dafa2e09db"
shop_idидентификатор магазина в системе QostiqInteger6
signподписьString"a39c6eee74e6213a722e4f85ee05b0207d05e25b7c54b75f14fe646a86832948"

Пример запроса:

{
    "shop_id": 6,
    "shop_payment_id": "bfe31d10-adea-40f4-9249-d2dafa2e09db",
    "now": 1691491958,
    "sign": "a39c6eee74e6213a722e4f85ee05b0207d05e25b7c54b75f14fe646a86832948"
}

Пример ответа, если transfer был создан и проведен:

{
    "data": {
        "fee": "0.0",
        "id": 1266,
        "payee_currency": "TRX",
        "receive_amount": "10.0",
        "shop_currency": "TRX",
        "write_off_amount": "10.0"
    },
    "error_code": 0,
    "message": "Ok",
    "result": true
}

Пример ответа, если transfer не был создан (не найден):

{
    "data": null,
    "error_code": 7,
    "message": "Transfer (shop_payment_id=test_order_name) wasn't found",
    "result": false
}
{
    "data": null,
    "error_code": 7,
    "message": "Transfer (shop_payment_id=test_order_name) wasn't found",
    "result": false
}

Запросить статус transfer [POST]​

  • Request (application/json)

      ```json
      { 
          "shop_id": 6, 
          "shop_payment_id": "bfe31d10-adea-40f4-9249-d2dafa2e09db", 
          "now": 1691491958, 
          "sign": "a39c6eee74e6213a722e4f85ee05b0207d05e25b7c54b75f14fe646a86832948" 
      }
      ```

  • Response 200 ()

      ```json
      {
          "data": {
              "fee": "0.0",
              "id": 1266,
              "payee_currency": "TRX",
              "receive_amount": "10.0",
              "shop_currency": "TRX",
              "write_off_amount": "10.0"
          },
          "error_code": 0,
          "message": "Ok",
          "result": true
      } 
      ```

  • Response 200 ()

      ```json
      { 
          "data": null, 
          "error_code": 7, 
          "message": "Transfer (shop_payment_id=test_order_name) wasn't found", 
          "result": false 
      }
      ```