Class: Recurly::Resources::Transaction
- Inherits:
-
Recurly::Resource
- Object
- Recurly::Resource
- Recurly::Resources::Transaction
- Defined in:
- lib/recurly/resources/transaction.rb
Instance Attribute Summary collapse
-
#account ⇒ AccountMini
Account mini details.
-
#amount ⇒ Float
Total transaction amount sent to the payment gateway.
-
#avs_check ⇒ String
When processed, result from checking the overall AVS on the transaction.
-
#backup_payment_method_used ⇒ Boolean
Indicates if the transaction was completed using a backup payment.
- #billing_address ⇒ AddressWithName
-
#collected_at ⇒ DateTime
Collected at, or if not collected yet, the time the transaction was created.
-
#collection_method ⇒ String
The method by which the payment was collected.
-
#created_at ⇒ DateTime
Created at.
-
#currency ⇒ String
3-letter ISO 4217 currency code.
-
#customer_message ⇒ String
For declined (`success=false`) transactions, the message displayed to the customer.
-
#customer_message_locale ⇒ String
Language code for the message.
-
#cvv_check ⇒ String
When processed, result from checking the CVV/CVC value on the transaction.
-
#gateway_approval_code ⇒ String
Transaction approval code from the payment gateway.
-
#gateway_message ⇒ String
Transaction message from the payment gateway.
-
#gateway_reference ⇒ String
Transaction reference number from the payment gateway.
-
#gateway_response_code ⇒ String
For declined transactions (`success=false`), this field lists the gateway error code.
-
#gateway_response_time ⇒ Float
Time, in seconds, for gateway to process the transaction.
-
#gateway_response_values ⇒ Hash
The values in this field will vary from gateway to gateway.
-
#id ⇒ String
Transaction ID.
-
#invoice ⇒ InvoiceMini
Invoice mini details.
-
#ip_address_country ⇒ String
IP address's country.
-
#ip_address_v4 ⇒ String
IP address provided when the billing information was collected: - When the customer enters billing information into the Recurly.js or Hosted Payment Pages, Recurly records the IP address.
-
#object ⇒ String
Object type.
-
#origin ⇒ String
Describes how the transaction was triggered.
-
#original_transaction_id ⇒ String
If this transaction is a refund (`type=refund`), this will be the ID of the original transaction on the invoice being refunded.
- #payment_gateway ⇒ TransactionPaymentGateway
- #payment_method ⇒ PaymentMethod
-
#refunded ⇒ Boolean
Indicates if part or all of this transaction was refunded.
-
#status ⇒ String
The current transaction status.
-
#status_code ⇒ String
Status code.
-
#status_message ⇒ String
For declined (`success=false`) transactions, the message displayed to the merchant.
-
#subscription_ids ⇒ Array[String]
If the transaction is charging or refunding for one or more subscriptions, these are their IDs.
-
#success ⇒ Boolean
Did this transaction complete successfully?.
-
#type ⇒ String
-
`authorization` – verifies billing information and places a hold on money in the customer's account.
-
-
#updated_at ⇒ DateTime
Updated at.
-
#uuid ⇒ String
The UUID is useful for matching data with the CSV exports and building URLs into Recurly's UI.
-
#voided_at ⇒ DateTime
Voided at.
-
#voided_by_invoice ⇒ InvoiceMini
Invoice mini details.
Attributes inherited from Recurly::Resource
Method Summary
Methods inherited from Recurly::Resource
#==, #get_response, #inspect, #requires_client?, #to_json, #to_s
Methods included from Schema::SchemaFactory
Methods included from Schema::ResourceCaster
Methods included from Schema::SchemaValidator
#get_did_you_mean, #validate!, #validate_attribute!
Instance Attribute Details
#account ⇒ AccountMini
Returns Account mini details.
11 |
# File 'lib/recurly/resources/transaction.rb', line 11 define_attribute :account, :AccountMini |
#amount ⇒ Float
Returns Total transaction amount sent to the payment gateway.
15 |
# File 'lib/recurly/resources/transaction.rb', line 15 define_attribute :amount, Float |
#avs_check ⇒ String
Returns When processed, result from checking the overall AVS on the transaction.
19 |
# File 'lib/recurly/resources/transaction.rb', line 19 define_attribute :avs_check, String |
#backup_payment_method_used ⇒ Boolean
Returns Indicates if the transaction was completed using a backup payment.
23 |
# File 'lib/recurly/resources/transaction.rb', line 23 define_attribute :backup_payment_method_used, :Boolean |
#billing_address ⇒ AddressWithName
27 |
# File 'lib/recurly/resources/transaction.rb', line 27 define_attribute :billing_address, :AddressWithName |
#collected_at ⇒ DateTime
Returns Collected at, or if not collected yet, the time the transaction was created.
31 |
# File 'lib/recurly/resources/transaction.rb', line 31 define_attribute :collected_at, DateTime |
#collection_method ⇒ String
Returns The method by which the payment was collected.
35 |
# File 'lib/recurly/resources/transaction.rb', line 35 define_attribute :collection_method, String |
#created_at ⇒ DateTime
Returns Created at.
39 |
# File 'lib/recurly/resources/transaction.rb', line 39 define_attribute :created_at, DateTime |
#currency ⇒ String
Returns 3-letter ISO 4217 currency code.
43 |
# File 'lib/recurly/resources/transaction.rb', line 43 define_attribute :currency, String |
#customer_message ⇒ String
Returns For declined (`success=false`) transactions, the message displayed to the customer.
47 |
# File 'lib/recurly/resources/transaction.rb', line 47 define_attribute :customer_message, String |
#customer_message_locale ⇒ String
Returns Language code for the message.
51 |
# File 'lib/recurly/resources/transaction.rb', line 51 define_attribute :customer_message_locale, String |
#cvv_check ⇒ String
Returns When processed, result from checking the CVV/CVC value on the transaction.
55 |
# File 'lib/recurly/resources/transaction.rb', line 55 define_attribute :cvv_check, String |
#gateway_approval_code ⇒ String
Returns Transaction approval code from the payment gateway.
59 |
# File 'lib/recurly/resources/transaction.rb', line 59 define_attribute :gateway_approval_code, String |
#gateway_message ⇒ String
Returns Transaction message from the payment gateway.
63 |
# File 'lib/recurly/resources/transaction.rb', line 63 define_attribute :gateway_message, String |
#gateway_reference ⇒ String
Returns Transaction reference number from the payment gateway.
67 |
# File 'lib/recurly/resources/transaction.rb', line 67 define_attribute :gateway_reference, String |
#gateway_response_code ⇒ String
Returns For declined transactions (`success=false`), this field lists the gateway error code.
71 |
# File 'lib/recurly/resources/transaction.rb', line 71 define_attribute :gateway_response_code, String |
#gateway_response_time ⇒ Float
Returns Time, in seconds, for gateway to process the transaction.
75 |
# File 'lib/recurly/resources/transaction.rb', line 75 define_attribute :gateway_response_time, Float |
#gateway_response_values ⇒ Hash
Returns The values in this field will vary from gateway to gateway.
79 |
# File 'lib/recurly/resources/transaction.rb', line 79 define_attribute :gateway_response_values, Hash |
#id ⇒ String
Returns Transaction ID.
83 |
# File 'lib/recurly/resources/transaction.rb', line 83 define_attribute :id, String |
#invoice ⇒ InvoiceMini
Returns Invoice mini details.
87 |
# File 'lib/recurly/resources/transaction.rb', line 87 define_attribute :invoice, :InvoiceMini |
#ip_address_country ⇒ String
Returns IP address's country.
91 |
# File 'lib/recurly/resources/transaction.rb', line 91 define_attribute :ip_address_country, String |
#ip_address_v4 ⇒ String
Returns IP address provided when the billing information was collected: - When the customer enters billing information into the Recurly.js or Hosted Payment Pages, Recurly records the IP address. - When the merchant enters billing information using the API, the merchant may provide an IP address. - When the merchant enters billing information using the UI, no IP address is recorded.
95 |
# File 'lib/recurly/resources/transaction.rb', line 95 define_attribute :ip_address_v4, String |
#object ⇒ String
Returns Object type.
99 |
# File 'lib/recurly/resources/transaction.rb', line 99 define_attribute :object, String |
#origin ⇒ String
Returns Describes how the transaction was triggered.
103 |
# File 'lib/recurly/resources/transaction.rb', line 103 define_attribute :origin, String |
#original_transaction_id ⇒ String
Returns If this transaction is a refund (`type=refund`), this will be the ID of the original transaction on the invoice being refunded.
107 |
# File 'lib/recurly/resources/transaction.rb', line 107 define_attribute :original_transaction_id, String |
#payment_gateway ⇒ TransactionPaymentGateway
111 |
# File 'lib/recurly/resources/transaction.rb', line 111 define_attribute :payment_gateway, :TransactionPaymentGateway |
#payment_method ⇒ PaymentMethod
115 |
# File 'lib/recurly/resources/transaction.rb', line 115 define_attribute :payment_method, :PaymentMethod |
#refunded ⇒ Boolean
Returns Indicates if part or all of this transaction was refunded.
119 |
# File 'lib/recurly/resources/transaction.rb', line 119 define_attribute :refunded, :Boolean |
#status ⇒ String
Returns The current transaction status. Note that the status may change, e.g. a `pending` transaction may become `declined` or `success` may later become `void`.
123 |
# File 'lib/recurly/resources/transaction.rb', line 123 define_attribute :status, String |
#status_code ⇒ String
Returns Status code.
127 |
# File 'lib/recurly/resources/transaction.rb', line 127 define_attribute :status_code, String |
#status_message ⇒ String
Returns For declined (`success=false`) transactions, the message displayed to the merchant.
131 |
# File 'lib/recurly/resources/transaction.rb', line 131 define_attribute :status_message, String |
#subscription_ids ⇒ Array[String]
Returns If the transaction is charging or refunding for one or more subscriptions, these are their IDs.
135 |
# File 'lib/recurly/resources/transaction.rb', line 135 define_attribute :subscription_ids, Array, { :item_type => String } |
#success ⇒ Boolean
Returns Did this transaction complete successfully?.
139 |
# File 'lib/recurly/resources/transaction.rb', line 139 define_attribute :success, :Boolean |
#type ⇒ String
Returns - `authorization` – verifies billing information and places a hold on money in the customer's account. - `capture` – captures funds held by an authorization and completes a purchase. - `purchase` – combines the authorization and capture in one transaction. - `refund` – returns all or a portion of the money collected in a previous transaction to the customer. - `verify` – a $0 or $1 transaction used to verify billing information which is immediately voided.
143 |
# File 'lib/recurly/resources/transaction.rb', line 143 define_attribute :type, String |
#updated_at ⇒ DateTime
Returns Updated at.
147 |
# File 'lib/recurly/resources/transaction.rb', line 147 define_attribute :updated_at, DateTime |
#uuid ⇒ String
Returns The UUID is useful for matching data with the CSV exports and building URLs into Recurly's UI.
151 |
# File 'lib/recurly/resources/transaction.rb', line 151 define_attribute :uuid, String |
#voided_at ⇒ DateTime
Returns Voided at.
155 |
# File 'lib/recurly/resources/transaction.rb', line 155 define_attribute :voided_at, DateTime |
#voided_by_invoice ⇒ InvoiceMini
Returns Invoice mini details.
159 |
# File 'lib/recurly/resources/transaction.rb', line 159 define_attribute :voided_by_invoice, :InvoiceMini |