Перейти к содержимому

Сохраненные карты и рекарринг

Управление сохраненными картами покупателей и рекуррентная оплата по привязке (bindingId) в АТОЛ Pay Ecom.

Карта сохраняется при оплате заказа, зарегистрированного с buyerId - идентификатором покупателя в вашей системе. После успешной оплаты карту можно использовать для оплаты в один клик и рекуррентных списаний.

Включение рекарринга

Рекарринг подключается по запросу в поддержку АТОЛ Pay; банк-эквайер может потребовать отдельное соглашение на платежи, инициированные продавцом (MIT). Технически режим включается флагом при регистрации платежа:

  • первый и каждый последующий заказ регистрируйте с recurring: true и buyerId (в этом режиме buyerId обязателен);
  • при recurring: true на платежной форме доступна только оплата картой, а сохранение карты обязательно - покупатель видит об этом уведомление;
  • после первой оплаты bindingId приходит в callback type: payment и в ответе метода статуса при статусах 1 и 11;
  • один bindingId действует для всех последующих заказов того же buyerId.

Аутентификация

Во всех методах передается либо заголовок Authorization: Bearer {token} (токен из ЛК: Настройки > API Токены), либо пара x-secret-id + x-signature (ID секрета из раздела Настройки > Секреты аутентификации и подпись запроса на его основе).

Получение списка сохраненных карт

http
GET /v1/ecom/payments/cards?buyerId={buyerId}&bankId={bankId}
ПараметрОписаниеОбяз.Формат
buyerIdID покупателя, переданный при регистрации заказаДаstring(255), query
bankIdID банка, для которого была сохранена карта (100 - Альфа-Банк, 700 - Т-Банк). По умолчанию - все банкиНетnumber, query
json
{
  "status": "success",
  "data": {
    "cards": [
      {
        "id": "c9a6df0e-1b8e-4f39-9b1a-0f6f2f6f7a10",
        "pan": "*4111",
        "bindingId": "8d0a3b6e-2c4f-4c7a-9f1e-5b2d7c8e9a01",
        "bankId": 100
      }
    ]
  }
}
Поле картыОписание
idID карты
panЗамаскированный номер карты (например, *4111)
bindingIdID привязки сохраненной карты - используется для рекарринга
bankIdID банка сохраненной карты (100 / 700)

Удаление карты

http
DELETE /v1/ecom/payments/cards/{cardId}

Удаляет сохраненную карту по ее id. Используйте, когда покупатель отвязывает карту в личном кабинете вашего сервиса.

Оплата через рекарринг

http
POST /v1/ecom/payments/{orderId}/recurring/pay

Списывает оплату по ранее сохраненной привязке карты без участия покупателя. Сначала зарегистрируйте новый заказ методом POST /v1/ecom/payments с recurring: true и тем же buyerId, затем вместо редиректа на платежную форму вызовите этот метод.

ПараметрОписаниеОбяз.Формат
orderIdID зарегистрированного заказаДаstring, path
bindingIdID привязки карты (из списка сохраненных карт или из data.bindingId метода статуса)Даstring
buyerEmailЭлектронная почта покупателяДаstring(64)
json
{
  "bindingId": "8d0a3b6e-2c4f-4c7a-9f1e-5b2d7c8e9a01",
  "buyerEmail": "test@example.ru"
}
json
{ "status": "success", "message": "OK" }

Результат списания приходит уже в синхронном ответе: status: "success" означает, что оплата прошла. Дублирующий callback type: payment придет с признаком mit: true - обрабатывать его отдельно не обязательно.

Завершение заказа по оплате по счету

http
POST /v1/ecom/payments/{orderId}/account/complete

Завершает заказ, оплаченный по выставленному счету (b2b-сценарий: платеж зарегистрирован с paymentMethods: [{ "paymentType": "account", "bankId": 0 }]). Вызывается после подтверждения поступления средств.

Поле ответаОписаниеФормат
data.orderIdИдентификатор заказаstring
data.statusЧисловой статус платежаnumber
json
{
  "status": "success",
  "data": {
    "orderId": "b0d84710-71f0-49ee-8219-f1b31a8d6770",
    "status": 1
  }
}