Сохраненные карты и рекарринг
Управление сохраненными картами покупателей и рекуррентная оплата по привязке (bindingId) в АТОЛ Pay Ecom.
Карта сохраняется при оплате заказа, зарегистрированного с buyerId -
идентификатором покупателя в вашей системе. После успешной оплаты карту можно
использовать для оплаты в один клик и рекуррентных списаний.
Включение рекарринга
Рекарринг подключается по запросу в поддержку АТОЛ Pay; банк-эквайер может потребовать отдельное соглашение на платежи, инициированные продавцом (MIT). Технически режим включается флагом при регистрации платежа:
- первый и каждый последующий заказ регистрируйте с
recurring: trueиbuyerId(в этом режимеbuyerIdобязателен); - при
recurring: trueна платежной форме доступна только оплата картой, а сохранение карты обязательно - покупатель видит об этом уведомление; - после первой оплаты
bindingIdприходит в callbacktype: paymentи в ответе метода статуса при статусах1и11; - один
bindingIdдействует для всех последующих заказов того жеbuyerId.
Аутентификация
Во всех методах передается либо заголовок Authorization: Bearer {token}
(токен из ЛК: Настройки > API Токены), либо пара x-secret-id +
x-signature (ID секрета из раздела Настройки > Секреты аутентификации
и подпись запроса на его основе).
Получение списка сохраненных карт
GET /v1/ecom/payments/cards?buyerId={buyerId}&bankId={bankId}| Параметр | Описание | Обяз. | Формат |
|---|---|---|---|
buyerId | ID покупателя, переданный при регистрации заказа | Да | string(255), query |
bankId | ID банка, для которого была сохранена карта (100 - Альфа-Банк, 700 - Т-Банк). По умолчанию - все банки | Нет | number, query |
{
"status": "success",
"data": {
"cards": [
{
"id": "c9a6df0e-1b8e-4f39-9b1a-0f6f2f6f7a10",
"pan": "*4111",
"bindingId": "8d0a3b6e-2c4f-4c7a-9f1e-5b2d7c8e9a01",
"bankId": 100
}
]
}
}| Поле карты | Описание |
|---|---|
id | ID карты |
pan | Замаскированный номер карты (например, *4111) |
bindingId | ID привязки сохраненной карты - используется для рекарринга |
bankId | ID банка сохраненной карты (100 / 700) |
Удаление карты
DELETE /v1/ecom/payments/cards/{cardId}Удаляет сохраненную карту по ее id. Используйте, когда покупатель отвязывает
карту в личном кабинете вашего сервиса.
Оплата через рекарринг
POST /v1/ecom/payments/{orderId}/recurring/payСписывает оплату по ранее сохраненной привязке карты без участия
покупателя. Сначала зарегистрируйте новый заказ методом
POST /v1/ecom/payments
с recurring: true и тем же buyerId, затем вместо редиректа на платежную
форму вызовите этот метод.
| Параметр | Описание | Обяз. | Формат |
|---|---|---|---|
orderId | ID зарегистрированного заказа | Да | string, path |
bindingId | ID привязки карты (из списка сохраненных карт или из data.bindingId метода статуса) | Да | string |
buyerEmail | Электронная почта покупателя | Да | string(64) |
{
"bindingId": "8d0a3b6e-2c4f-4c7a-9f1e-5b2d7c8e9a01",
"buyerEmail": "test@example.ru"
}{ "status": "success", "message": "OK" }Результат списания приходит уже в синхронном ответе: status: "success"
означает, что оплата прошла. Дублирующий callback
type: payment придет с признаком mit: true - обрабатывать его отдельно не
обязательно.
Завершение заказа по оплате по счету
POST /v1/ecom/payments/{orderId}/account/completeЗавершает заказ, оплаченный по выставленному счету (b2b-сценарий: платеж
зарегистрирован с paymentMethods: [{ "paymentType": "account", "bankId": 0 }]).
Вызывается после подтверждения поступления средств.
| Поле ответа | Описание | Формат |
|---|---|---|
data.orderId | Идентификатор заказа | string |
data.status | Числовой статус платежа | number |
{
"status": "success",
"data": {
"orderId": "b0d84710-71f0-49ee-8219-f1b31a8d6770",
"status": 1
}
}