Developer - Api Documentation

Введение

В этом разделе описывается Rommy API платежного шлюза.


Rommy API легко реализовать в программном обеспечении для вашего бизнеса. Наш API хорошо форматирует URL-адреса, принимает запросы cURL, возвращает ответы JSON.

Вы можете использовать API в тестовом режиме, который не влияет на ваши текущие данные. Ключ API используется для аутентификации запроса и определяет, является запрос действительным платежом или нет. Для тестового режима просто используйте URL-адрес изолированной среды, а в случае реального режима используйте текущий URL-адрес из раздела Инициировать Платеж .

Поддерживаемые валюты

В этом разделе описываются поддерживаемые валюты Rommy


Rommy allows to make transaction with below currencies. Any new currency may update in future.

Название валюты Символ валюты Код валюты
United States Dollar $ USD
Russian Ruble RUB
euro EUR
Bitcoin BTC
Tether USDT

Получить ключ API

В этом разделе описывается, как вы можете получить свой ключ API.


Войдите в свой аккаунт Rommy торговый счет. If you don't have any ? Нажмите Здесь

Следующий шаг - найти Ключ API меню на боковой панели вашей информационной панели. Щелкните меню.

Ключи API можно найти там, где Открытый ключ и Секретный ключ. Используйте эти ключи для инициирования запроса API. Каждый раз вы можете генерировать новый ключ API, нажимая Сгенерировать Ключ API кнопка. Помните, что ни с кем не делитесь этими ключами.

Инициировать Платеж

В этом разделе описывается процесс инициализации платежа.


Чтобы инициировать платеж, следуйте приведенному в примере коду и будьте осторожны с параметрами. Вам нужно будет отправить запрос с помощью следующих конечных точек API.

Конечная Точка в реальном времени: https://roomy.cash/payment/initiate

Конечная Точка теста: https://roomy.cash/sandbox/payment/initiate

Почта в тестовом режиме: test_mode@mail.com

Проверочный код Тестового режима: 222666

Способ запроса: POST

Отправьте запрос в конечную точку со следующими параметрами, приведенными ниже.

Имя параметра Тип параметра Описание
public_key string (50) Требуемый Ваш открытый ключ API
identifier string (20) Требуемый Идентификатор в основном предназначен для идентификации платежа с вашей стороны
currency string (4) Требуемый Код валюты должен быть написан заглавными буквами. например, USD, EUR
amount decimal Требуемый Сумма платежа.
details string (100) Требуемый Детали вашего платежа или транзакции.
ipn_url string Требуемый URL-адрес уведомления о мгновенном платеже.
success_url string Требуемый URL перенаправления успешного платежа.
cancel_url string Требуемый URL-адрес перенаправления для отмены платежа.
site_logo string/url Требуемый Логотип вашего бизнес-сайта.
checkout_theme string Необязательный Тема формы оформления заказа темная / светлая. Тема по умолчанию светлая
customer_name string (30) Требуемый Имя клиента.
customer_email string (30) Требуемый Действительный E-mail
Пример PHP-кода
<?php
    $parameters = [
        'identifier' => 'DFU80XZIKS',
        'currency' => 'USD',
        'amount' => 100.00,
        'details' => 'Purchase T-shirt',
        'ipn_url' => 'http://example.com/ipn_url.php',
        'cancel_url' => 'http://example.com/cancel_url.php',
        'success_url' => 'http://example.com/success_url.php',
        'public_key' => 'your_public_key',
        'site_logo' => 'https://roomy.cash/assets/images/logoIcon/logo.png',
        'checkout_theme' => 'dark',
        'customer_name' => 'John Doe',
        'customer_email' => 'john@mail.com',

    ];

    //live end point
    $url = "https://roomy.cash/payment/initiate";

    //test end point
    $url = "https://roomy.cash/sandbox/payment/initiate";

    $ch = curl_init();
    curl_setopt($ch, CURLOPT_SSL_VERIFYHOST, false);
    curl_setopt($ch, CURLOPT_URL, $url);
    curl_setopt($ch, CURLOPT_POSTFIELDS,  $parameters);
    curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
    $result = curl_exec($ch);
    curl_close($ch);

    //$result contains the response back.
?>
Примеры ответов
//Error Response.
{
    "error": "true",
    "message": "Invalid api key"
}

//Success Response.
{
    "success": "ok",
    "message": "Payment Initiated. Redirect to url.",
    "url":"http://example.com/initiate/payment/checkout?payment_id=eJSAASDxdrt4DASDASVNASJA7893232432cvmdsamnvASF"
}

Подтвердите Платеж и IPN

В этом разделе описывается процесс получения мгновенного уведомления о платеже.


Чтобы инициировать платеж, следуйте приведенному в примере коду и будьте осторожны с параметрами. Вам нужно будет отправить запрос с помощью следующих конечных точек API.

Конечная Точка: IPN-адрес вашего бизнес-приложения.

Способ запроса: POST

Ниже вы получите следующие параметры.

Имя параметра Описание
status Статус платежа.
identifier Идентификатор в основном предназначен для идентификации платежа с вашей стороны.
signature Хэш-подпись для подтверждения вашего платежа с вашей стороны.
data Данные содержат некоторую базовую информацию о сборах, сумме, валюте, идентификаторе платежной транзакции и т.д.
Пример PHP-кода
<?php
    //Receive the response parameter
    $status = $_POST['status'];
    $signature = $_POST['signature'];
    $identifier = $_POST['identifier'];
    $data = $_POST['data'];

    // Generate your signature
    $customKey = $data['amount'].$identifier;
    $secret = 'YOUR_SECRET_KEY';
    $mySignature = strtoupper(hash_hmac('sha256', $customKey , $secret));

    $myIdentifier = 'YOUR_GIVEN_IDENTIFIER';

    if($status == "success" && $signature == $mySignature &&  $identifier ==  $myIdentifier){
        //your operation logic
    }
?>

We may use cookies or any other tracking technologies when you visit our website, including any other media form, mobile website, or mobile application related or connected to help customize the Site and improve your experience. Узнать больше

Разрешить