Class: Stripe::V2::MoneyManagement::OutboundTransferService

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

Cancels an OutboundTransfer. Only processing OutboundTransfers can be canceled.

** raises AlreadyCanceledError ** raises NotCancelableError



12
13
14
15
16
17
18
19
20
 
# File 'lib/stripe/services/v2/money_management/outbound_transfer_service.rb', line 12

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

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

Creates an OutboundTransfer.

** raises InsufficientFundsError ** raises FeatureNotEnabledError



26
27
28
29
30
31
32
33
34
 
# File 'lib/stripe/services/v2/money_management/outbound_transfer_service.rb', line 26

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

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

Returns a list of OutboundTransfers that match the provided filters.



37
38
39
40
41
42
43
44
45
 
# File 'lib/stripe/services/v2/money_management/outbound_transfer_service.rb', line 37

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

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

Retrieves the details of an existing OutboundTransfer by passing the unique OutboundTransfer ID from either the OutboundPayment create or list response.



48
49
50
51
52
53
54
55
56
 
# File 'lib/stripe/services/v2/money_management/outbound_transfer_service.rb', line 48

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