rbs-ajax v0.1.3

Библиотека для работы с REST API шлюза РБС

NPM пакет

Установка

npm i rbs-ajax

Использование

import payAjax from 'rbs-ajax'

const options = { contextLevel: '../' };
const payXhr = payAjax(options);
payXhr.getSessionStatus({ mdOrder: MDORDER });

document.addEventListener('PAY.SESSION_STATUS', function(data) {
  // Получили данные из getSessionStatus
  console.log(data);
});
document.addEventListener('PAY.ERROR', function(data) {
  // Что-то пошло не так
  console.log(data);
});

В основе работы библиотеки лежат события.

Тип события зависит от вызванного api метода и результата его выполнения. В случае успешного выполнения AJAX запроса вызывается событие (на document) с именем doneEventName. В случае неудачной выполнения — событие с именем failEventName (по умолчанию у всех методов: "PAY.ERROR").

В data будет передана вся информация приходящая от сервера или информация об ошибке.

payAjax

Функция-обертка. В качестве аргумента принимает настройки контекста.

Методы

Обертка payAjax содержит методы через которые можно обратиться к REST API:

• getSessionStatus
• sendPayment
• sendBindingPayment
• sendGooglePay
• deleteMerchantCard
• getFee
• sendPaymentOtherWays
• getFinishInfo

Аргументы

Каждый метод принимает 2 аргумента: params и options.

params

Объект содержащий поля для запроса. Для каждого метода они свои.

options

Объект с настройками метода. Может содержать 2 поля:

• doneEventName — название события при успешном заверешении AJAX запроса
• failEventName — название события при неудачном завершении AJAX запроса.

ВНИМАНИЕ! По умолчанию у всех методов failEventName называется PAY.ERROR.

Есть возможность установить свои значения имен событий. Например:

payXhr.getSessionStatus(
  { mdOrder: "129bd2e3-9118-7ab9-129b-d2e30007cc4a" },
  { doneEventName: "EVENT.SESSION_STATUS", failEventName: "EVENT.FAIL"}
)

getSessionStatus

doneEventName: 'PAY.SESSION_STATUS'

sendPayment

doneEventName: 'PAY.SEND_PAYMENT'

sendBindingPayment

doneEventName: 'PAY.BINDING_SEND_PAYMENT'

sendGooglePay

doneEventName: 'PAY.GOOGLEPAY'

deleteMerchantCard

doneEventName: 'PAY.DELETE_MERCHANT_BINDING'

getFee

doneEventName: 'PAY.FEE'

sendPaymentOtherWays

doneEventName: 'PAY.OTHER_WAY'

getFinishInfo

doneEventName: 'PAY.FINISH_INFO'

3DS 2.0

Принцип работы

Модуль handle3ds автоматически инициализируется в getSessionStatus. По необходимости в рамках текущей страницы создает необходимые формы в фоне, передает, получает и хранит нужные параметры, а также делает повторные запросы методов оплаты.

Разработчику остается только вызвать редирект на ACS в нужном месте его кода. Модуль также создаст нужную форму в фоне на текущей странице и переведет пользователя на acsUrl.

Для редиректа в acs необходимо добавить вызов redirectToAcs в соответствующие listner'ы api методов.

ВНИМАНИЕ! Не забудьте добавить обработку перехода в ACS в методе getSessionStatus. После его вызова в ответе может быть acsUrl.

Поддержка

Поддерживается в следующих методах api:

• getSessionStatus
• sendPayment
• sendBindingPayment
• sendGooglePay

Пример

import { getHandler3DS } from 'rbs-ajax/handle3ds';

// ...

document.addEventListener(
  'PAY.SEND_PAYMENT PAY.BINDING_SEND_PAYMENT PAY.GOOGLEPAY',
  function({ detail }) {
    // В detail вся информация
    const data = detail;

    // Используем редирект в первую очередь
    if ('redirectUrl' in data) {
      window.location = data.redirectUrl;
    }

    // Перенаправление пользователя в ACS
    if ('acsUrl' in data && data.acsUrl !== null) {
      // Вызов метода из модуля handle3ds (rbs-ajax)
      getHandler3DS().redirectToAcs(data);
    }

    // ... другой полезный код
  }
);