mirror of
https://github.com/stripe/stripe-ruby.git
synced 2025-12-07 00:00:35 -05:00
d2c09c3b50
* Update generated code for v1399 * Update generated code for v1409 * Update generated code for v1412 * Update generated code for v1412 --------- Co-authored-by: Stripe OpenAPI <105521251+stripe-openapi[bot]@users.noreply.github.com> Co-authored-by: jar-stripe <jar@stripe.com>
61 lines
1.8 KiB
Ruby
61 lines
1.8 KiB
Ruby
# File generated from our OpenAPI spec
|
|
# frozen_string_literal: true
|
|
|
|
module Stripe
|
|
# To top up your Stripe balance, you create a top-up object. You can retrieve
|
|
# individual top-ups, as well as list all top-ups. Top-ups are identified by a
|
|
# unique, random ID.
|
|
#
|
|
# Related guide: [Topping up your platform account](https://stripe.com/docs/connect/top-ups)
|
|
class Topup < APIResource
|
|
extend Stripe::APIOperations::Create
|
|
extend Stripe::APIOperations::List
|
|
include Stripe::APIOperations::Save
|
|
|
|
OBJECT_NAME = "topup"
|
|
def self.object_name
|
|
"topup"
|
|
end
|
|
|
|
# Cancels a top-up. Only pending top-ups can be canceled.
|
|
def cancel(params = {}, opts = {})
|
|
request_stripe_object(
|
|
method: :post,
|
|
path: format("/v1/topups/%<topup>s/cancel", { topup: CGI.escape(self["id"]) }),
|
|
params: params,
|
|
opts: opts
|
|
)
|
|
end
|
|
|
|
# Cancels a top-up. Only pending top-ups can be canceled.
|
|
def self.cancel(topup, params = {}, opts = {})
|
|
request_stripe_object(
|
|
method: :post,
|
|
path: format("/v1/topups/%<topup>s/cancel", { topup: CGI.escape(topup) }),
|
|
params: params,
|
|
opts: opts
|
|
)
|
|
end
|
|
|
|
# Top up the balance of an account
|
|
def self.create(params = {}, opts = {})
|
|
request_stripe_object(method: :post, path: "/v1/topups", params: params, opts: opts)
|
|
end
|
|
|
|
# Returns a list of top-ups.
|
|
def self.list(params = {}, opts = {})
|
|
request_stripe_object(method: :get, path: "/v1/topups", params: params, opts: opts)
|
|
end
|
|
|
|
# Updates the metadata of a top-up. Other top-up details are not editable by design.
|
|
def self.update(id, params = {}, opts = {})
|
|
request_stripe_object(
|
|
method: :post,
|
|
path: format("/v1/topups/%<id>s", { id: CGI.escape(id) }),
|
|
params: params,
|
|
opts: opts
|
|
)
|
|
end
|
|
end
|
|
end
|