Интеграция с платёжными системами через REST API

• Создание платежей и автоплатежей
• Общие принципы работы автоплатежей

Создание платежей и автоплатежей

С помощью REST API вы можете работать с платежами через внешние платёжные системы (ВПС):

• ЮKassa — создавать платежи, подключать автоплатежи,
• Точка Банк — создавать платежи, подключать автоплатежи,
• Ингосстрах Банк — создавать платежи.

Используйте метод POST /eps_payments — endpoint для создания платежа через ВПС.

{ 
  "eps_uuid": "text", 
  "amount": 100, 
  "agreement_param_id": 11, 
  "agreement_param_value": "agrm_id", 
  "eps_params": [ 
    { 
      "name": "name", 
      "value": "value" 
    } 
  ] 
}

Описание параметров

Параметры различаются в зависимости от платёжной системы.

{ 
  'eps_uuid': 'yookassa', 
  'amount': 1.00, 
  'agrm_param_id': 5, 
  'agrm_param_value': 'agrm_number', 
  'eps_params': [ 
    {"name": "confirmation_type", "value": "redirect"}, 
    {"name": "confirmation_return_url", "value": "https://example.com"}, 
    {"name": "email", "value": "example@example.ru"}, 
    {"name": "phone", "value": "79999999999"}, 
    {"name": "comment", "value": "Comment"}, 
  ] 
}

{ 
  'eps_uuid': 'yookassa', 
  'amount': 2.00, 
  'agrm_param_id': 11, 
  'agrm_param_value': '2', 
  'eps_params': [ 
    {"name": "confirmation_type", "value": "redirect"}, 
    {"name": "confirmation_return_url", "value": "https://example.com"}, 
    {"name": "email", "value": "example@example.ru"}, 
    {"name": "phone", "value": "79999999999"}, 
    {"name": "comment", "value": "Comment"}, 
    {"name": "save_payment_method", "value": True}, 
    {"name": "enable_autopayments", "value": True}, 
    {"name": "preferred_method", "value": True} 
  ] 
}

{"name": "save_payment_method", "value": True},
{"name": "enable_autopayments", "value": True},
{"name": "preferred_method", "value": True}

{ 
  'eps_uuid': 'tochka', 
  'amount': 1.00, 
  'agrm_param_id': 5, 
  'agrm_param_value': 'agrm_number', 
  'eps_params': [ 
    {"name": "confirmation_return_url", "value": "https://www.example.com/"}, 
    {"name": "return_url_fail", "value": "https://www.example_fail.com/"}, 
    {"name": "email", "value": "example@example.ru"}, 
    {"name": "phone", "value": "79999999999"}, 
    {"name": "name", "value": "Name"}, 
  ] 
}

{ 
  'eps_uuid': 'tochka', 
  'amount': 1.00, 
  'agrm_param_id': 11, 
  'agrm_param_value': '2', 
  'eps_params': [ 
    {"name": "confirmation_return_url", "value": "https://www.example.com/"}, 
    {"name": "return_url_fail", "value": "https://www.example_fail.com/"}, 
    {"name": "email", "value": "example@example.ru"}, 
    {"name": "phone", "value": "79999999999"}, 
    {"name": "name", "value": "Name"}, 
    {"name": "comment", "value": "Comment"}, 
    {"name": "is_autopayment", "value": True} 
  ] 
} 

{ 
  'eps_uuid': 'ingosstrakh', 
  'amount': 1.00, 
  'agrm_param_id': 11, 
  'agrm_param_value': '2', 
  'eps_params': [ 
  {"name": "return_url", "value": "https://example.com"}, 
  ] 
} 

С полной документацией API LBX можно ознакомиться здесь.

Общие принципы работы автоплатежей

• Как определить, подключён ли автоплатёж
• Когда и как списываются автоплатежи
• Как отключить автоплатёж
• Жизненный цикл автоплатежа

Как определить, подключён ли автоплатёж

Чтобы получить действующие платёжные методы, используйте GET /payment_methods с переданным параметром 'status_list': [2].

Если автоплатёж подключён, для платёжного метода будет возвращаться enable_auto_payments = true.

Если автоплатежи включены:

• в административном интерфейсе LBX в карточке пользователя отображается сохранённый способ оплаты,
• средства списываются с клиентского договора согласно правилам списаний.

Когда и как списываются автоплатежи

1. За N дней до того, как для подписки наступит новый период тарификации

   Например, если в подписке указан период тарификации 1 месяц, то момент списания автоплатежа наступает за N дней до начала нового месяца.

   По умолчанию N = 1. Чтобы изменить этот параметр, обратитесь в техническую поддержку LBX.

   Как происходит списание: согласно сохранённому методу оплаты. Сумма — рекомендованный платёж для договора. Если рекомендованный платёж равен 0, то списания по автоплатежу не будет.

2. Когда подписка переходит в финансовую блокировку

   При наступлении финансовой блокировки система пытается списать автоплатёж с договора, к которому относится подписка.

   Как происходит списание: согласно сохранённому методу оплаты. Сумма — рекомендованный платёж для договора. Если рекомендованный платёж равен 0, то списания по автоплатежу не будет.

3. Каждый час в 30 минут:

   • для договоров с отрицательным балансом,
   • для договоров, на которых есть подписки, ожидающие активации,
   • для договоров, на которых есть подписки в финансовой блокировке.

   Например, в 05:30, 06:30 и так далее.

   Как происходит списание: согласно сохранённому методу оплаты. Сумма — рекомендованный платёж для договора. Если рекомендованный платёж равен 0, то списания по автоплатежу не будет.

Как отключить автоплатёж

Для отключения метода оплаты и автоплатежа воспользуйтесь методом DELETE /payment_methods/{payment_method_id}.

Жизненный цикл автоплатежа

1. Автоплатёж создан через виджет или через API.
2. Автоплатёж регулярно списывается с клиентского договора — для продления или разблокировки подписок. Используется сохранённый метод оплаты.
3. Автоплатёж отключён в карточке клиента или через API.