Протокол¶
Оглавление¶
-
keyapis/invoice/v1/keyapis_invoice_paymethod_v1.proto
- DeletePayMethodResponse
- GetPayMethodListRequest
- GetPayMethodListResponse
- PayMethod
- PostPayMethodBankcardRequest
- PostPayMethodBankcardResponse
- PostPayMethodBankcardResponse.Error
- PostPayMethodBankcardResponse.RegisterData
- PostPayMethodDefaultRequest
- PostPayMethodDefaultResponse
- PostPayMethodDefaultResponse.Error
- PostPayMethodSbpRequest
- PostPayMethodSbpResponse
- PostPayMethodSbpResponse.Error
- PostPayMethodSbpResponse.RegisterData
- PayMethod.StatusType
- PayMethod.Type
Схема классов¶
keyapis/invoice/v1/keyapis_invoice_paymethod_v1.proto¶
Сервис реализует функционал управления способами оплаты
PayMethodService¶
Сервис способов оплаты
| Название метода | Описание | Тип запроса | Тип ответа |
|---|---|---|---|
| GetPayMethodList | Метод получения списка способов оплаты. Для роли master возвращаются способы оплаты для пользователя из токена. Для роли service возвращаются способы оплаты пользователя, указанного в параметре запроса. Метод доступен для: service, master | keyapis.invoice.v1.GetPayMethodListRequest | keyapis.invoice.v1.GetPayMethodListResponse |
| DeletePayMethod | Метод удаления способа оплаты. Удаляются способы оплаты для пользователя из токена. Метод доступен для: master | keyapis.invoice.v1.DeletePayMethodRequest | keyapis.invoice.v1.DeletePayMethodResponse |
| PostPayMethodDefault | Метод установки способа оплаты по умолчанию. Изменяются способы оплаты для пользователя из токена. Метод доступен для: master | keyapis.invoice.v1.PostPayMethodDefaultRequest | keyapis.invoice.v1.PostPayMethodDefaultResponse |
| PostPayMethodBankcard | Метод добавления способа оплаты с типом "Банковская карта". Добавляется банковская карта для пользователя из токена. Метод доступен для: master | keyapis.invoice.v1.PostPayMethodBankcardRequest | keyapis.invoice.v1.PostPayMethodBankcardResponse |
| PostPayMethodSbp | Метод добавления способа оплаты с типом "СБП". Добавляется СБП для пользователя из токена. Метод доступен для: master | keyapis.invoice.v1.PostPayMethodSbpRequest | keyapis.invoice.v1.PostPayMethodSbpResponse |
DeletePayMethodRequest¶
Запрос на удаление способа оплаты
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| pay_method_id | Идентификатор способа оплаты | string | REQUIRED |
DeletePayMethodResponse¶
Ответ на запрос удаления способа оплаты
GetPayMethodListRequest¶
Запрос на получение списка способов оплаты
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| user_id | Идентификатор пользователя | int32 |
GetPayMethodListResponse¶
Ответ на запрос получения списка способов оплаты
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| data | Способы оплаты | repeated keyapis.invoice.v1.PayMethod |
PayMethod¶
Способ оплаты
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| pay_method_id | Идентификатор способа оплаты | string | REQUIRED |
| user_id | Идентификатор пользователя | int32 | REQUIRED |
| type | Тип способа оплаты | keyapis.invoice.v1.PayMethod.Type | REQUIRED |
| is_active | Признак активной записи | bool | REQUIRED |
| is_default | Способ оплаты по умолчанию | bool | REQUIRED |
| pay_method_contact | Мобильный телефон, на который будут отправляться уведомления | string | |
| pay_method_description | Описание способа оплаты | string | |
| pay_method_alias | Псевдоним способа оплаты | string | |
| card_type | Тип банковской карты | keyapis.invoice.v1.PayMethod.CardType | OUTPUT_ONLY |
| masked_num | Маскированный номер карты или идентификатора привязки счета СБП | string | OUTPUT_ONLY |
| bank_name | Наименование банка | string | OUTPUT_ONLY |
| is_auth | Признак авторизации БК | bool | OUTPUT_ONLY |
| status_type | Статус способа оплаты | keyapis.invoice.v1.PayMethod.StatusType | OUTPUT_ONLY |
| register_at | Дата регистрации способа оплаты. # Тип: DateTime | google.protobuf.Timestamp | OUTPUT_ONLY |
PostPayMethodBankcardRequest¶
Запрос на добавления способа оплаты с типом "Банковская карта"
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| url_return_ok | URL для переадресации абонента в случае успешной регистрации карты | string | REQUIRED |
| url_return_no | URL для переадресации абонента в случае неуспешной регистрации карты | string |
PostPayMethodBankcardResponse¶
Ответ на запрос добавления способа оплаты с типом "Банковская карта"
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| error | Ошибка валидации | optional keyapis.invoice.v1.PostPayMethodBankcardResponse.Error | |
| data | Данные регистрации | optional keyapis.invoice.v1.PostPayMethodBankcardResponse.RegisterData |
PostPayMethodBankcardResponse.Error¶
Ошибка запроса
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| validation | Ошибка валидации | optional keyapis.invoice.v1.ValidationError |
PostPayMethodBankcardResponse.RegisterData¶
Данные регистрации
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| req_id | Идентификатор запроса на регистрацию | string | |
| url_registration | Ссылка для переадресации клиента для продолжения регистрации | string |
PostPayMethodDefaultRequest¶
Запрос установки способа оплаты по умолчанию
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| pay_method_id | Идентификатор способа оплаты | string | REQUIRED |
PostPayMethodDefaultResponse¶
Ответ на запрос установки способа оплаты по умолчанию
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| error | Ошибка | optional keyapis.invoice.v1.PostPayMethodDefaultResponse.Error |
PostPayMethodDefaultResponse.Error¶
Ошибка запроса
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| validation | Ошибка валидации | optional keyapis.invoice.v1.ValidationError |
PostPayMethodSbpRequest¶
Запрос на добавления способа оплаты с типом "СБП"
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| url_return_ok | URL для переадресации абонента в случае успешной регистрации карты | string | REQUIRED |
| url_return_no | URL для переадресации абонента в случае неуспешной регистрации карты | string |
PostPayMethodSbpResponse¶
Ответ на запрос добавления способа оплаты с типом "СБП"
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| error | Ошибка валидации | optional keyapis.invoice.v1.PostPayMethodSbpResponse.Error | |
| data | Данные регистрации | optional keyapis.invoice.v1.PostPayMethodSbpResponse.RegisterData |
PostPayMethodSbpResponse.Error¶
Ошибка запроса
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| validation | Ошибка валидации | optional keyapis.invoice.v1.ValidationError |
PostPayMethodSbpResponse.RegisterData¶
Данные регистрации
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| req_id | Идентификатор запроса на регистрацию | string | |
| url_registration | Ссылка для переадресации клиента для продолжения регистрации | string | |
| sbp_payload | Содержимое QR кода для регистрации платежного СБП-токена | string |
ValidationError¶
Ошибка валидации
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| path | Путь к полю в формате наименования прото | string | REQUIRED |
| message | Валидационное сообщение | string | REQUIRED |
PayMethod.CardType¶
Справочник типов банковских карт
| Номер | Тип | Название |
|---|---|---|
| 0 | CARD_TYPE_UNKNOWN | Значение не указано |
| 1 | VISA | Карта VISA |
| 2 | EC_MC | Карта EuroCard/MasterCard |
| 3 | DCL | Карта DinersClub |
| 4 | JCB | Карта JCB |
| 5 | AMEX | Карта American Express |
| 6 | MIR | Платежная система "Мир" |
PayMethod.StatusType¶
Статус способа оплаты
| Номер | Тип | Название |
|---|---|---|
| 0 | STATUS_TYPE_UNKNOWN | Значение не указано |
| 1 | VALID | Исправный |
| 2 | EXPIRED | Истекший |
| 3 | BLOCKED | Заблокированный |
PayMethod.Type¶
Справочник типов способов оплаты
| Номер | Тип | Название |
|---|---|---|
| 0 | TYPE_UNKNOWN | Значение не указано |
| 1 | BANK_CARD | Банковская карта |
| 2 | SBP | Сервис быстрых платежей |
| 3 | SBER_BIND | Связка Сбербанка |
Скалярные типы значений¶
| .proto Type | Примечание | Python | Go | Ruby | C# | C++ | Java | PHP |
|---|---|---|---|---|---|---|---|---|
| double | float | float64 | Float | double | double | double | float | |
| float | float | float32 | Float | float | float | float | float | |
| int32 | Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint32 instead. | int | int32 | Bignum or Fixnum (as required) | int | int32 | int | integer |
| int64 | Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint64 instead. | int/long | int64 | Bignum | long | int64 | long | integer/string |
| uint32 | Uses variable-length encoding. | int/long | uint32 | Bignum or Fixnum (as required) | uint | uint32 | int | integer |
| uint64 | Uses variable-length encoding. | int/long | uint64 | Bignum or Fixnum (as required) | ulong | uint64 | long | integer/string |
| sint32 | Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int32s. | int | int32 | Bignum or Fixnum (as required) | int | int32 | int | integer |
| sint64 | Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int64s. | int/long | int64 | Bignum | long | int64 | long | integer/string |
| fixed32 | Always four bytes. More efficient than uint32 if values are often greater than 2^28. | int | uint32 | Bignum or Fixnum (as required) | uint | uint32 | int | integer |
| fixed64 | Always eight bytes. More efficient than uint64 if values are often greater than 2^56. | int/long | uint64 | Bignum | ulong | uint64 | long | integer/string |
| sfixed32 | Always four bytes. | int | int32 | Bignum or Fixnum (as required) | int | int32 | int | integer |
| sfixed64 | Always eight bytes. | int/long | int64 | Bignum | long | int64 | long | integer/string |
| bool | boolean | bool | TrueClass/FalseClass | bool | bool | boolean | boolean | |
| string | A string must always contain UTF-8 encoded or 7-bit ASCII text. | str/unicode | string | String (UTF-8) | string | string | String | string |
| bytes | May contain any arbitrary sequence of bytes. | str | []byte | String (ASCII-8BIT) | ByteString | string | ByteString | string |