Class: Stripe::GiftCards::Transaction::CreateParams

Inherits:
RequestParams
  • Object
show all
Defined in:
lib/stripe/resources/gift_cards/transaction.rb

Defined Under Namespace

Classes: CreatedBy

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from RequestParams

#to_h

Constructor Details

#initialize(amount: nil, confirm: nil, created_by: nil, currency: nil, description: nil, expand: nil, gift_card: nil, metadata: nil, transfer_group: nil) ⇒ CreateParams

Returns a new instance of CreateParams.



121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
 
# File 'lib/stripe/resources/gift_cards/transaction.rb', line 121

def initialize(
  amount: nil,
  confirm: nil,
  created_by: nil,
  currency: nil,
  description: nil,
  expand: nil,
  gift_card: nil,
  metadata: nil,
  transfer_group: nil
)
  @amount = amount
  @confirm = confirm
  @created_by = created_by
  @currency = currency
  @description = description
  @expand = expand
  @gift_card = gift_card
  @metadata = metadata
  @transfer_group = transfer_group
end

Instance Attribute Details

#amount ⇒ Object

The amount of the transaction. A negative amount deducts funds, and a positive amount adds funds.



103
104
105
 
# File 'lib/stripe/resources/gift_cards/transaction.rb', line 103

def amount
  @amount
end

#confirm ⇒ Object

Whether this is a confirmed transaction. A confirmed transaction immediately deducts from/adds to the ‘amount_available` on the gift card. Otherwise, it creates a held transaction that increments the `amount_held` on the gift card.



105
106
107
 
# File 'lib/stripe/resources/gift_cards/transaction.rb', line 105

def confirm
  @confirm
end

#created_by ⇒ Object

Related objects which created this transaction.



107
108
109
 
# File 'lib/stripe/resources/gift_cards/transaction.rb', line 107

def created_by
  @created_by
end

#currency ⇒ Object

The currency of the transaction. This must match the currency of the gift card.



109
110
111
 
# File 'lib/stripe/resources/gift_cards/transaction.rb', line 109

def currency
  @currency
end

#description ⇒ Object

An arbitrary string attached to the object. Often useful for displaying to users.



111
112
113
 
# File 'lib/stripe/resources/gift_cards/transaction.rb', line 111

def description
  @description
end

#expand ⇒ Object

Specifies which fields in the response should be expanded.



113
114
115
 
# File 'lib/stripe/resources/gift_cards/transaction.rb', line 113

def expand
  @expand
end

#gift_card ⇒ Object

The gift card to create a new transaction on.



115
116
117
 
# File 'lib/stripe/resources/gift_cards/transaction.rb', line 115

def gift_card
  @gift_card
end

#metadata ⇒ Object

Set of [key-value pairs](stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to ‘metadata`.



117
118
119
 
# File 'lib/stripe/resources/gift_cards/transaction.rb', line 117

def metadata
  @metadata
end

#transfer_group ⇒ Object

A string that identifies this transaction as part of a group. See the [Connect documentation](stripe.com/docs/connect/separate-charges-and-transfers) for details.



119
120
121
 
# File 'lib/stripe/resources/gift_cards/transaction.rb', line 119

def transfer_group
  @transfer_group
end