Class: CloudpaymentsRuby::Models::Transaction

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/cloudpayments_ruby/models/transaction.rb,
sig/cloudpayments_ruby/models/transaction.rbs

Instance Attribute Summary collapse

Instance Method Summary collapse

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(amount:, android_pay:, card_exp_date:, card_first_six:, card_holder_message:, card_last_four:, card_type:, card_type_code:, created_date:, created_date_iso:, culture_name:, currency:, currency_code:, gateway_name:, ip_address:, ip_country:, issuer:, issuer_bank_country:, payment_amount:, payment_currency:, payment_currency_code:, public_id:, reason:, reason_code:, refunded:, status:, status_code:, terminal_url:, test_mode:, total_fee:, transaction_id:, type:, wallet_type:, account_id: nil, auth_code: nil, auth_date: nil, auth_date_iso: nil, card_category: nil, card_product: nil, confirm_date: nil, confirm_date_iso: nil, description: nil, email: nil, escrow_accumulation_id: nil, fall_back_scenario_declined_transaction_id: nil, invoice_id: nil, ip_city: nil, ip_district: nil, ip_latitude: nil, ip_longitude: nil, ip_region: nil, json_data: nil, name: nil, original_transaction_id: nil, payout_amount: nil, payout_date: nil, payout_date_iso: nil, rrn: nil, subscription_id: nil, token: nil) ⇒ Object

Модель транзакции в ответе API

Parameters:

  • amount (Float) —

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

  • android_pay (Boolean) —

    Признак Android Pay

  • card_exp_date (String) —

    Срок действия карты

  • card_first_six (String) —

    Первые 6 цифр карты

  • card_holder_message (String) —

    Сообщение для держателя карты

  • card_last_four (String) —

    Последние 4 цифры карты

  • card_type (String) —

    Тип карты (Visa, MasterCard, etc.)

  • card_type_code (Integer) —

    Код типа карты

  • created_date (String) —

    Дата создания (формат /Date(...)/)

  • created_date_iso (String) —

    Дата создания ISO

  • culture_name (String) —

    Язык

  • currency (String) —

    Валюта платежа

  • currency_code (Integer) —

    Код валюты

  • gateway_name (String) —

    Имя шлюза

  • ip_address (String) —

    IP-адрес плательщика

  • ip_country (String) —

    Страна по IP

  • issuer (String) —

    Банк-эмитент

  • issuer_bank_country (String) —

    Страна банка-эмитента

  • payment_amount (Float) —

    Сумма платежа в валюте оплаты

  • payment_currency (String) —

    Валюта оплаты

  • payment_currency_code (Integer) —

    Код валюты оплаты

  • public_id (String) —

    Public ID терминала

  • reason (String) —

    Причина (текст)

  • reason_code (Integer) —

    Код причины отклонения (0 = успех)

  • refunded (Boolean) —

    Признак возврата

  • status (String) —

    Статус транзакции (текст)

  • status_code (Integer) —

    Код статуса транзакции

  • terminal_url (String) —

    URL терминала

  • test_mode (Boolean) —

    Режим тестирования

  • total_fee (Float) —

    Общая комиссия

  • transaction_id (Integer) —

    Номер транзакции

  • type (Integer) —

    Тип операции

  • wallet_type (String) —

    Тип кошелька

  • account_id (String) (defaults to: nil) —

    Идентификатор пользователя

  • auth_code (String) (defaults to: nil) —

    Код авторизации

  • auth_date (String) (defaults to: nil) —

    Дата авторизации

  • auth_date_iso (String) (defaults to: nil) —

    Дата авторизации ISO

  • card_category (String) (defaults to: nil) —

    Категория карты

  • card_product (String) (defaults to: nil) —

    Продукт карты

  • confirm_date (String) (defaults to: nil) —

    Дата подтверждения

  • confirm_date_iso (String) (defaults to: nil) —

    Дата подтверждения ISO

  • description (String) (defaults to: nil) —

    Описание платежа

  • email (String) (defaults to: nil) —

    Email плательщика

  • escrow_accumulation_id (String) (defaults to: nil) —

    ID накопления для безопасной сделки

  • fall_back_scenario_declined_transaction_id (Integer) (defaults to: nil) —

    ID отклоненной транзакции fallback сценария

  • invoice_id (String) (defaults to: nil) —

    Номер заказа

  • ip_city (String) (defaults to: nil) —

    Город по IP

  • ip_district (String) (defaults to: nil) —

    Округ по IP

  • ip_latitude (Float) (defaults to: nil) —

    Широта по IP

  • ip_longitude (Float) (defaults to: nil) —

    Долгота по IP

  • ip_region (String) (defaults to: nil) —

    Регион по IP

  • json_data (String) (defaults to: nil) —

    Дополнительные данные JSON

  • name (String) (defaults to: nil) —

    Имя держателя карты

  • original_transaction_id (Integer) (defaults to: nil) —

    ID оригинальной транзакции

  • payout_amount (Float) (defaults to: nil) —

    Сумма выплаты

  • payout_date (String) (defaults to: nil) —

    Дата выплаты

  • payout_date_iso (String) (defaults to: nil) —

    Дата выплаты ISO

  • rrn (String) (defaults to: nil) —

    Retrieval Reference Number

  • subscription_id (String) (defaults to: nil) —

    ID подписки

  • token (String) (defaults to: nil) —

    Токен карты для повторных платежей




# File 'lib/cloudpayments_ruby/models/transaction.rb', line 368

Instance Attribute Details

#account_id ⇒ String?

Идентификатор пользователя

Parameters:

  • (String)

Returns:

  • (String, nil) 


208
 
# File 'lib/cloudpayments_ruby/models/transaction.rb', line 208

optional :account_id, String, api_name: :AccountId

#amount ⇒ Float

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

Parameters:

  • value (Float)

Returns:

  • (Float) 


10
 
# File 'lib/cloudpayments_ruby/models/transaction.rb', line 10

required :amount, Float, api_name: :Amount

#android_pay ⇒ Boolean

Признак Android Pay

Parameters:

  • value (Boolean)

Returns:

  • (Boolean) 


16
 
# File 'lib/cloudpayments_ruby/models/transaction.rb', line 16

required :android_pay, CloudpaymentsRuby::Internal::Type::Boolean, api_name: :AndroidPay

#auth_code ⇒ String?

Код авторизации

Parameters:

  • (String)

Returns:

  • (String, nil) 


214
 
# File 'lib/cloudpayments_ruby/models/transaction.rb', line 214

optional :auth_code, String, api_name: :AuthCode

#auth_date ⇒ String?

Дата авторизации

Parameters:

  • (String)

Returns:

  • (String, nil) 


220
 
# File 'lib/cloudpayments_ruby/models/transaction.rb', line 220

optional :auth_date, String, api_name: :AuthDate

#auth_date_iso ⇒ String?

Дата авторизации ISO

Parameters:

  • (String)

Returns:

  • (String, nil) 


226
 
# File 'lib/cloudpayments_ruby/models/transaction.rb', line 226

optional :auth_date_iso, String, api_name: :AuthDateIso

#card_category ⇒ String?

Категория карты

Parameters:

  • (String)

Returns:

  • (String, nil) 


232
 
# File 'lib/cloudpayments_ruby/models/transaction.rb', line 232

optional :card_category, String, api_name: :CardCategory

#card_exp_date ⇒ String

Срок действия карты

Parameters:

  • value (String)

Returns:

  • (String) 


22
 
# File 'lib/cloudpayments_ruby/models/transaction.rb', line 22

required :card_exp_date, String, api_name: :CardExpDate

#card_first_six ⇒ String

Первые 6 цифр карты

Parameters:

  • value (String)

Returns:

  • (String) 


28
 
# File 'lib/cloudpayments_ruby/models/transaction.rb', line 28

required :card_first_six, String, api_name: :CardFirstSix

#card_holder_message ⇒ String

Сообщение для держателя карты

Parameters:

  • value (String)

Returns:

  • (String) 


34
 
# File 'lib/cloudpayments_ruby/models/transaction.rb', line 34

required :card_holder_message, String, api_name: :CardHolderMessage

#card_last_four ⇒ String

Последние 4 цифры карты

Parameters:

  • value (String)

Returns:

  • (String) 


40
 
# File 'lib/cloudpayments_ruby/models/transaction.rb', line 40

required :card_last_four, String, api_name: :CardLastFour

#card_product ⇒ String?

Продукт карты

Parameters:

  • (String)

Returns:

  • (String, nil) 


238
 
# File 'lib/cloudpayments_ruby/models/transaction.rb', line 238

optional :card_product, String, api_name: :CardProduct

#card_type ⇒ String

Тип карты (Visa, MasterCard, etc.)

Parameters:

  • value (String)

Returns:

  • (String) 


46
 
# File 'lib/cloudpayments_ruby/models/transaction.rb', line 46

required :card_type, String, api_name: :CardType

#card_type_code ⇒ Integer

Код типа карты

Parameters:

  • value (Integer)

Returns:

  • (Integer) 


52
 
# File 'lib/cloudpayments_ruby/models/transaction.rb', line 52

required :card_type_code, Integer, api_name: :CardTypeCode

#confirm_date ⇒ String?

Дата подтверждения

Parameters:

  • (String)

Returns:

  • (String, nil) 


244
 
# File 'lib/cloudpayments_ruby/models/transaction.rb', line 244

optional :confirm_date, String, api_name: :ConfirmDate

#confirm_date_iso ⇒ String?

Дата подтверждения ISO

Parameters:

  • (String)

Returns:

  • (String, nil) 


250
 
# File 'lib/cloudpayments_ruby/models/transaction.rb', line 250

optional :confirm_date_iso, String, api_name: :ConfirmDateIso

#created_date ⇒ String

Дата создания (формат /Date(...)/)

Parameters:

  • value (String)

Returns:

  • (String) 


58
 
# File 'lib/cloudpayments_ruby/models/transaction.rb', line 58

required :created_date, String, api_name: :CreatedDate

#created_date_iso ⇒ String

Дата создания ISO

Parameters:

  • value (String)

Returns:

  • (String) 


64
 
# File 'lib/cloudpayments_ruby/models/transaction.rb', line 64

required :created_date_iso, String, api_name: :CreatedDateIso

#culture_name ⇒ String

Язык

Parameters:

  • value (String)

Returns:

  • (String) 


70
 
# File 'lib/cloudpayments_ruby/models/transaction.rb', line 70

required :culture_name, String, api_name: :CultureName

#currency ⇒ String

Валюта платежа

Parameters:

  • value (String)

Returns:

  • (String) 


76
 
# File 'lib/cloudpayments_ruby/models/transaction.rb', line 76

required :currency, String, api_name: :Currency

#currency_code ⇒ Integer

Код валюты

Parameters:

  • value (Integer)

Returns:

  • (Integer) 


82
 
# File 'lib/cloudpayments_ruby/models/transaction.rb', line 82

required :currency_code, Integer, api_name: :CurrencyCode

#description ⇒ String?

Описание платежа

Parameters:

  • (String)

Returns:

  • (String, nil) 


256
 
# File 'lib/cloudpayments_ruby/models/transaction.rb', line 256

optional :description, String, api_name: :Description

#email ⇒ String?

Email плательщика

Parameters:

  • (String)

Returns:

  • (String, nil) 


262
 
# File 'lib/cloudpayments_ruby/models/transaction.rb', line 262

optional :email, String, api_name: :Email

#escrow_accumulation_id ⇒ String?

ID накопления для безопасной сделки

Parameters:

  • (String)

Returns:

  • (String, nil) 


268
 
# File 'lib/cloudpayments_ruby/models/transaction.rb', line 268

optional :escrow_accumulation_id, String, api_name: :EscrowAccumulationId

#fall_back_scenario_declined_transaction_id ⇒ Integer?

ID отклоненной транзакции fallback сценария

Parameters:

  • (Integer)

Returns:

  • (Integer, nil) 


274
275
276
 
# File 'lib/cloudpayments_ruby/models/transaction.rb', line 274

optional :fall_back_scenario_declined_transaction_id,
Integer,
api_name: :FallBackScenarioDeclinedTransactionId

#gateway_name ⇒ String

Имя шлюза

Parameters:

  • value (String)

Returns:

  • (String) 


88
 
# File 'lib/cloudpayments_ruby/models/transaction.rb', line 88

required :gateway_name, String, api_name: :GatewayName

#invoice_id ⇒ String?

Номер заказа

Parameters:

  • (String)

Returns:

  • (String, nil) 


282
 
# File 'lib/cloudpayments_ruby/models/transaction.rb', line 282

optional :invoice_id, String, api_name: :InvoiceId

#ip_address ⇒ String

IP-адрес плательщика

Parameters:

  • value (String)

Returns:

  • (String) 


94
 
# File 'lib/cloudpayments_ruby/models/transaction.rb', line 94

required :ip_address, String, api_name: :IpAddress

#ip_city ⇒ String?

Город по IP

Parameters:

  • (String)

Returns:

  • (String, nil) 


288
 
# File 'lib/cloudpayments_ruby/models/transaction.rb', line 288

optional :ip_city, String, api_name: :IpCity

#ip_country ⇒ String

Страна по IP

Parameters:

  • value (String)

Returns:

  • (String) 


100
 
# File 'lib/cloudpayments_ruby/models/transaction.rb', line 100

required :ip_country, String, api_name: :IpCountry

#ip_district ⇒ String?

Округ по IP

Parameters:

  • (String)

Returns:

  • (String, nil) 


294
 
# File 'lib/cloudpayments_ruby/models/transaction.rb', line 294

optional :ip_district, String, api_name: :IpDistrict

#ip_latitude ⇒ Float?

Широта по IP

Parameters:

  • (Float)

Returns:

  • (Float, nil) 


300
 
# File 'lib/cloudpayments_ruby/models/transaction.rb', line 300

optional :ip_latitude, Float, api_name: :IpLatitude

#ip_longitude ⇒ Float?

Долгота по IP

Parameters:

  • (Float)

Returns:

  • (Float, nil) 


306
 
# File 'lib/cloudpayments_ruby/models/transaction.rb', line 306

optional :ip_longitude, Float, api_name: :IpLongitude

#ip_region ⇒ String?

Регион по IP

Parameters:

  • (String)

Returns:

  • (String, nil) 


312
 
# File 'lib/cloudpayments_ruby/models/transaction.rb', line 312

optional :ip_region, String, api_name: :IpRegion

#issuer ⇒ String

Банк-эмитент

Parameters:

  • value (String)

Returns:

  • (String) 


106
 
# File 'lib/cloudpayments_ruby/models/transaction.rb', line 106

required :issuer, String, api_name: :Issuer

#issuer_bank_country ⇒ String

Страна банка-эмитента

Parameters:

  • value (String)

Returns:

  • (String) 


112
 
# File 'lib/cloudpayments_ruby/models/transaction.rb', line 112

required :issuer_bank_country, String, api_name: :IssuerBankCountry

#json_data ⇒ String?

Дополнительные данные JSON

Parameters:

  • (String)

Returns:

  • (String, nil) 


318
 
# File 'lib/cloudpayments_ruby/models/transaction.rb', line 318

optional :json_data, String, api_name: :JsonData

#name ⇒ String?

Имя держателя карты

Parameters:

  • (String)

Returns:

  • (String, nil) 


324
 
# File 'lib/cloudpayments_ruby/models/transaction.rb', line 324

optional :name, String, api_name: :Name

#original_transaction_id ⇒ Integer?

ID оригинальной транзакции

Parameters:

  • (Integer)

Returns:

  • (Integer, nil) 


330
 
# File 'lib/cloudpayments_ruby/models/transaction.rb', line 330

optional :original_transaction_id, Integer, api_name: :OriginalTransactionId

#payment_amount ⇒ Float

Сумма платежа в валюте оплаты

Parameters:

  • value (Float)

Returns:

  • (Float) 


118
 
# File 'lib/cloudpayments_ruby/models/transaction.rb', line 118

required :payment_amount, Float, api_name: :PaymentAmount

#payment_currency ⇒ String

Валюта оплаты

Parameters:

  • value (String)

Returns:

  • (String) 


124
 
# File 'lib/cloudpayments_ruby/models/transaction.rb', line 124

required :payment_currency, String, api_name: :PaymentCurrency

#payment_currency_code ⇒ Integer

Код валюты оплаты

Parameters:

  • value (Integer)

Returns:

  • (Integer) 


130
 
# File 'lib/cloudpayments_ruby/models/transaction.rb', line 130

required :payment_currency_code, Integer, api_name: :PaymentCurrencyCode

#payout_amount ⇒ Float?

Сумма выплаты

Parameters:

  • (Float)

Returns:

  • (Float, nil) 


336
 
# File 'lib/cloudpayments_ruby/models/transaction.rb', line 336

optional :payout_amount, Float, api_name: :PayoutAmount

#payout_date ⇒ String?

Дата выплаты

Parameters:

  • (String)

Returns:

  • (String, nil) 


342
 
# File 'lib/cloudpayments_ruby/models/transaction.rb', line 342

optional :payout_date, String, api_name: :PayoutDate

#payout_date_iso ⇒ String?

Дата выплаты ISO

Parameters:

  • (String)

Returns:

  • (String, nil) 


348
 
# File 'lib/cloudpayments_ruby/models/transaction.rb', line 348

optional :payout_date_iso, String, api_name: :PayoutDateIso

#public_id ⇒ String

Public ID терминала

Parameters:

  • value (String)

Returns:

  • (String) 


136
 
# File 'lib/cloudpayments_ruby/models/transaction.rb', line 136

required :public_id, String, api_name: :PublicId

#reason ⇒ String

Причина (текст)

Parameters:

  • value (String)

Returns:

  • (String) 


142
 
# File 'lib/cloudpayments_ruby/models/transaction.rb', line 142

required :reason, String, api_name: :Reason

#reason_code ⇒ Integer

Код причины отклонения (0 = успех)

Parameters:

  • value (Integer)

Returns:

  • (Integer) 


148
 
# File 'lib/cloudpayments_ruby/models/transaction.rb', line 148

required :reason_code, Integer, api_name: :ReasonCode

#refunded ⇒ Boolean

Признак возврата

Parameters:

  • value (Boolean)

Returns:

  • (Boolean) 


154
 
# File 'lib/cloudpayments_ruby/models/transaction.rb', line 154

required :refunded, CloudpaymentsRuby::Internal::Type::Boolean, api_name: :Refunded

#rrn ⇒ String?

Retrieval Reference Number

Parameters:

  • (String)

Returns:

  • (String, nil) 


354
 
# File 'lib/cloudpayments_ruby/models/transaction.rb', line 354

optional :rrn, String, api_name: :Rrn

#status ⇒ String

Статус транзакции (текст)

Parameters:

  • value (String)

Returns:

  • (String) 


160
 
# File 'lib/cloudpayments_ruby/models/transaction.rb', line 160

required :status, String, api_name: :Status

#status_code ⇒ Integer

Код статуса транзакции

Parameters:

  • value (Integer)

Returns:

  • (Integer) 


166
 
# File 'lib/cloudpayments_ruby/models/transaction.rb', line 166

required :status_code, Integer, api_name: :StatusCode

#subscription_id ⇒ String?

ID подписки

Parameters:

  • (String)

Returns:

  • (String, nil) 


360
 
# File 'lib/cloudpayments_ruby/models/transaction.rb', line 360

optional :subscription_id, String, api_name: :SubscriptionId

#terminal_url ⇒ String

URL терминала

Parameters:

  • value (String)

Returns:

  • (String) 


172
 
# File 'lib/cloudpayments_ruby/models/transaction.rb', line 172

required :terminal_url, String, api_name: :TerminalUrl

#test_mode ⇒ Boolean

Режим тестирования

Parameters:

  • value (Boolean)

Returns:

  • (Boolean) 


178
 
# File 'lib/cloudpayments_ruby/models/transaction.rb', line 178

required :test_mode, CloudpaymentsRuby::Internal::Type::Boolean, api_name: :TestMode

#token ⇒ String?

Токен карты для повторных платежей

Parameters:

  • (String)

Returns:

  • (String, nil) 


366
 
# File 'lib/cloudpayments_ruby/models/transaction.rb', line 366

optional :token, String, api_name: :Token

#total_fee ⇒ Float

Общая комиссия

Parameters:

  • value (Float)

Returns:

  • (Float) 


184
 
# File 'lib/cloudpayments_ruby/models/transaction.rb', line 184

required :total_fee, Float, api_name: :TotalFee

#transaction_id ⇒ Integer

Номер транзакции

Parameters:

  • value (Integer)

Returns:

  • (Integer) 


190
 
# File 'lib/cloudpayments_ruby/models/transaction.rb', line 190

required :transaction_id, Integer, api_name: :TransactionId

#type ⇒ Integer

Тип операции

Parameters:

  • value (Integer)

Returns:

  • (Integer) 


196
 
# File 'lib/cloudpayments_ruby/models/transaction.rb', line 196

required :type, Integer, api_name: :Type

#wallet_type ⇒ String

Тип кошелька

Parameters:

  • value (String)

Returns:

  • (String) 


202
 
# File 'lib/cloudpayments_ruby/models/transaction.rb', line 202

required :wallet_type, String, api_name: :WalletType

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


305
 
# File 'sig/cloudpayments_ruby/models/transaction.rbs', line 305

def to_hash: -> {