Создать подписку

Для создания подписки, пожалуйста, ознакомьтесь с общими инструкциями по созданию заказа: create order.

Обратите внимание

Платежи по подписке не работают для типа интеграции Direct.

Для включения платежей по подписке при интеграции с использованием JavaScript, пожалуйста, обратитесь к Пример встроенной интеграции с подпиской

Для создания подписки необходимо отправить дополнительные параметры в запросе на конечные точки /api/checkout/redirect, /api/checkout/token или /api/checkout/url.

{
  ...
  "subscription": "Y",
  "recurring_data": {
    "every": 5,
    "period": "day",
    "amount": 1000,
    "state": "Y",
    "readonly": "Y",
    "quantity": 100,
    "trial_period": "month",
    "trial_quantity": 1
  }
}

recurring_data properties description

Свойство Значение по умолчанию Тип                                                                              Описание
start_time Время одобрения платежа Дата в формате YYYY-MM-DD HH24:MI:SS Не указывайте, если вам необходимо произвести первый списание не с определенной даты, а с даты первоначального платежа клиента
end_time Время утверждения платежа + количество * период * every Дата в формате YYYY-MM-DD HH24:MI:SS Если не указано, она рассчитывается как дата последнего периода с учетом значений quantity, every и period
amount Нет значения по умолчанию, поле является обязательным для заполнения Integer(12) Сумма каждого запланированного списания. Сумма без разделителя. 100020 (UZS) означает 1000 сум и 20 тийинов
period Нет значения по умолчанию, свойство является обязательным day или week или month Частота, предоставляемая в качестве одного из доступных значений: day, week, month
every Нет значения по умолчанию, поле является обязательным для заполнения Integer(12) Количество дней, недель, месяцев между запланированными списаниями.
quantity Значение по умолчанию отсутствует, необходимо указать либо quantity, либо end_time Integer(6) Количество запланированных списаний
trial_period Пробная версия отключена по умолчанию day или week или month Количество дней, недель, месяцев пробного периода между первоначальным утверждением заказа и первым запланированным платежом
trial_quantity Нет значения по умолчанию, необходимо указать, если trial_period не пусто Integer(12) Количество пробных периодов, когда с клиента не взимается плата
state Y y или Y
n или N
hidden
shown_readonly
Свойство для отображения или скрытия формы с другими свойствами на странице оформления заказа

state parameter can accept the following values:

Значение Описание
y или y Включите календарь на странице оформления заказа и предоставьте клиенту возможность отключить его
n или N Отключите календарь на странице оформления заказа и позвольте клиенту включить его
hidden Включите календарь на странице оформления заказа, но не показывайте его клиенту
shown_readonly Включите календарь на странице оформления заказа и не позволяйте клиенту отключать его

Пример

curl -L 'https://pay.payme.uz/api/checkout/url' \
-H 'Content-Type: application/json' \
-d '{
  "request": {
    "order_id": "test_subscription5",
    "currency": "UZS",
    "merchant_id": 4056281,
    "order_desc": "Test payment",
    "amount": 100,
    "subscription": "Y",
    "recurring_data": {
      "every": 5,
      "period": "day",
      "amount": 1000,
      "state": "Y",
      "readonly": "Y",
      "quantity": 100,
      "trial_period": "month",
      "trial_quantity": 1
    },
    "signature": "4120ca8501b8003bb4860c6fc354c9e3ceb85d0c"
  }
}'
<?php
require_once '../configuration.php';
require_once SDK_ROOTPATH . '/../vendor/autoload.php';


//Payment subscription url scheme B(host-to-host)
try {
  //Minimal data set, all other required params will generated automatically
  $data = [
      'currency' => 'UZS',
      'amount' => 1000, // convert to 10.00$
      'recurring_data' => [
          'start_time' => '2021-12-24',
          'amount' => 1000,
          'every' => 30,
          'period' => 'day',
          'state' => 'y',
          'readonly' => 'y'
      ]

  ];
  //Call method to generate url
  \Flitt\Configuration::setApiVersion('2.0'); //allow only json, api protocol 2.0
  $url = Flitt\Subscription::url($data);
  //getting returned data
  ?>
  <!doctype html>
  <html lang="en-US">
  <head>
      <meta charset="UTF-8">
      <title>Generate subscription Payment Url</title>
      <style>
          table tr td, table tr th {
              padding: 10px;
          }
      </style>
  </head>
  <body>
  <table style="margin: auto;" border="1">
      <thead>
      <tr>
          <th style="text-align: center" colspan="2">Request Data</th>
      </tr>
      <tr>
          <th style="text-align: left"
              colspan="2"><?php printf("<pre>%s</pre>", json_encode(['request' => $data], JSON_PRETTY_PRINT)) ?></th>
      </tr>
      </thead>
      <tbody>
      <tr>
          <td>Payment id:</td>
          <td><?= $url->getData()['payment_id'] ?></td>
      </tr>
      <tr>
          <td>Стандартный ответ:</td>
          <td>
              <pre><?php print_r($url->getData()) ?></pre>
          </td>
      </tr>
      <tr>
          <td>Response subscription url:</td>
          <td><a href="<?php print_r($url->getUrl()) ?>"><?php print_r($url->getUrl()) ?></a></td>
      </tr>
      </tbody>
  </table>
  </body>
  </html>
  <?php
} catch (\Exception $e) {
  echo "Fail: " . $e->getMessage();
}
'use strict'

const FlittPay = require('../lib')
const util = require('../lib/util')

const flitt = new FlittPay(
  {
    merchantId: 4056281,
    secretKey: 'test'
  }
)
const date = new Date().toISOString().slice(0, 10)
const OrderId = util.generateOrderId()

const data = {
  order_desc: 'test order',
  order_id: OrderId,
  currency: 'UZS',
  amount: 1000,
  recurring_data:
  {
    every: 5,
    period: 'day',
    amount: 1000,
    start_time: date,
    state: 'y',
    Readonly: 'n'
  }
}
flitt.Subscription(data).then(data => {
  console.log(data)
}).catch((error) => {
  console.log(error)
})
const StopData = {
  order_id: OrderId,
  action: 'stop'
}

flitt.SubscriptionActions(StopData).then(data => {
  console.log(data)
}).catch((error) => {
  console.log(error)
})