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.



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

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.



315
316
317
318
319
320
321
322
323
 
# File 'lib/stripe/services/treasury/outbound_payment_service.rb', line 315

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.



326
327
328
329
330
331
332
333
334
 
# File 'lib/stripe/services/treasury/outbound_payment_service.rb', line 326

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.



337
338
339
340
341
342
343
344
345
 
# File 'lib/stripe/services/treasury/outbound_payment_service.rb', line 337

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