Crypto

Введение

Crypto — метод, позволяющий проводить платежи в долларах США и евро с использованием криптокошелька в разных странах. Для этого метода в платёжной платформе ecommpay поддерживаются оплаты и выплаты.

В этой статье представлена информация о работе с методом Crypto: обзорный раздел с общими сведениями и последующие разделы с информацией о действиях, необходимых со стороны мерчанта для решения разных задач.

Характеристика

* Информацию следует уточнять у курирующего менеджера ecommpay.

Схема работы

В проведении отдельного платежа с использованием метода Crypto задействуются веб-сервис мерчанта, один из интерфейсов и платёжная платформа ecommpay, а также технические средства сервиса провайдера.

Основные операции

Для проведения платежей и выполнения операций с использованием метода Crypto могут применяться различные интерфейсы платёжной платформы. Так, оплаты могут проводиться через Payment Page и Dashboard (с применением платёжных ссылок), а выплаты — через Gate. При этом, независимо от используемых интерфейсов, для этого метода характерны следующие свойства и ограничения.

При работе с методом Crypto, независимо от используемых интерфейсов, актуальны следующие свойства и ограничения.

Сценарии использования

Проведение оплат с использованием метода Crypto осуществляется с перенаправлением пользователей к сервису Crypto, проведение выплат — с уведомлением пользователей через веб-сервис мерчанта.

Рис.: Оплата через Payment Page

Рис.: Выплата через Gate

Общая информация

Для проведения оплаты через Payment Page с использованием метода Crypto со стороны веб-сервиса необходимо отправить запрос, содержащий требуемые параметры и подпись, на рабочий URL ecommpay и принять оповещение о результате. Полная схема проведения оплаты выглядит следующим образом.

Информация о форматах запросов и оповещений, используемых для проведения оплат методом Crypto через Payment Page, приведена далее в этом разделе; общая информация о работе с Payment Page API — в отдельной статье Организация взаимодействия.

Формат запросов

При формировании запросов на открытие платёжной формы с применением метода Crypto необходимо учитывать следующее:

1. Должен использоваться базовый минимум параметров, обязательный для любого платежа:
   • project_id — идентификатор проекта, полученный от ecommpay при интеграции;
   • payment_id — идентификатор платежа, уникальный в рамках проекта;
   • payment_currency — код валюты платежа в формате ISO-4217 alpha-3;
   • payment_amount — сумма платежа в дробных единицах валюты;
   • customer_id — идентификатор пользователя в рамках проекта.
2. Должен использоваться базовый минимум параметров: project_id, payment_id, payment_currency, payment_amount, customer_id.
3. Дополнительно могут потребоваться передаваться следующие данные пользователя, которые необходимо указать на Payment Page. Необходимость использования этих параметров следует уточнять у курирующего менеджера ecommpay.
   • customer_first_name — имя пользователя;
   • customer_last_name — фамилия пользователя;
   • customer_email — адрес электронной почты пользователя;
   • customer_country —код страны пользователя в формате ISO 3166-1 alpha-2;
   • customer_day_of_birth — дата рождения пользователя в формате ДД-ММ-ГГГГ.

   Если какие-либо из этих параметров отсутствуют в запросе, в платёжной форме могут отображаться поля для ввода пользователем недостающих значений (подробнее — в разделе Дополнение информации о платежах).

4. Для предварительного выбора метода Crypto необходимо указывать код платёжного метода crypto в параметре force_payment_method. Также в этом случае, в зависимости от провайдера, обрабатывающего платёж, можно задать криптовалюту (вследствие пользователь не сможет поменять заданную криптовалюту при оплате). Для этого в запросе необходимо указать код (тикер) криптовалюты в параметре payment_methods_options. Значение этого параметра имеет формат "{"currency_id":["..."]}", где ... это символ одной из доступных криптовалют. Пример корректного значения — "{"currency_id":["BTC"]}" . За информацией о возможности задания криптовалюты следует обращаться к курирующему менеджеру ecommpay.
5. В некоторых случаях (в зависимости от провайдера, обрабатывающего платёж), если в запросе указывается адрес электронной почты пользователя в параметре customer_email, то после проведённого или отклонённого платежа со стороны платёжной платформы на этот адрес отправляется письмо с информацией о результате оплаты.
6. Дополнительно могут использоваться любые другие параметры из числа доступных для работы с Payment Page (подробнее).
7. После указания всех целевых параметров необходимо составлять подпись (подробнее).

Таким образом, корректный запрос на открытие платёжной формы с применением метода Crypto должен содержать идентификатор проекта, базовые сведения о платеже (идентификатор, сумму и код валюты), информацию о пользователе и подпись.

Формат оповещений

Для оповещений о результатах оплат с применением метода Crypto используется типовой формат, описание которого представлено в статье Оповещения.

При успешной оплате через некоторых провайдеров, в оповещении в объекте crypto содержатся следующие параметры с дополнительной информацией о платеже:

• blockchain_url — ссылка для отслеживания информации об оплате в стороннем сервисе;
• exchange_rate — курс криптовалюты к фиатной валюте, который использовался при платеже;
• address — крипто-адрес, используемый пользователем для проведения оплаты;
• crypto_currency — символ криптовалюты, используемой для оплаты.

В следующем примере оповещение свидетельствует о том, что в рамках проекта 398 была успешно проведена оплата в размере 15,00 EUR.

{
        "project_id": 398,
        "payment": {
            "id": "TEST_1560760354708",
            "type": "purchase",
            "status": "success",
            "date": "2019-06-17T08:56:47+0000",
            "method": "crypto",
            "sum": {
                "amount": 1500,
                "currency": "EUR"
            },
            "description": ""
        },
        "operation": {
            "id": 29891000002814,
            "type": "sale",
            "status": "success",
            "date": "2019-06-17T08:56:47+0000",
            "created_date": "2019-06-17T08:50:34+0000",
            "request_id": "0d6aabd20c7925f1719b7cb63f728b32a3450cf0",
            "sum_initial": {
                "amount": 1500,
                "currency": "EUR"
            },
            "sum_converted": {
                "amount": 1500,
                "currency": "EUR"
            },
            "provider": {
                "id": 1288,
                "payment_id": "148947",
                "date": "2019-06-17T08:56:46+0000",
                "auth_code": ""
            },
            "code": "0",
            "message": "Success"
        },
         "crypto": {
            "exchange_rate": "32378.76267999",
            "address": "emulateBTCaddrjooterthas42ro87b0z",
            "blockchain_url": "https://api.example.com/c4ba632a094c078",
            "crypto_currency": "BTC"
            },
        "signature": "V0zYWk7Oz0wBJeQIHwj75hpkuXFNqHjYGMdfhycMw=="
}

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

{
        "project_id": 398,
        "payment": {
            "id": "TEST_1560760354708",
            "type": "purchase",
            "status": "decline",
            "date": "2019-06-17T08:56:47+0000",
            "method": "crypto",
            "sum": {
                "amount": 500,
                "currency": "EUR"
            },
            "description": ""
        },
        "operation": {
            "id": 29891000002815,
            "type": "sale",
            "status": "decline",
            "date": "2019-06-17T08:56:47+0000",
            "created_date": "2019-06-17T08:50:34+0000",
            "request_id": "0d6aabd20c7925f1719b7cb63f728b32a3450cf0",
            "sum_initial": {
                "amount": 500,
                "currency": "EUR"
            },
            "sum_converted": {
                "amount": 500,
                "currency": "EUR"
            },
            "provider": {
                "id": 1288,
                "payment_id": "148948",
                "date": "2019-06-17T08:56:46+0000",
                "auth_code": ""
            },
            "code": "20000",
            "message": "General decline"
        },
        "signature": "V0zYWk7OzwfcMBAhpkuXFNqHjYGMdfhycMw=="
}

Дополнительные материалы

Для организации работы с оплатами через Payment Page также могут быть полезны следующие материалы:

• Организация взаимодействия — о том, как организовать взаимодействие веб-сервиса с платёжной платформой через Payment Page.
• Работа с подписью к данным — о порядке создания и проверки подписи в программных запросах и оповещениях при взаимодействии с платёжной платформой.
• Модель проведения платежей — о типах, схемах проведения и возможных статусах поддерживаемых платежей и операций.
• Разовая оплата в одну стадию — о том, как проводить разовые оплаты через Payment Page.
• Информация о выполнении операций — о служебных кодах, которые используются в платёжной платформе, чтобы фиксировать информацию о выполнении операций.

Общая информация

Для проведения выплаты через Gate с использованием метода Crypto со стороны веб-сервиса необходимо отправить запрос, содержащий требуемые параметры и подпись, на рабочий URL ecommpay и принять оповещение о результате. Полная схема проведения выплаты выглядит следующим образом.

Информация о форматах запросов и оповещений, используемых для проведения выплат методом Crypto через Gate, приведена далее в этом разделе; общая информация о работе с Gate API — в отдельной статье Организация взаимодействия.

Формат запросов

При работе с запросами на выплаты с применением метода Crypto необходимо учитывать следующее:

1. Для инициирования каждой выплаты должен использоваться отдельный POST-запрос к конечной точке /v2/payment/crypto/payout.
2. В каждом запросе должны использоваться следующие объекты и параметры:
   • general — объект, содержащий основные идентификационные сведения запроса:
     • project_id — идентификатор проекта, полученный от ecommpay при интеграции;,
     • payment_id — идентификатор платежа, уникальный в рамках проекта;,
     • signature — подпись запроса, составленная после указания всех целевых параметров (подробнее — в разделе Работа с подписью к данным); (подробнее),
   • payment — объект, содержащий сведения о платеже:
     • amount — сумма выплаты в дробных единицах валюты;,
     • currency — код валюты платежа в формате ISO-4217 alpha-3;,
   • customer — объект, содержащий сведения о пользователе:
     • id — идентификатор пользователя, уникальный в рамках проекта;,
     • ip_address — IP-адрес пользователя, актуальный для инициируемой выплаты;,
     • first_name — имя пользователя;,
     • last_name — фамилия пользователя;,
     • email — электронная почта пользователя;,
     • country — код страны пользователя в формате ISO 3166-1 alpha-2;,
   • account — объект, содержащий сведения о счёте пользователя:
     • wallet_address — адрес электронного кошелька, поддерживающего криптовалюты;
     • crypto_currency — символ криптовалюты, поддерживаемой электронным кошельком, например: BTC, BCH, USDT, ETH (информацию о поддерживаемых криптовалютах следует уточнять у курирующего менеджера ecommpay).
3. Дополнительно могут использоваться любые другие параметры из числа указанных в спецификации.

Таким образом, корректный запрос на выплату с применением метода Crypto должен содержать идентификатор проекта, базовые сведения о платеже (его идентификатор, сумму и код валюты), информацию о пользователе и счёте, а также подпись.

{
  "general": {
    "project_id": 398,
    "payment_id": "115",
    "signature": "cMlzFj8zqZJbum1wy62aewWX7xcG+Ttb0fhuenWNptFZg=="
  },
  "payment": {
    "amount": 5000,
    "currency": "EUR"
  },
  "customer": {
    "id": "customer123",
    "ip_address": "192.0.2.0",
    "first_name": "Mary",
    "last_name": "Smith",
    "email": "customer@example.com",
    "country": "TR"
  },
    "account": {
      "wallet_address": "1BvBMSEYstWetqTFn5Au4m4GFg7xJaNVN2",
      "crypto_currency": "BTC"
    }
}

{
  "general": {
    "project_id": 398,
    "payment_id": "115",
    "signature": "cMlzFj8zqZJbum1wy62aewWX7xcG+Ttb0fhuenWNptFZg=="
  },
  "payment": {
    "amount": 5000,
    "currency": "EUR"
  },
  "customer": {
    "id": "customer123",
    "ip_address": "192.0.2.0",
    "first_name": "Mary",
    "last_name": "Smith",
    "email": "customer@example.com",
    "country": "TR"
  },
    "account": {
      "wallet_address": "1BvBMSEYstWetqTFn5Au4m4GFg7xJaNVN2",
      "crypto_currency": "BTC"
    }
}

Формат оповещений

Для оповещений о результатах выплат с применением метода Crypto используется типовой формат, описание которого представлено в разделе Оповещения.

В следующем примере оповещение свидетельствует о том, что в рамках проекта 398 была успешно проведена выплата в размере 50,00 EUR.

{
        "project_id": 398,
        "payment": {
            "id": "TEST_1560760354708",
            "type": "payout",
            "status": "success",
            "date": "2019-06-17T08:56:47+0000",
            "method": "crypto",
            "sum": {
                "amount": 5000,
                "currency": "EUR"
            },
            "description": ""
        },
        "operation": {
            "id": 29891000002814,
            "type": "sale",
            "status": "success",
            "date": "2019-06-17T08:56:47+0000",
            "created_date": "2019-06-17T08:50:34+0000",
            "request_id": "0d6aabd20c7925f1719b7cb63f728b32a3450cf0",
            "sum_initial": {
                "amount": 5000,
                "currency": "EUR"
            },
            "sum_converted": {
                "amount": 5000,
                "currency": "EUR"
            },
            "provider": {
                "id": 1288,
                "payment_id": "148947",
                "date": "2019-06-17T08:56:46+0000",
                "auth_code": ""
            },
            "code": "0",
            "message": "Success"
        },
        "signature": "V0zYWk7OzwfcMBAJJxArOjYGMdfhycMw=="
}

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

{
        "project_id": 398,
        "payment": {
            "id": "TEST_1560760354708",
            "type": "payout",
            "status": "decline",
            "date": "2019-06-17T08:56:47+0000",
            "method": "crypto",
            "sum": {
                "amount": 4000,
                "currency": "EUR"
            },
            "description": ""
        },
        "operation": {
            "id": 29891000002815,
            "type": "payout",
            "status": "decline",
            "date": "2019-06-17T08:56:47+0000",
            "created_date": "2019-06-17T08:50:34+0000",
            "request_id": "0d6aabd20c7925f1719b7cb63f728b32a3450cf0",
            "sum_initial": {
                "amount": 4000,
                "currency": "EUR"
            },
            "sum_converted": {
                "amount": 4000,
                "currency": "EUR"
            },
            "provider": {
                "id": 1288,
                "payment_id": "148948",
                "date": "2019-06-17T08:56:46+0000",
                "auth_code": ""
            },
            "code": "20101",
            "message": "Decline due to amount or frequency limit"
        },
        "signature": "V0zYWk7OzwfcMBApkuXFNqHjYGMdfhycMw=="
}

Дополнительные материалы

Для организации работы с выплатами через Gate также могут быть полезны следующие материалы:

• Организация взаимодействия — о том, как взаимодействовать с платёжной платформой через Gate.
• Работа с подписью к данным — о порядке создания и проверки подписи в программных запросах и оповещениях при взаимодействии с платёжной платформой.
• Модель проведения платежей — о типах, схемах проведения и возможных статусах поддерживаемых платежей и операций.
• Выплаты — о том, как проводить выплаты через Gate.
• Информация об операциях — о служебных кодах, используемых в платёжной платформе для фиксации информации о выполнении операций.