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



143
144
145
146
147
148
149
150
151
 
# File 'lib/stripe/services/gift_cards/transaction_service.rb', line 143

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



154
155
156
157
158
159
160
161
162
 
# File 'lib/stripe/services/gift_cards/transaction_service.rb', line 154

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



165
166
167
168
169
170
171
172
173
 
# File 'lib/stripe/services/gift_cards/transaction_service.rb', line 165

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



176
177
178
179
180
181
182
183
184
 
# File 'lib/stripe/services/gift_cards/transaction_service.rb', line 176

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.



187
188
189
190
191
192
193
194
195
 
# File 'lib/stripe/services/gift_cards/transaction_service.rb', line 187

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



198
199
200
201
202
203
204
205
206
 
# File 'lib/stripe/services/gift_cards/transaction_service.rb', line 198

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