Class: Stripe::V2::MoneyManagement::OutboundPaymentService

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

Cancels an OutboundPayment. Only processing OutboundPayments can be canceled.

** raises AlreadyCanceledError ** raises NotCancelableError



149
150
151
152
153
154
155
156
157
 
# File 'lib/stripe/services/v2/money_management/outbound_payment_service.rb', line 149

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

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

Creates an OutboundPayment.

** raises InsufficientFundsError ** raises QuotaExceededError ** raises RecipientNotNotifiableError ** raises FeatureNotEnabledError



165
166
167
168
169
170
171
172
173
 
# File 'lib/stripe/services/v2/money_management/outbound_payment_service.rb', line 165

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

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

Returns a list of OutboundPayments that match the provided filters.



176
177
178
179
180
181
182
183
184
 
# File 'lib/stripe/services/v2/money_management/outbound_payment_service.rb', line 176

def list(params = {}, opts = {})
  request(
    method: :get,
    path: "/v2/money_management/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 create or list response.



187
188
189
190
191
192
193
194
195
 
# File 'lib/stripe/services/v2/money_management/outbound_payment_service.rb', line 187

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