Class: Stripe::Treasury::OutboundPaymentService

Inherits:
StripeService show all
Defined in:
lib/stripe/services/treasury/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

Cancel an OutboundPayment.



266
267
268
269
270
271
272
273
274
 
# File 'lib/stripe/services/treasury/outbound_payment_service.rb', line 266

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.



277
278
279
280
281
282
283
284
285
 
# File 'lib/stripe/services/treasury/outbound_payment_service.rb', line 277

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.



288
289
290
291
292
293
294
295
296
 
# File 'lib/stripe/services/treasury/outbound_payment_service.rb', line 288

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.



299
300
301
302
303
304
305
306
307
 
# File 'lib/stripe/services/treasury/outbound_payment_service.rb', line 299

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