Class: Stripe::GiftCards::TransactionService

Inherits:
StripeService show all
Defined in:
lib/stripe/services/gift_cards/transaction_service.rb

Defined Under Namespace

Classes: CancelParams, ConfirmParams, CreateParams, ListParams, RetrieveParams, UpdateParams

Instance Method Summary collapse

Methods inherited from StripeService

#initialize, #request, #request_stream

Constructor Details

This class inherits a constructor from Stripe::StripeService

Instance Method Details

#cancel(id, params = {}, opts = {}) ⇒ Object

Cancel a gift card transaction



159
160
161
162
163
164
165
166
167
 
# File 'lib/stripe/services/gift_cards/transaction_service.rb', line 159

def cancel(id, params = {}, opts = {})
  request(
    method: :post,
    path: format("/v1/gift_cards/transactions/%<id>s/cancel", { id: CGI.escape(id) }),
    params: params,
    opts: opts,
    base_address: :api
  )
end

#confirm(id, params = {}, opts = {}) ⇒ Object

Confirm a gift card transaction



170
171
172
173
174
175
176
177
178
 
# File 'lib/stripe/services/gift_cards/transaction_service.rb', line 170

def confirm(id, params = {}, opts = {})
  request(
    method: :post,
    path: format("/v1/gift_cards/transactions/%<id>s/confirm", { id: CGI.escape(id) }),
    params: params,
    opts: opts,
    base_address: :api
  )
end

#create(params = {}, opts = {}) ⇒ Object

Create a gift card transaction



181
182
183
184
185
186
187
188
189
 
# File 'lib/stripe/services/gift_cards/transaction_service.rb', line 181

def create(params = {}, opts = {})
  request(
    method: :post,
    path: "/v1/gift_cards/transactions",
    params: params,
    opts: opts,
    base_address: :api
  )
end

#list(params = {}, opts = {}) ⇒ Object

List gift card transactions for a gift card



192
193
194
195
196
197
198
199
200
 
# File 'lib/stripe/services/gift_cards/transaction_service.rb', line 192

def list(params = {}, opts = {})
  request(
    method: :get,
    path: "/v1/gift_cards/transactions",
    params: params,
    opts: opts,
    base_address: :api
  )
end

#retrieve(id, params = {}, opts = {}) ⇒ Object

Retrieves the gift card transaction.



203
204
205
206
207
208
209
210
211
 
# File 'lib/stripe/services/gift_cards/transaction_service.rb', line 203

def retrieve(id, params = {}, opts = {})
  request(
    method: :get,
    path: format("/v1/gift_cards/transactions/%<id>s", { id: CGI.escape(id) }),
    params: params,
    opts: opts,
    base_address: :api
  )
end

#update(id, params = {}, opts = {}) ⇒ Object

Update a gift card transaction



214
215
216
217
218
219
220
221
222
 
# File 'lib/stripe/services/gift_cards/transaction_service.rb', line 214

def update(id, params = {}, opts = {})
  request(
    method: :post,
    path: format("/v1/gift_cards/transactions/%<id>s", { id: CGI.escape(id) }),
    params: params,
    opts: opts,
    base_address: :api
  )
end