class Stripe::Payout

• Stripe::Payout
• Reference
• Object

Overview

A Payout object is created when you receive funds from Stripe, or when you initiate a payout to either a bank account or debit card of a connected Stripe account. You can retrieve individual payouts, and list all payouts. Payouts are made on varying schedules, depending on your country and industry. Related guide: Receiving payouts

Included Modules

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

Defined in:

Constant Summary

ERROR_MESSAGE_FOR__TYPE = "invalid value for \"_type\", must be one of [bank_account, card]."

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

ERROR_MESSAGE_FOR_RECONCILIATION_STATUS = "invalid value for \"reconciliation_status\", must be one of [completed, in_progress, not_applicable]."

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_METHOD = 5000

MAX_LENGTH_FOR_SOURCE_TYPE = 5000

MAX_LENGTH_FOR_STATEMENT_DESCRIPTOR = 5000

MAX_LENGTH_FOR_STATUS = 5000

VALID_VALUES_FOR__TYPE = String.static_array("bank_account", "card")

VALID_VALUES_FOR_OBJECT = String.static_array("payout")

VALID_VALUES_FOR_RECONCILIATION_STATUS = String.static_array("completed", "in_progress", "not_applicable")

Constructors

• .new(pull : JSON::PullParser)
• .new(*, amount : Int64 | Nil = nil, application_fee : Stripe::PayoutApplicationFee | Nil = nil, application_fee_amount : Int64 | Nil = nil, arrival_date : Int64 | Nil = nil, automatic : Bool | Nil = nil, balance_transaction : Stripe::PayoutBalanceTransaction | Nil = nil, created : Int64 | Nil = nil, currency : String | Nil = nil, description : String | Nil = nil, destination : Stripe::PayoutDestination | Nil = nil, failure_balance_transaction : Stripe::PayoutFailureBalanceTransaction | 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, method : String | Nil = nil, object : String | Nil = nil, original_payout : Stripe::PayoutOriginalPayout | Nil = nil, reconciliation_status : String | Nil = nil, reversed_by : Stripe::PayoutReversedBy | Nil = nil, source_type : String | Nil = nil, statement_descriptor : String | Nil = nil, status : String | Nil = nil, _type : 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.

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

  Custom attribute writer method checking allowed values (enum).

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

  Custom attribute writer method checking allowed values (enum).

• #application_fee : Stripe::PayoutApplicationFee | Nil
• #application_fee=(new_value : Stripe::PayoutApplicationFee | Nil)

  Custom attribute writer method checking allowed values (enum).

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

  Custom attribute writer method checking allowed values (enum).

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

  Custom attribute writer method checking allowed values (enum).

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

  Custom attribute writer method checking allowed values (enum).

• #balance_transaction : Stripe::PayoutBalanceTransaction | Nil
• #balance_transaction=(new_value : Stripe::PayoutBalanceTransaction | 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).

• #destination : Stripe::PayoutDestination | Nil
• #destination=(new_value : Stripe::PayoutDestination | Nil)

  Custom attribute writer method checking allowed values (enum).

• #failure_balance_transaction : Stripe::PayoutFailureBalanceTransaction | Nil
• #failure_balance_transaction=(new_value : Stripe::PayoutFailureBalanceTransaction | 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).

• #method : String | Nil
• #method=(new_value : 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).

• #original_payout : Stripe::PayoutOriginalPayout | Nil
• #original_payout=(new_value : Stripe::PayoutOriginalPayout | Nil)

  Custom attribute writer method checking allowed values (enum).

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

  Custom attribute writer method checking allowed values (enum).

• #reversed_by : Stripe::PayoutReversedBy | Nil
• #reversed_by=(new_value : Stripe::PayoutReversedBy | Nil)

  Custom attribute writer method checking allowed values (enum).

• #source_type : String | Nil
• #source_type=(new_value : String | 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).

• #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