class Stripe::Topup

• Stripe::Topup
• Reference
• Object

Overview

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

Included Modules

• JSON::Serializable
• JSON::Serializable::Unmapped
• OpenApi::Json
• OpenApi::Validatable

Defined in:

Constant Summary

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)
• .new(*, amount : Int64 | Nil = nil, balance_transaction : Stripe::TopupBalanceTransaction | Nil = nil, created : Int64 | Nil = nil, currency : String | Nil = nil, description : String | Nil = nil, expected_availability_date : Int64 | Nil = nil, failure_code : String | Nil = nil, failure_message : String | Nil = nil, id : String | Nil = nil, livemode : Bool | Nil = nil, metadata : Hash(String, String) | Nil = nil, object : String | Nil = nil, source : Stripe::TopupSource | Nil = nil, statement_descriptor : String | Nil = nil, status : String | Nil = nil, transfer_group : String | Nil = nil)

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

Instance Method Summary

• #==(other : self)

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

• #amount : Int64 | Nil
• #amount=(new_value : Int64 | Nil)

  Custom attribute writer method checking allowed values (enum).

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

  Custom attribute writer method checking allowed values (enum).

• #created : Int64 | Nil
• #created=(new_value : Int64 | Nil)

  Custom attribute writer method checking allowed values (enum).

• #currency : String | Nil
• #currency=(new_value : String | Nil)

  Custom attribute writer method checking allowed values (enum).

• #description : String | Nil
• #description=(new_value : String | Nil)

  Custom attribute writer method checking allowed values (enum).

• #expected_availability_date : Int64 | Nil
• #expected_availability_date=(new_value : Int64 | Nil)

  Custom attribute writer method checking allowed values (enum).

• #failure_code : String | Nil
• #failure_code=(new_value : String | Nil)

  Custom attribute writer method checking allowed values (enum).

• #failure_message : String | Nil
• #failure_message=(new_value : String | Nil)

  Custom attribute writer method checking allowed values (enum).

• #hash(hasher)

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

• #id : String | Nil
• #id=(new_value : String | Nil)

  Custom attribute writer method checking allowed values (enum).

• #list_invalid_properties : Array(String)

  Show invalid properties with the reasons.

• #livemode : Bool | Nil
• #livemode=(new_value : Bool | Nil)

  Custom attribute writer method checking allowed values (enum).

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

  Custom attribute writer method checking allowed values (enum).

• #object : String | Nil
• #object=(new_value : String | Nil)

  Custom attribute writer method checking allowed values (enum).

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

  Custom attribute writer method checking allowed values (enum).

• #statement_descriptor : String | Nil
• #statement_descriptor=(new_value : String | Nil)

  Custom attribute writer method checking allowed values (enum).

• #status : String | Nil
• #status=(new_value : String | Nil)

  Custom attribute writer method checking allowed values (enum).

• #transfer_group : String | Nil
• #transfer_group=(new_value : String | Nil)

  Custom attribute writer method checking allowed values (enum).

• #valid? : Bool

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

Constructor Detail

Instance Method Detail