Class: Stripe::Treasury::OutboundTransferService

Inherits:
StripeService show all
Defined in:
lib/stripe/services/treasury/outbound_transfer_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(outbound_transfer, params = {}, opts = {}) ⇒ Object

An OutboundTransfer can be canceled if the funds have not yet been paid out.



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

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

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

Creates an OutboundTransfer.



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

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

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

Returns a list of OutboundTransfers sent from the specified FinancialAccount.



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

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

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

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



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

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