Class: MangoModel::Transaction
- Inherits:
-
EntityBase
- Object
- EntityBase
- MangoModel::Transaction
- Includes:
- MangoPay::Jsonifier
- Defined in:
- lib/mangopay/model/entity/transaction.rb
Overview
Transaction entity A transaction represents an action to relocate money.
Direct Known Subclasses
Constant Summary
Constants included from MangoPay::Jsonifier
Instance Attribute Summary collapse
-
#author_id ⇒ Object
- String
-
ID of the initiating user.
-
#credited_funds ⇒ Object
- Money
-
Information about the funds that are being credited (
DebitedFunds
-Fees
=Credited_Funds
).
-
#credited_user_id ⇒ Object
- String
-
ID of the user who will be credited (defaults to the owner of the wallet).
-
#credited_wallet_id ⇒ Object
- String
-
ID of the wallet where money will be credited.
-
#debited_funds ⇒ Object
- Money
-
Information about the funds that are being debited.
-
#debited_wallet_id ⇒ Object
- String
-
ID of the wallet that was debited from.
-
#execution_date ⇒ Object
- Integer
-
Time of execution of the transaction (UNIX timestamp).
-
#fees ⇒ Object
- Money
-
Information about the fees that were taken by the client for this transaction (and transferred to the client’s platform’s wallet).
-
#nature ⇒ Object
- TransactionNature
-
Nature of the transaction.
-
#result_code ⇒ Object
- String
-
Its result code.
-
#result_message ⇒ Object
- String
-
Verbal explanation of the result.
-
#status ⇒ Object
- TransactionStatus
-
Status of the transaction.
-
#type ⇒ Object
- TransactionType
-
Type of the transaction.
Attributes inherited from EntityBase
Method Summary
Methods included from MangoPay::Jsonifier
Methods included from NonInstantiable
Instance Attribute Details
#author_id ⇒ Object
- String
-
ID of the initiating user
28 29 30 |
# File 'lib/mangopay/model/entity/transaction.rb', line 28 def @author_id end |
#credited_funds ⇒ Object
- Money
-
Information about the funds that are being credited
(DebitedFunds
- Fees
= Credited_Funds
)
15 16 17 |
# File 'lib/mangopay/model/entity/transaction.rb', line 15 def credited_funds @credited_funds end |
#credited_user_id ⇒ Object
- String
-
ID of the user who will be credited (defaults
to the owner of the wallet)
32 33 34 |
# File 'lib/mangopay/model/entity/transaction.rb', line 32 def credited_user_id @credited_user_id end |
#credited_wallet_id ⇒ Object
- String
-
ID of the wallet where money will be credited
25 26 27 |
# File 'lib/mangopay/model/entity/transaction.rb', line 25 def credited_wallet_id @credited_wallet_id end |
#debited_funds ⇒ Object
- Money
-
Information about the funds that are being debited
11 12 13 |
# File 'lib/mangopay/model/entity/transaction.rb', line 11 def debited_funds @debited_funds end |
#debited_wallet_id ⇒ Object
- String
-
ID of the wallet that was debited from
22 23 24 |
# File 'lib/mangopay/model/entity/transaction.rb', line 22 def debited_wallet_id @debited_wallet_id end |
#execution_date ⇒ Object
- Integer
-
Time of execution of the transaction (UNIX timestamp)
44 45 46 |
# File 'lib/mangopay/model/entity/transaction.rb', line 44 def execution_date @execution_date end |
#fees ⇒ Object
- Money
-
Information about the fees that were taken by the client
for this transaction (and transferred to the client’s platform’s wallet)
19 20 21 |
# File 'lib/mangopay/model/entity/transaction.rb', line 19 def fees @fees end |
#nature ⇒ Object
- TransactionNature
-
Nature of the transaction
38 39 40 |
# File 'lib/mangopay/model/entity/transaction.rb', line 38 def nature @nature end |
#result_code ⇒ Object
- String
-
Its result code
47 48 49 |
# File 'lib/mangopay/model/entity/transaction.rb', line 47 def result_code @result_code end |
#result_message ⇒ Object
- String
-
Verbal explanation of the result
50 51 52 |
# File 'lib/mangopay/model/entity/transaction.rb', line 50 def @result_message end |
#status ⇒ Object
- TransactionStatus
-
Status of the transaction
41 42 43 |
# File 'lib/mangopay/model/entity/transaction.rb', line 41 def status @status end |
#type ⇒ Object
- TransactionType
-
Type of the transaction
35 36 37 |
# File 'lib/mangopay/model/entity/transaction.rb', line 35 def type @type end |