Class: Stripe::Treasury::OutboundPaymentService

Inherits:
StripeService show all
Defined in:
lib/stripe/services/treasury/outbound_payment_service.rb

Defined Under Namespace

Classes: CancelParams, CreateParams, ListParams, RetrieveParams

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 an OutboundPayment.



269
270
271
272
273
274
275
276
277
 
# File 'lib/stripe/services/treasury/outbound_payment_service.rb', line 269

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

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

Creates an OutboundPayment.



280
281
282
283
284
285
286
287
288
 
# File 'lib/stripe/services/treasury/outbound_payment_service.rb', line 280

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

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

Returns a list of OutboundPayments sent from the specified FinancialAccount.



291
292
293
294
295
296
297
298
299
 
# File 'lib/stripe/services/treasury/outbound_payment_service.rb', line 291

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

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

Retrieves the details of an existing OutboundPayment by passing the unique OutboundPayment ID from either the OutboundPayment creation request or OutboundPayment list.



302
303
304
305
306
307
308
309
310
 
# File 'lib/stripe/services/treasury/outbound_payment_service.rb', line 302

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