recurrentPayment

Рекуррентный (CoF) платеж

Запрос для осуществления рекуррентного (CoF) платежа

post/api/v1/payment_recurring

Request

  • Base URL: https://securesandbox.webpay.by
  • URL: https://securesandbox.webpay.by/api/v1/payment_recurring
  • Auth: none declared

Request body

wsb_storeidnumber required

Идентификатор магазина в системе WEBPAY. Данный идентификатор создается при регистрации в системе WEBPAY и высылается в письме.

wsb_order_numstring required

Уникальный идентификатор заказа, присваиваемый магазином. При оплате через ЕРИП значение поля не может начинаться на 0 (ноль).

wsb_currency_id'BYN' | 'USD' | 'EUR' | 'RUB' ISO 4271 required

Идентификатор валюты. Буквенный трехзначный код валюты согласно ISO 4271.

wsb_versionnumber required

Версия формы оплаты. Текущий номер версии: 2.

wsb_seedstring required

Случайная последовательность символов, участвующих в формировании электронной подписи заказа.

wsb_test0 | 1 required

Поле, указывающее на проведение тестовой оплаты.

1 — производить тестовую оплату; 0— производить реальную оплату.

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

wsb_totalnumber float required

Данное поле является вычисляемым. Значение этого поля является общей суммой оплаты заказа. Правило вычисления общей суммы:

wsb_total =wsb_invoice_item_quantity[0] * wsb_invoice_item_price[0] + wsb_invoice_item_quantity[1] * wsb_invoice_item_price[1] + ... wsb_invoice_item_quantity[n] * wsb_invoice_item_price[n] + wsb_tax + wsb_shipping_price - wsb_discount_price.

Оплата не будет произведена, если wsb_total и посчитанное значение товаров не будет совпадать. Покупателю будет отображена ошибка.

wsb_customer_idstring required

Уникальный идентификатор пользователя в Магазине, который был использован при инициирующей оплате.

wsb_operation_type'recurring_pay' required

Обозначает тип запроса.

recurring_pay — осуществить рекуррентный (CoF) платеж.

wsb_recurring_tokenstring required

Уникальный токен привязки карты к идентификатору пользователя в Магазине (wsb_customer_id). Значение данного поля соответствует значению поля recurring_token, переданного в нотификаторе после привязки карты.

wsb_signaturestring required

Контрольное значение (электронная подпись) заказа — результат выполнения функции SHA1 (для версии 2, см. поле wsb_version) либо MD5, если версия протокола не указана. Данное значение является hex-последовательностью.

Электронная подпись формируется для предотвращения изменений в форме платежа и должна присутствовать в каждой форме заказа. Все заказы без электронной подписи не будут рассматриваться системой WEBPAY.

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

Для формирования электронной подписи необходимо установить значение поля "Секретный ключ" в настройках Вашего биллинг-аккаунта.

  • wsb_seed

  • wsb_storeid

  • wsb_customer_id

  • wsb_order_num

  • wsb_test

  • wsb_currency_id

  • wsb_total

  • wsb_operation_type

  • wsb_recurring_token

  • secret_key

wsb_storestring

Название магазина, которое будет отображаться на форме оплаты. По умолчанию берется из настроек биллинг-аккаунта.

wsb_language_id'russian' | 'english'

Идентификатор языка формы оплаты.

wsb_redirect1

Идентификатор редиректа плательщика сразу же после осуществления платежа без вывода результата оплаты на платежной странице WEBPAY. Ознакомиться с описанием работы этого функционала можно здесь.

wsb_return_format 'json'

Формат ответа магазину после редиректа плательщика сразу же после осуществления платежа без вывода результата оплаты на платежной странице WEBPAY. Ознакомиться с описанием работы этого функционала можно здесь.

wsb_return_urlstring

URL адрес, на который возвращается покупатель в случае успешной оплаты.

К данному URL добавляются значения Идентификатора заказа (wsb_order_num) и номера транзакции (wsb_tid) в системе WEBPAY.

wsb_cancel_return_urlstring

URL адрес, на который возвращается покупатель в случае не успешной оплаты.

К данному URL добавляются значение Идентификатора заказа (wsb_order_num).

wsb_notify_urlstring

Данный URL вызывается вне зависимости от того, был ли переход по URL в поле wsb_return_urlили нет. Основное назначение этого URL оповестить сайт об успешной оплате в случае, если пользователь не нажал кнопку "Вернуться на сайт" на форме оплаты. По умолчанию берется из настроек биллинг-аккаунта.

Внимание! Отправка нотификаторов возможна только на стандартные порты: 80 (http), 443 (https), 8080 (http_alt), 8443(pcsync-https).

wsb_customer_namestring

Наименование получателя товара/услуги.

wsb_customer_addressstring

Адрес получателя товара/услуги.

wsb_service_datestring

Сроки предоставления товаров/услуг/работ.

wsb_taxnumber float

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

При оплате через ЕРИП это поле не учитывается (сумма налога добавляется к сумме единицы товара).

wsb_shipping_namestring

Поле определяющее наименование (способ) доставки.

wsb_shipping_pricenumber float

Поле, значением которого является сумма доставки, добавляемая к общей сумме заказа.

wsb_discount_namestring

Поле с описанием скидки.

wsb_discount_pricenumber float

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

wsb_order_tagstring

Метка заказа. Используется для отнесения заказа к определенной категории, группировки заказов или других нужд.

wsb_emailstring email

Электронный адрес покупателя.

Значение данного поля будет автоматически подставлено в соответствующее поле формы оплаты.

wsb_phonestring

Номер телефона покупателя.

wsb_order_contractstring

Номер договора с заказчиком услуги/плательщиком.

wsb_tab'erip' | 'cardPayment'

Определение активной вкладки с нужным платежным инструментом (оплата картой/ЕРИП).

wsb_startsesstimenumber

Регулирование времени отведенного на оплату со стороны Интернет-ресурса. Указывает, с какого времени производить отсчет отведенного для оплаты интервала времени (по умолчанию 20 минут). При передаче двух параметров, приоритетным считается wsb_startsessdatetime.

Например, транзакция начинается 22.10.2020 16:33:01, Интернет-ресурс хочет, чтобы платежная сессия действовала 7 мин., в POST запросе необходимо передать время 22.10.2020 16:20:01.

wsb_startsessdatetimestring DateTime

Регулирование времени отведенного на оплату со стороны Интернет-ресурса. Указывает, с какого времени производить отсчет отведенного для оплаты интервала времени (по умолчанию 20 минут). При передаче двух параметров, приоритетным считается wsb_startsessdatetime.

Например, транзакция начинается 22.10.2020 16:33:01, Интернет-ресурс хочет, чтобы платежная сессия действовала 7 мин., в POST запросе необходимо передать время 22.10.2020 16:20:01.

Example request

{
  "wsb_order_num": "ORDER-12345678",
  "wsb_currency_id": "BYN",
  "wsb_version": 2,
  "wsb_seed": "1242649174",
  "wsb_test": 1,
  "wsb_invoice_item_name": [
    "Товар 1",
    "Товар 2"
  ],
  "wsb_invoice_item_quantity": [
    2,
    1
  ],
  "wsb_invoice_item_price": [
    10,
    0.5
  ],
  "wsb_total": 31.4,
  "wsb_customer_id": "aA1217Zz",
  "wsb_operation_type": "recurring_pay",
  "wsb_recurring_token": "834836387",
  "wsb_signature": "d1a5110dc27d38a5fed50f98def59029ed5e1564",
  "wsb_store": "Название Вашего магазина",
  "wsb_language_id": "russian",
  "wsb_redirect": 1,
  "wsb_return_format ": "json",
  "wsb_return_url": "http://yoursiteurl.com/success.php",
  "wsb_cancel_return_url": "http://yoursiteurl.com/cancel.php",
  "wsb_notify_url": "http://yoursiteurl.com/notify.php",
  "wsb_customer_name": "Иванов Петр Петрович",
  "wsb_customer_address": "Минск ул. Шафарнянская д.11 оф.54",
  "wsb_service_date": "Доставка до 1 января 2022 года",
  "wsb_tax": 10.5,
  "wsb_shipping_name": "Стоимость доставки",
  "wsb_shipping_price": 0.98,
  "wsb_discount_name": "Скидка на товар",
  "wsb_discount_price": 0.58,
  "wsb_order_tag": "Договор №152/12-1 от 12.01.19",
  "wsb_email": "ivanov@test.by",
  "wsb_phone": "375291234567",
  "wsb_order_contract": "Договор №152/12-1 от 12.01.19",
  "wsb_tab": "cardPayment",
  "wsb_startsessdatetime": "2020-10-22T16:20:01+03:00"
}

Response

Payment response

OR

Example response

{
  "data": {
    "currency_id": "BYN",
    "customer_id": "aA1217Zz",
    "payment_method": "cc",
    "site_order_id": "ORDER-12345678",
    "operation_type": "recurring_pay",
    "order_id": "307139115",
    "terminal": "99995551",
    "transaction_id": "834836387",
    "recurring_token": "834836387",
    "payment_type": 10,
    "rrn": "257885184293",
    "rc": "W0001(00)",
    "rc_text": "Successfully completed",
    "approval": "257885",
    "card": "434179xxxxxx0051"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.