class

Stripe::Payout

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

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

Constants

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)
Source
new(*, __pull_for_json_serializable pull : JSON::PullParser)
Source
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

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

_type

Can be bank_account or card.

Source
_type=(new_value : String | Nil)

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

Source
amount

The amount (in cents (or local equivalent)) that transfers to your bank account or debit card.

Source
amount=(new_value : Int64 | Nil)

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

Source
application_fee
Source
application_fee=(new_value : Stripe::PayoutApplicationFee | Nil)

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

Source
application_fee_amount

The amount of the application fee (if any) requested for the payout. See the Connect documentation for details.

Source
application_fee_amount=(new_value : Int64 | Nil)

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

Source
arrival_date

Date that you can expect the payout to arrive in the bank. This factors in delays to account for weekends or bank holidays.

Source
arrival_date=(new_value : Int64 | Nil)

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

Source
automatic

Returns true if the payout is created by an automated payout schedule and false if it's requested manually.

Source
automatic=(new_value : Bool | Nil)

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

Source
balance_transaction
Source
balance_transaction=(new_value : Stripe::PayoutBalanceTransaction | 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
destination
Source
destination=(new_value : Stripe::PayoutDestination | Nil)

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

Source
failure_balance_transaction
Source
failure_balance_transaction=(new_value : Stripe::PayoutFailureBalanceTransaction | Nil)

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

Source
failure_code

Error code that provides a reason for a payout failure, if available. View our list of failure 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 that provides the reason for a payout 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

id

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
method

The method used to send this payout, which can be standard or instant. instant is supported for payouts to debit cards and bank accounts in certain countries. Learn more about bank support for Instant Payouts.

Source
method=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] method 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
original_payout
Source
original_payout=(new_value : Stripe::PayoutOriginalPayout | Nil)

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

Source
reconciliation_status

If completed, you can use the Balance Transactions API to list all balance transactions that are paid out in this payout.

Source
reconciliation_status=(new_value : String | Nil)

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

Source
reversed_by
Source
reversed_by=(new_value : Stripe::PayoutReversedBy | Nil)

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

Source
source_type

The source balance this payout came from, which can be one of the following: card, fpx, or bank_account.

Source
source_type=(new_value : String | Nil)

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

Source
statement_descriptor

Extra information about a payout that displays on the user's bank statement.

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

Current status of the payout: paid, pending, in_transit, canceled or failed. A payout is pending until it's submitted to the bank, when it becomes in_transit. The status changes to paid if the transaction succeeds, or to failed or canceled (within 5 business days). Some payouts that fail might initially show as paid, then change to failed.

Source
status=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] status 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