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

Inherits:
StripeService
  • Object
show all
Defined in:
lib/stripe/services/v2/money_management/outbound_transfer_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

Cancels an OutboundTransfer. Only processing OutboundTransfers can be canceled.

** raises AlreadyCanceledError ** raises NotCancelableError



127
128
129
130
131
132
133
134
135
 
# File 'lib/stripe/services/v2/money_management/outbound_transfer_service.rb', line 127

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



140
141
142
143
144
145
146
147
148
 
# File 'lib/stripe/services/v2/money_management/outbound_transfer_service.rb', line 140

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.



151
152
153
154
155
156
157
158
159
 
# File 'lib/stripe/services/v2/money_management/outbound_transfer_service.rb', line 151

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.



162
163
164
165
166
167
168
169
170
 
# File 'lib/stripe/services/v2/money_management/outbound_transfer_service.rb', line 162

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