RegisterRequest class
Запрос регистрации заказа
Запрос на регистрацию заказа с предавторизацией, выполняется посредством передачи параметра preAuth
.
- Inheritance
-
- Object
- AcquiringRequest
- RegisterRequest
- Annotations
-
- @JsonSerializable(includeIfNull: false)
Constructors
-
RegisterRequest({required String orderNumber, required int amount, required String returnUrl, bool? preAuth = false, int? currency, String? failUrl, String? dynamicCallbackUrl, String? description, String? language, int? feeInput, String? pageView, String? clientId, String? merchantLogin, Map<
String, dynamic> ? jsonParams, int? sessionTimeoutSecs, String? expirationDate, String? bindingId, Features? features, String? email, int? phone, AppToApp? app2app, BackToApp? back2app, String? autocompletionDate, BillingPayerData? billingPayerData}) - Запрос регистрации заказа
-
RegisterRequest.fromJson(Map<
String, dynamic> json) -
Преобразование json в модель
factory
Properties
- amount → int
-
Сумма возврата в минимальных единицах валюты.
final
- apiMethod → String
-
Метод запроса
no setteroverride
- app2app → AppToApp?
-
Способ оплаты по сценарию app2app.
final
- autocompletionDate → String?
-
Дата и время автозавершения двухстадийного платежа в следующем формате:
2017-12-29T13:02:51
final - back2app → BackToApp?
-
Способ оплаты по сценарию back2app.
final
- billingPayerData → BillingPayerData?
-
Блок c регистрационными данными клиента (адрес, почтовый индекс), необходимыми для прохождения проверки адреса в рамках сервисов AVS/AVV.
final
- bindingId → String?
-
Идентификатор созданной ранее связки. Может использоваться, только если у продавца есть разрешение на работу со связками.
Если этот параметр передаётся в данном запросе, то это означает:
final
- clientId → String?
-
Номер (идентификатор) клиента в системе магазина.
Используется для реализации функционала связок.
Может присутствовать, если магазину разрешено создание связок.
final
- currency → int?
-
Код валюты платежа ISO 4217. Если не указано, то используется значение по умолчанию.
final
- description → String?
-
Описание заказа в свободной форме.
final
- dynamicCallbackUrl → String?
-
Параметр позволяет воспользоваться функциональность динамической отправки callback-уведомлений.
В нем можно передать адрес, на который будут отправляться все «платежные» callback-уведомления, активированные для продавца.
Под платежными понимаются callback-уведомления о следующих событиях: успешный холд, платеж отклонен по таймауту, платеж cardpresent отклонен, успешное списание, возврат, отмена.
При этом активированные для мерчанта callback-уведомления, не относящиеся к платежам (включение/выключение связки, создание связки), будут отправляться на статический адрес для callback-ов.
final
- email → String?
-
Адрес электронной почты покупателя.
final
-
equals
→ Map<
String, Object?> -
Comparison objects
no setter
- expirationDate → String?
-
Дата и время окончания жизни заказа. Формат: yyyy-MM-ddTHH:mm:ss.
final
- failUrl → String?
-
Адрес, на который требуется перенаправить пользователя в случае неуспешной оплаты.
Адрес должен быть указан полностью, включая используемый протокол (например, https://test.ru вместо test.ru).
В противном случае пользователь будет перенаправлен по адресу следующего вида: http://<адрес_платёжного_шлюза>/<адрес_продавца>.
final
- features → Features?
-
Способы проведения платежа
final
- feeInput → int?
-
Сумма комиссии в минимальных единицах валюты.
final
- hashCode → int
-
The hash code for this object.
no setterinherited
-
headers
→ Map<
String, String> -
Заголовок метода
no setterinherited
-
jsonParams
→ Map<
String, dynamic> -
Дополнительные параметры запроса. Формат вида: {«Имя1»: «Значение1», «Имя2»: «Значение2»}.
final
- language → String?
-
Язык в кодировке ISO 639-1.
Если не указан, будет использован язык, указанный в настройках магазина как язык по умолчанию.
final
- merchantLogin → String?
-
Чтобы зарегистрировать заказ от имени дочернего продавца, укажите его логин в этом параметре.
final
- orderNumber → String
-
Номер (идентификатор) заказа в системе магазина, уникален для каждого магазина в пределах системы.
Если номер заказа генерируется на стороне платёжного шлюза, этот параметр передавать необязательно.
final
- pageView → String?
-
По значению данного параметра определяется, какие страницы платёжного интерфейса должны загружаться для клиента. Возможны следующие значения.
final
- phone → int?
-
Номер телефона клиента. Может быть следующего формата:
^((+7|7|8)?([0-9]){10})$
.final - preAuth → bool?
-
Доступны следующие значения:
final
- returnUrl → String
-
Адрес, на который требуется перенаправить пользователя в случае успешной оплаты.
Адрес должен быть указан полностью, включая используемый протокол (например, https://test.ru вместо test.ru).
В противном случае пользователь будет перенаправлен по адресу следующего вида: http://<адрес_платёжного_шлюза>/<адрес_продавца>.
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- sessionTimeoutSecs → int?
-
Продолжительность жизни заказа в секундах.
final
Methods
-
compareLists<
R> (List< R> ? list1, List<R> ? list2) → bool -
Determines whether
list1
andlist2
are equal.inherited -
copyWith(
{bool? preAuth, String? orderNumber, int? amount, int? currency, String? returnUrl, String? failUrl, String? dynamicCallbackUrl, String? description, String? language, int? feeInput, String? pageView, String? clientId, String? merchantLogin, Map< String, dynamic> ? jsonParams, int? sessionTimeoutSecs, String? expirationDate, String? bindingId, Features? features, String? email, int? phone, AppToApp? app2app, BackToApp? back2app, String? autocompletionDate, BillingPayerData? billingPayerData}) → RegisterRequest - Создает экземпляр с заданными параметрами
-
genHash<
R> (Iterable< R> ? values) → int -
Returns a
hashCode
forequals
.inherited -
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toJson(
) → Map< String, dynamic> - Преобразование модели в json
-
toString(
) → String -
A string representation of this object.
inherited
-
validate(
) → void - Метод проверяет валидность данных
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited