Class: Yoomoney::Models::PaymentCreateParams

Inherits:
Internal::Type::BaseModel show all
Extended by:
Internal::Type::RequestParameters::Converter
Includes:
Internal::Type::RequestParameters
Defined in:
lib/yoomoney/models/payment_create_params.rb,
sig/yoomoney/models/payment_create_params.rbs

Overview

See Also:

  • Yoomoney::Resources::Payments#create

Defined Under Namespace

Modules: Confirmation, PaymentMethodData, Receiver Classes: PaymentOrder, Statement, Transfer

Instance Attribute Summary collapse

Attributes included from Internal::Type::RequestParameters

#request_options

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Internal::Type::RequestParameters::Converter

dump_request

Methods included from Internal::Type::RequestParameters

included

Methods inherited from Internal::Type::BaseModel

==, #==, #[], coerce, #deconstruct_keys, #deep_to_h, dump, fields, hash, #hash, inherited, inspect, #inspect, known_fields, optional, recursively_to_h, required, #to_h, #to_json, #to_s, to_sorbet_type, #to_yaml

Methods included from Internal::Type::Converter

#coerce, coerce, #dump, dump, inspect, #inspect, meta_info, new_coerce_state, type_info

Methods included from Internal::Util::SorbetRuntimeSupport

#const_missing, #define_sorbet_constant!, #sorbet_constant_defined?, #to_sorbet_type, to_sorbet_type

Constructor Details

#initialize(account_number:, bic:) ⇒ Object

Parameters:

  • account_number (String) —

    Номер банковского счета.

  • bic (String) —

    Банковский идентификационный код (БИК) банка.



# File 'lib/yoomoney/models/payment_create_params.rb', line 133


Instance Attribute Details

#airline ⇒ Yoomoney::Models::Airline?

Данные для продажи авиабилетов.

Parameters:

Returns:



25
# File 'lib/yoomoney/models/payment_create_params.rb', line 25

optional :airline, -> { Yoomoney::Airline }

#amount ⇒ Yoomoney::Models::MonetaryAmount

Сумма платежа.



14
# File 'lib/yoomoney/models/payment_create_params.rb', line 14

required :amount, -> { Yoomoney::MonetaryAmount }

#capture ⇒ Boolean?

Автоматический прием поступившего платежа.

Parameters:

  • (Boolean)

Returns:

  • (Boolean, nil)


31
# File 'lib/yoomoney/models/payment_create_params.rb', line 31

optional :capture, Yoomoney::Internal::Type::Boolean

#client_ip ⇒ String?

IPv4 или IPv6-адрес пользователя.

Parameters:

  • (String)

Returns:

  • (String, nil)


37
# File 'lib/yoomoney/models/payment_create_params.rb', line 37

optional :client_ip, String

#confirmation ⇒ Yoomoney::Models::PaymentCreateParams::Confirmation::ConfirmationDataRedirect, ...

Данные, необходимые для инициирования выбранного сценария подтверждения платежа пользователем.



44
# File 'lib/yoomoney/models/payment_create_params.rb', line 44

optional :confirmation, union: -> { Yoomoney::PaymentCreateParams::Confirmation }

#deal ⇒ Yoomoney::Models::PaymentDealInfo?

Данные о сделке.



50
# File 'lib/yoomoney/models/payment_create_params.rb', line 50

optional :deal, -> { Yoomoney::PaymentDealInfo }

#description ⇒ String?

Описание транзакции.

Parameters:

  • (String)

Returns:

  • (String, nil)


56
# File 'lib/yoomoney/models/payment_create_params.rb', line 56

optional :description, String

#idempotence_key ⇒ String

Parameters:

  • value (String)

Returns:

  • (String)


19
# File 'lib/yoomoney/models/payment_create_params.rb', line 19

required :idempotence_key, String

#merchant_customer_id ⇒ String?

Идентификатор покупателя в вашей системе.

Parameters:

  • (String)

Returns:

  • (String, nil)


62
# File 'lib/yoomoney/models/payment_create_params.rb', line 62

optional :merchant_customer_id, String

#metadata ⇒ Hash{Symbol=>String}?

Любые дополнительные данные, которые нужны вам для работы (например, номер заказа). Передаются в виде набора пар «ключ-значение» и возвращаются в ответе от ЮKassa. Ограничения: максимум 16 ключей, имя ключа не больше 32 символов, значение ключа не больше 512 символов, тип данных — строка в формате UTF-8.

Parameters:

  • (::Hash[Symbol, String])

Returns:

  • (Hash{Symbol=>String}, nil)


71
# File 'lib/yoomoney/models/payment_create_params.rb', line 71

optional :metadata, Yoomoney::Internal::Type::HashOf[String]

#payment_method_data ⇒ Yoomoney::Models::PaymentCreateParams::PaymentMethodData::PaymentMethodDataBankCard, ...

Данные для оплаты конкретным способом.



77
# File 'lib/yoomoney/models/payment_create_params.rb', line 77

optional :payment_method_data, union: -> { Yoomoney::PaymentCreateParams::PaymentMethodData }

#payment_method_id ⇒ String?

Идентификатор сохраненного способа оплаты.

Parameters:

  • (String)

Returns:

  • (String, nil)


83
# File 'lib/yoomoney/models/payment_create_params.rb', line 83

optional :payment_method_id, String

#payment_order ⇒ Yoomoney::Models::PaymentCreateParams::PaymentOrder?

Данные платежного поручения.



89
# File 'lib/yoomoney/models/payment_create_params.rb', line 89

optional :payment_order, -> { Yoomoney::PaymentCreateParams::PaymentOrder }

#payment_token ⇒ String?

Одноразовый токен для оплаты банковской картой.

Parameters:

  • (String)

Returns:

  • (String, nil)


95
# File 'lib/yoomoney/models/payment_create_params.rb', line 95

optional :payment_token, String

#receipt ⇒ Yoomoney::Models::ReceiptData?

Данные для формирования чека.



101
# File 'lib/yoomoney/models/payment_create_params.rb', line 101

optional :receipt, -> { Yoomoney::ReceiptData }

#receiver ⇒ Yoomoney::Models::PaymentCreateParams::Receiver::ReceiverMobileBalance, ...

Получатель перевода.



107
# File 'lib/yoomoney/models/payment_create_params.rb', line 107

optional :receiver, union: -> { Yoomoney::PaymentCreateParams::Receiver }

#recipient ⇒ Yoomoney::Models::Recipient?

Получатель платежа.

Parameters:

Returns:



113
# File 'lib/yoomoney/models/payment_create_params.rb', line 113

optional :recipient, -> { Yoomoney::Recipient }

#save_payment_method ⇒ Boolean?

Сохранение платежных данных.

Parameters:

  • (Boolean)

Returns:

  • (Boolean, nil)


119
# File 'lib/yoomoney/models/payment_create_params.rb', line 119

optional :save_payment_method, Yoomoney::Internal::Type::Boolean

#statements ⇒ Array<Yoomoney::Models::PaymentCreateParams::Statement>?

Данные для отправки справки.



125
# File 'lib/yoomoney/models/payment_create_params.rb', line 125

optional :statements, -> { Yoomoney::Internal::Type::ArrayOf[Yoomoney::PaymentCreateParams::Statement] }

#transfers ⇒ Array<Yoomoney::Models::PaymentCreateParams::Transfer>?

Данные о распределении денег.



131
# File 'lib/yoomoney/models/payment_create_params.rb', line 131

optional :transfers, -> { Yoomoney::Internal::Type::ArrayOf[Yoomoney::PaymentCreateParams::Transfer] }

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>)


# File 'lib/yoomoney/models/payment_create_params.rb', line 554


.variants ⇒ Array(Yoomoney::Models::PaymentCreateParams::Receiver::ReceiverMobileBalance, Yoomoney::Models::PaymentCreateParams::Receiver::ReceiverDigitalWallet, Yoomoney::Models::PaymentCreateParams::Receiver::ReceiverBankAccount)



# File 'lib/yoomoney/models/payment_create_params.rb', line 246


Instance Method Details

#to_hash ⇒ {

Returns:

  • ({)


144
# File 'sig/yoomoney/models/payment_create_params.rbs', line 144

def to_hash: -> {