class

Stripe::Topup

Inherits OpenApi::Json < OpenApi::Validatable < JSON::Serializable::Unmapped < JSON::Serializable < Reference < Object

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

Constants

ERROR_MESSAGE_FOR_OBJECT = "invalid value for \"object\", must be one of [topup]."

ERROR_MESSAGE_FOR_STATUS = "invalid value for \"status\", must be one of [canceled, failed, pending, reversed, succeeded]."

MAX_LENGTH_FOR_CURRENCY = 5000

MAX_LENGTH_FOR_DESCRIPTION = 5000

MAX_LENGTH_FOR_FAILURE_CODE = 5000

MAX_LENGTH_FOR_FAILURE_MESSAGE = 5000

MAX_LENGTH_FOR_ID = 5000

MAX_LENGTH_FOR_STATEMENT_DESCRIPTOR = 5000

MAX_LENGTH_FOR_TRANSFER_GROUP = 5000

VALID_VALUES_FOR_OBJECT = String.static_array("topup")

VALID_VALUES_FOR_STATUS = String.static_array("canceled", "failed", "pending", "reversed", "succeeded")

Constructors

new(pull : JSON::PullParser)

Source

new(*, __pull_for_json_serializable pull : JSON::PullParser)

Source

Initializes the object @param [Hash] attributes Model attributes in the form of hash

Source

Instance methods

==(other : self)

Generates #hash and #== methods from all fields #== @return [Bool] #hash calculates hash code according to all attributes. #hash @return [UInt64] Hash code

amount

Amount transferred.

Source

amount=(new_value : Int64 | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] amount Object to be assigned

Source

balance_transaction

Source

balance_transaction=(new_value : Stripe::TopupBalanceTransaction | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] balance_transaction Object to be assigned

Source

created

Time at which the object was created. Measured in seconds since the Unix epoch.

Source

created=(new_value : Int64 | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] created Object to be assigned

Source

currency

Three-letter ISO currency code, in lowercase. Must be a supported currency.

Source

currency=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] currency Object to be assigned

Source

description

An arbitrary string attached to the object. Often useful for displaying to users.

Source

description=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] description Object to be assigned

Source

expected_availability_date

Date the funds are expected to arrive in your Stripe account for payouts. This factors in delays like weekends or bank holidays. May not be specified depending on status of top-up.

Source

expected_availability_date=(new_value : Int64 | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] expected_availability_date Object to be assigned

Source

failure_code

Error code explaining reason for top-up failure if available (see the errors section for a list of codes).

Source

failure_code=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] failure_code Object to be assigned

Source

failure_message

Message to user further explaining reason for top-up failure if available.

Source

failure_message=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] failure_message Object to be assigned

Source

hash(hasher)

Generates #hash and #== methods from all fields #== @return [Bool] #hash calculates hash code according to all attributes. #hash @return [UInt64] Hash code

Unique identifier for the object.

Source

id=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] id Object to be assigned

Source

list_invalid_properties

Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons

Source

livemode

Has the value true if the object exists in live mode or the value false if the object exists in test mode.

Source

livemode=(new_value : Bool | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] livemode Object to be assigned

Source

metadata

Source

metadata=(new_value : Hash(String, String) | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] metadata Object to be assigned

Source

object

String representing the object's type. Objects of the same type share the same value.

Source

object=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] object Object to be assigned

Source

source

Source

source=(new_value : Stripe::TopupSource | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] source Object to be assigned

Source

statement_descriptor

Extra information about a top-up. This will appear on your source's bank statement. It must contain at least one letter.

Source

statement_descriptor=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] statement_descriptor Object to be assigned

Source

status

The status of the top-up is either canceled, failed, pending, reversed, or succeeded.

Source

status=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] status Object to be assigned

Source

transfer_group

A string that identifies this top-up as part of a group.

Source

transfer_group=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] transfer_group Object to be assigned

Source

valid?

Check to see if the all the properties in the model are valid @return true if the model is valid

Source