API

Создание платежа

Для инициализации платежа посредством единой формы оплаты вам достаточно направить пользователя по специальному URL.

You can specify the Callback URL in the merchant settings in the panel

Пример формирования цифровой подписи на PHP

function getFormSignature($id, $currency, $amount, $external_invoice, $secretKey) { $hashStr = $id.'{up}'.$currency.'{up}'.$amount.'{up}'.$external_invoice.'{up}'.$secretKey; return hash('sha256', $hashStr); } $signature = getFormSignature($id, $currency, $amount, $external_invoice, $secretKey);

Цифровая подпись формируется как sha256(параметры инициализации платежа описанные выше с добавлением secretKey = КЛЮЧА ДОСТУПА из настроек платежного мерчанта). При формировании цифровой подписи обязательно должны быть указаны все приведенные в примере переменные.

Пример инициализации платежа

https://cryptokick.app/api/merchant.php?

act=request_payment

test=Y

form=Y

coin=BTC

id=Идентификатор из настроек платежного мерчанта

amount=0.01

currency=BTC

external_invoice=1000

message=Test Invoice

signature=Цифровая подпись

callback_url=http://example.com/pay.php

Тестовый режим

Если значение параметра test = Y, то запрос выполняется в тестовом режиме. Счет будет иметь статус Оплачен без фактической оплаты и зачисления платежа. Уведомление об оплате по e-mail не отсылается. Если передан URL обработчика (параметр callback_url), на него будет отправлен результат.

Вывод результата

Если значение параметра form = N, то выводится результат сгенерированного платежа в JSON формате для дальнейшей обработки.

Success

Параметр	Значение	Описание
status	Строка	Return success
amount	Число	Сумма платежа в выбранной криптовалюте
invoice	Число	Внутренний номер счета используемый в системе
external_invoice	Строка	Внешний номер счета используемый в вашем магазине
link	Строка	Link to QR code
address	Строка	Сгенерированный адрес кошелька (BTC / USDT)
message	Строка	Описание счета, которое передавалось при генерации счета

Error

Параметр	Значение	Описание
status	Строка	Return error
message	Строка	Error message

Обработчик платежа

При получении оплаты по счету мы уведомляем сайт магазина о статусе оплаты, отправляя GET запрос на URL обработчика (параметр callback_url).

Параметр	Описание
id	Идентификатор из настроек платежного мерчанта
key	Ключ подтверждения из настроек платежного мерчанта
coin	В какой криптовалюте оплачен счет
currency	В какой валюте по стандарту ISO 4217 сгенерирован счет
invoice	Внутренний номер счета используемый в системе
external_invoice	Внешний номер счета используемый в вашем магазине
amount	Сумма полученного платежа в криптовалюте
amount_in_currency	Сумма по счету в валюте сгенерированного счета
message	Описание счета, которое передавалось при генерации счета
signature	Сформированная цифровая подпись

Пример формирования и проверки цифровой подписи на PHP

function getSignature($id, $currency, $amount_in_currency, $external_invoice, $secretKey) { $hashStr = $id.'{up}'.$currency.'{up}'.$amount_in_currency.'{up}'.$external_invoice.'{up}'.$secretKey; return hash('sha256', $hashStr); } $signature = getSignature($_GET["id"], $_GET["currency"], $_GET["amount_in_currency"], $_GET["external_invoice"], $secretKey); if ($_GET["signature"] != $signature) exit('Incorrect Digital Signature');

В обработчике платежей Вы должны сформировать цифровую подпись с использованием полученных переменных и проверить ее на соответствии с полученной цифровой подписью. В качестве значения secretKey используйте КЛЮЧ ДОСТУПА из настроек платежного мерчанта.

В обработчике платежей следует проверять полученный КЛЮЧ ПОДТВЕРЖДЕНИЯ с КЛЮЧОМ ПОДТВЕРЖДЕНИЯ из настроек платежного мерчанта.

Всегда проверяйте все полученные параметры на соответствии, а также IP адреса, с которых приходят запросы к обработчику платежей.

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

Применимо, если при формировании платежа указан URL обработчика (параметр callback_url)

В результате обработки GET запроса, содержащего данные о платеже, сайт магазина должен вернуть ответ с кодом 200 в виде строки:

• Ответ равен строке "ok" – это означает, что данные о платеже получены, оповещения по этому платежу более не требуются.
• Любые другие ответы – это будет означать, что данные магазином не получены и оповещение магазина будет продолжено.

Примечание: максимальное количество оповещений для получения успешного ответа от сайта магазина:

Примечание: попытка повторного оповещения будет предприниматься каждые 5 минут

Если ответ не будет равен строке "ok", первые 255 символов ответа магазина на запрос будут сохранены и доступны для просмотра в личном кабинете.

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

Рекомендуемые к размещению баннеры

<a href="https://cryptokick.app/index.php"><img src="https://cryptokick.app/images/banner_320x100.png" alt="Мы принимаем платежи в BTC / CryptoKick.app" height="50" width="160">

Вы можете менять размеры баннера параметрами height и width сохраняя пропорцию его общего размера

50x160 px