Class: Stripe::Treasury::OutboundPaymentService

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

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.



8
9
10
11
12
13
14
15
16
 
# File 'lib/stripe/services/treasury/outbound_payment_service.rb', line 8

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.



19
20
21
22
23
24
25
26
27
 
# File 'lib/stripe/services/treasury/outbound_payment_service.rb', line 19

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.



30
31
32
33
34
35
36
37
38
 
# File 'lib/stripe/services/treasury/outbound_payment_service.rb', line 30

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.



41
42
43
44
45
46
47
48
49
 
# File 'lib/stripe/services/treasury/outbound_payment_service.rb', line 41

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