> ## Documentation Index
> Fetch the complete documentation index at: https://docs.yume.cloud/llms.txt
> Use this file to discover all available pages before exploring further.

# Глоссарий: Карты и автосписания

> Справочник модели сохранённой карты компании, обработчиков привязки и удаления карты через FreedomPay, форматов и статусов карты.

Справочник к странице [«Карты и автосписания»](/ru/logic/company-billing/cards).

## Понятия

| Понятие                         | Значение                                                                                                                              |
| ------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------- |
| Карта компании                  | Сохранённая банковская карта компании для рекуррентных списаний через FreedomPay; на компанию допускается только одна активная карта. |
| Инициализация привязки карты    | Возвращает список карт и запускает привязку новой карты через FreedomPay; при отсутствии активной карты делает активной самую свежую. |
| Обновление и удаление карты     | Обновляет карту (в т.ч. делает активной) и удаляет её в шлюзе FreedomPay, после чего активирует другую карту.                         |
| Приём привязки карты (callback) | Postback-обработчик FreedomPay: по XML-уведомлению об успешной привязке создаёт/обновляет карту и делает её активной.                 |
| Формат инициализации карты      | Формирует запрос на привязку карты во FreedomPay и возвращает ссылку редиректа.                                                       |
| Формат карты                    | Читает данные карты и позволяет менять активность; при активации снимает флаг с прочих карт компании.                                 |
| Статус карты                    | Статус привязанной карты в шлюзе FreedomPay.                                                                                          |

## Модели и поля

### Карта компании

*Сохранённая банковская карта компании для рекуррентных списаний через FreedomPay. На компанию допускается только одна активная карта (unique-ограничение при активности), пара компания + хэш карты уникальна.*

**Связи**

| Поле     | Тип   | Описание                             |
| -------- | ----- | ------------------------------------ |
| Компания | связь | Компания, которой принадлежит карта. |

**Состояние**

| Поле                   | Тип          | Описание                                                                       |
| ---------------------- | ------------ | ------------------------------------------------------------------------------ |
| Активная               | флаг         | Карта, используемая для списаний; активной может быть только одна на компанию. |
| Статус                 | перечисление | Статус карты в шлюзе (ok / approved / deleted).                                |
| Разрешены автосписания | флаг         | По карте разрешены рекуррентные списания.                                      |

**Идентификация**

| Поле                        | Тип   | Описание                                                         |
| --------------------------- | ----- | ---------------------------------------------------------------- |
| Идентификатор карты в шлюзе | число | Идентификатор карты из FreedomPay, уникален глобально.           |
| Хэш карты                   | текст | Маскированный номер карты, показывается пользователю.            |
| Токен карты                 | текст | Токен карты для операций и удаления в шлюзе.                     |
| Профиль рекуррента          | текст | Идентификатор рекуррентного профиля FreedomPay для автосписаний. |

**Реквизиты карты**

| Поле              | Тип   | Описание                              |
| ----------------- | ----- | ------------------------------------- |
| Банк              | текст | Название банка-эмитента.              |
| Платёжная система | текст | Бренд карты (Visa/Mastercard и т.п.). |
| Год окончания     | текст | Год окончания срока действия карты.   |
| Месяц окончания   | текст | Месяц окончания срока действия карты. |

**Сроки**

| Поле          | Тип        | Описание                                                        |
| ------------- | ---------- | --------------------------------------------------------------- |
| Дата привязки | дата/время | Момент создания записи о карте (задаётся вручную при привязке). |

### Инициализация привязки карты

*Возвращает список карт и запускает привязку новой карты через FreedomPay; при отсутствии активной карты делает активной самую свежую. Чтение — список карт, отправка — инициализация привязки.*

### Обновление и удаление карты

*Обновляет карту (в т.ч. делает активной) и удаляет её в шлюзе FreedomPay, после чего активирует другую карту.*

### Приём привязки карты (callback)

*Postback-обработчик FreedomPay: по XML-уведомлению об успешной привязке создаёт/обновляет карту и делает её активной. Реагирует только на уведомление о подтверждении привязки.*

### Формат инициализации карты

*Формирует запрос на привязку карты во FreedomPay и возвращает ссылку редиректа. Вход — ссылка возврата, выход — ссылка перенаправления и идентификатор платежа.*

| Поле                   | Тип         | Описание                                         |
| ---------------------- | ----------- | ------------------------------------------------ |
| Ссылка возврата        | текст (URL) | Адрес, куда вернуть пользователя после привязки. |
| Ссылка перенаправления | текст (URL) | Адрес формы привязки карты FreedomPay.           |
| Идентификатор платежа  | текст       | Идентификатор операции привязки в шлюзе.         |

### Формат карты

*Читает данные карты и позволяет менять активность; при активации снимает флаг с прочих карт компании. Большинство полей только для чтения.*

## Статусы и справочники

### Статус карты

* OK
* Подтверждена
* Удалена