Создать заказ¶
Создайте заказ — именно с этого начинается большинство интеграций.
Конечные точки для создания заказа
Страница оформления заказа Paymeс URL-адресом оформления заказа¶
Payme hosted checkout page with checkout url
POST /api/checkout/url
Эта точка API ожидает POST-запрос в формате JSON с параметрами запроса.
Обычный ответ будет содержать параметр checkout_url — URL-адрес страницы оформления заказа, на которую должен быть перенаправлен плательщик.
Примеры запрос/ответ
curl -i -X POST \
-H "Content-Type:application/json" \
-d \
'{
"request": {
"server_callback_url": "http://myshop/callback/",
"order_id": "TestOrder2",
"currency": "UZS",
"merchant_id": 4056281,
"order_desc": "Test payment",
"amount": 1000,
"signature": "91ea7da493a8367410fe3d7f877fb5e0ed666490"
}
}' \
'https://pay.payme.uz/api/checkout/url'
{
"response":{
"response_status":"success",
"checkout_url":"https://pay.payme.uz/merchants/5ad6b888f4becb0c33d543d54e57d86c/default/index.html?token=8a09f9d937f43ad6fb40d6b40282d7277a48582a"
}
}
{
"response":{
"response_status":"failure",
"error_message":"Parameter `amount` is mandatory",
"error_code":"1008"
}
}
Встроенная страница оформления заказа продавца с токеном оплаты¶
Эту точку API предпочтительно использовать для мобильных приложений, которые обрабатывают:
Merchant embedded checkout page with payment token
POST /api/checkout/token
Эта точка API ожидает POST-запрос в формате JSON с параметрами запроса.
Разница заключается в том, что обычный ответ будет содержать параметр token — токен платежа, который можно далее использовать в JavaScript и мобильных SDK.
Примеры запрос/ответ
curl -i -X POST \
-H "Content-Type:application/json" \
-d \
'{
"request": {
"server_callback_url": "http://myshop/callback/",
"order_id": "TestOrder2",
"currency": "UZS",
"merchant_id": 4056281,
"order_desc": "Test payment",
"amount": 1000,
"signature": "91ea7da493a8367410fe3d7f877fb5e0ed666490"
}
}' \
'https://pay.payme.uz/api/checkout/token'
{
"response": {
"token": "9f0124be2b72333fb0e809f82c8f7e4eaeb6ec6e",
"response_status": "success"
}
}
{
"response":{
"response_status":"failure",
"error_message":"Parameter `amount` is mandatory",
"error_code":"1008"
}
}
Страница оформления заказа Paymeс перенаправлением¶
Payme hosted checkout page with redirect
POST /api/checkout/redirect
Эта точка API ожидает POST-запрос в формате JSON с параметрами запроса.
Обычный ответ будет содержать HTTP-код 302 Found и URL-адрес Location, на который браузер плательщика автоматически перенаправит его.
В случае ошибки страница /api/checkout/redirect будет содержать HTML-контент с ID запроса, 4-значным кодом ошибки 2XXX и локализованным описанием ошибки.
Примеры запрос/ответ
<form method="POST" action="https://pay.payme.uz/api/checkout/redirect">
<input type="text" class="form-input" id="order_id" name="order_id" value="test8651190566">
<input type="text" class="form-input" id="merchant_id" name="merchant_id" value="4056281">
<input type="text" class="form-input" id="order_desc" name="order_desc" value="Test order">
<input type="text" class="form-input" id="amount" name="amount" value="200">
<input type="text" class="form-input" id="currency" name="currency" value="UZS">
<input type="text" class="form-input" id="response_url" name="response_url" value="https://site.com/test/responsepage/">
<input type="text" class="form-input" id="signature" name="signature" value="31c758a76a5dae87f087df171092684130a12bf3">
<button type="submit">Pay</button>
</form>
Request URL: https://pay.payme.uz/api/checkout/redirect/
Request Method: POST
Status Code: 302 Found
Location: https://pay.payme.uz/merchants/5ad6b888f4becb0c33d543d54e57d86c/default/index.html?token=8a09f9d937f43ad6fb40d6b40282d7277a48582a
Пример
$ curl -L 'https://pay.payme.uz/api/checkout/url' \
-H 'Content-Type: application/json' \
-d '{
"request": {
"version": "1.0.1",
"order_id": "test_order_id_132412412",
"currency": "UZS",
"merchant_id": 4056281,
"order_desc": "Test order",
"amount": 10025,
"response_url": "https://example.com/thankyoupage",
"server_callback_url": "https://example.com/api/callback",
"signature": "7f52380cefaf3cb793746e2deeb56cf7cd75d532"
}
}'
{
"response": {
"checkout_url": "https://pay.payme.uz/merchants/5ad6b888f4becb0c33d543d54e57d86c/default/index.html?token=03fb1c589f8fcabc80f609c70af541fc636df112",
"payment_id": "805230052",
"response_status": "success"
}
}
Установка Composer
composer require flittpayments/php-sdk
git clone -b master https://github.com/flittpayments/php-sdk.git
Простой старт
require 'vendor/autoload.php';
\Flitt\Configuration::setMerchantId(4056281);
\Flitt\Configuration::setSecretKey('test');
$checkoutData = [
'currency' => 'UZS',
'amount' => 1000
];
$data = \Flitt\Checkout::url($data);
$url = $data->getUrl();
//$data->toCheckout() - redirect to checkout
Пример
cd ~/php-sdk
php -S localhost:8000
Простой старт Включите файл «checkout.js»
<script src="https://pay.payme.uz/future/checkout-vue/checkout.js"></script>
<link rel="preload" href="https://pay.payme.uz/future/checkout-vue/checkout.css" as="style">
<link href="https://pay.payme.uz/future/checkout-vue/checkout.css" rel="stylesheet">
<div id="checkout-container"></div>
var Options = {
options: {
methods: ["card"],
methods_disabled: [],
card_icons: ["mastercard", "visa"],
theme: {
type: "light",
preset: "reset"
}
},
params: {
merchant_id: 4056281,
currency: "UZS",
amount: 500,
order_desc: "Demo order"
},
css_variable: {
main: '#7d8ff8',
card_bg: '#353535',
card_shadow: '#9ADBE8'
}
};
checkout("#checkout-container", Options);
1. Установка
Node Если в вашем проекте используется Npm , вы можете добавить зависимость @flittpayments/js-sdk в файл package.json с помощью следующей команды:
npm i --save @flittpayments/js-sdk
или добавьте зависимость вручную:
{
"dependency": {
"@flittpayments/js-sdk":"^2.0"
}
}
Ручная установка Если вы не используете NodeJS, вы можете загрузить последнюю версию. Или клонировать с GitHub последнюю версию для разработчиков
git clone git@github.com:flittpayments/js-sdk.git
Быстрый старт
<script src="https://cdn.jsdelivr.net/npm/@flittpayments/js-sdk"></script>
Базовый шаблон
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no">
</head>
<body>
<script src="https://cdn.jsdelivr.net/npm/@flittpayments/js-sdk"></script>
<script>
$checkout('Api').scope(function(){
this.request('api.checkout.form','request', { Parameters } ).done(function(model){
model.sendResponse();
console.log(model.attr('order'));
}).fail(function(model){
console.log(model.attr('error'));
});
});
</script>
</body>
</html>
Пример базового шаблона: https://github.com/flittpayments/js-sdk#basic-template
3. Создайте заказ с использованием схемы интеграции C для JavaScript SDK.
Добавьте в свой запрос параметры required_rectoken=Y и server_callback_url для получения токена повторяющихся платежей (если вы планируете осуществлять повторяющиеся платежи)
в обратном вызове сервера (параметр rectoken).
curl -i -X POST \
-H "Content-Type:application/json" \
-d \
'{
"request": {
"server_callback_url": "http://myshop/callback/",
"order_id": "TestOrder2",
"currency": "UZS",
"merchant_id": 4056281,
"order_desc": "Test payment",
"amount": 1000,
"signature": "91ea7da493a8367410fe3d7f877fb5e0ed666490"
}
}' \
'https://pay.payme.uz/api/checkout/token'
Документация: https://docs.payme.uz/docs/page/3/?la=en#chapter-3-6-c. Сохраните параметр токена host-to-host из ответа.
4. Загрузите токен host-to-host из шага 3 в форму с данными карты.
{
"payment_system":"card",
"token":"host-to-host generated token",
"card_number":"16/19-digits number",
"expiry_date":"Supported formats: MM/YY, MM/YYYY, MMYY, MMYYYY",
"cvv2":"3-digits number"
}
из формы карты в платежный шлюз с помощью JavaScript API $checkout('Api'). https://github.com/flittpayments/js-sdk#host-to-host-token
5. Используйте обратные вызовы JavaScript .on('success') и .on('error') для получения результата обработки платежа.
success – заказ одобрен, сумма будет списана error – заказ отклонен, сумма не будет списана
model.attr('error.message') будет содержать локализованное сообщение об ошибке в случае отказа в оплате. Информация о статусе и деталях заказа будет возвращена в model.data.order.order_data
Пример обратного вызова в JavaScript:
console.log('success',JSON.stringify(model.attr("order").order_data));
{
"response": {
"rrn": "111111111111",
"masked_card": "444455XXXXXX1111",
"sender_cell_phone": "",
"sender_account": "",
"currency": "UZS",
"fee": "",
"reversal_amount": "0",
"settlement_amount": "0",
"actual_amount": "200",
"response_description": "",
"sender_email": "test@test.com",
"order_status": "approved",
"response_status": "success",
"order_time": "13.07.2024 01:23:59",
"actual_currency": "UZS",
"order_id": "test33694502191",
"tran_type": "purchase",
"eci": "5",
"settlement_date": "",
"payment_system": "card",
"approval_code": "123456",
"merchant_id": 4056281,
"settlement_currency": "",
"payment_id": 805243692,
"card_bin": 444455,
"response_code": "",
"card_type": "VISA",
"amount": "200",
"signature": "b7884b5c4906956fbac4d20390388d913a78c0b0",
"product_id": "",
"merchant_data": "Test merchant data",
"rectoken": "",
"rectoken_lifetime": "",
"verification_status": "",
"parent_order_id": "",
"fee_oplata": "0",
"additional_info": "{\"capture_status\": null, \"capture_amount\": null, \"reservation_data\": \"{}\", \"transaction_id\": 1994930931, \"bank_response_code\": null, \"bank_response_description\": null, \"client_fee\": 0.0, \"settlement_fee\": 0.0, \"bank_name\": null, \"bank_country\": null, \"card_type\": \"VISA\", \"card_product\": \"empty_visa\", \"card_category\": null, \"timeend\": \"13.07.2024 01:24:08\", \"ipaddress_v4\": \"178.54.60.26\", \"payment_method\": \"card\", \"version_3ds\": 1, \"is_test\": true}",
"response_signature_string": "**********|200|UZS|{\"capture_status\": null, \"capture_amount\": null, \"reservation_data\": \"{}\", \"transaction_id\": 1994930931, \"bank_response_code\": null, \"bank_response_description\": null, \"client_fee\": 0.0, \"settlement_fee\": 0.0, \"bank_name\": null, \"bank_country\": null, \"card_type\": \"VISA\", \"card_product\": \"empty_visa\", \"card_category\": null, \"timeend\": \"13.07.2024 01:24:08\", \"ipaddress_v4\": \"178.54.60.26\", \"payment_method\": \"card\", \"version_3ds\": 1, \"is_**********\": true}|200|123456|444455|VISA|UZS|5|0|444455XXXXXX1111|Test merchant data|4056281|**********33694502191|approved|13.07.2024 01:23:59|805243692|card|success|0|111111111111|**********@**********.com|0|purchase"
}
}
Пример: https://jsfiddle.net/flitt/on8ydsgq/1/
6. Обработайте окончательный ответ, полученный в виде обратных вызовов сервера, в файле server_callback_url.
Формат окончательного ответа: Ответ
Установка SDK доступен на NuGet
Простой старт
using FlittSDK;
using FlittSDK.Checkout;
Config.MerchantId = 4056281;
Config.SecretKey = "test";
var req = new CheckoutRequest {
order_id = Guid.NewGuid().ToString("N"),
amount = 100000,
order_desc = "checkout json demo",
currency = "UZS"
};
var resp = new Url().Post(req);
if (resp.Error == null) {
string url = resp.checkout_url;
}
Для проверки примера: вы можете использовать встроенный сервер ISS http://localhost:7777/
Установка
npm install @flittpayments/flitt-node-js-sdk
Ручная установка
git clone -b master https://github.com/flittpayments/node-js-sdk.git
Простой старт
const FlittPay = require('@flittpayments/flitt-node-js-sdk')
const flitt = new FlittPay(
{
merchantId: 4056281,
secretKey: 'test'
}
)
const requestData = {
order_id: 'Your Order Id',
order_desc: 'test order',
currency: 'UZS',
amount: '1000'
}
flitt.Checkout(requestData).then(data => {
console.log(data)
}).catch((error) => {
console.log(error)
})
Установка
pip install flittpayments
Простой старт
from flittpayments import Api, Checkout
api = Api(merchant_id=4056281,
secret_key='test')
checkout = Checkout(api=api)
data = {
"currency": "USD",
"amount": 10000
}
url = checkout.url(data).get('checkout_url')
