class Stripe::PayoutFailureBalanceTransaction

Overview

If the payout fails or cancels, this is the ID of the balance transaction that reverses the initial balance transaction and returns the funds from the failed payout back in your balance.

Included Modules

Defined in:

stripe/models/payout_failure_balance_transaction.cr

Constant Summary

ERROR_MESSAGE_FOR__TYPE = "invalid value for \"_type\", must be one of [adjustment, advance, advance_funding, anticipation_repayment, application_fee, application_fee_refund, charge, climate_order_purchase, climate_order_refund, connect_collection_transfer, contribution, issuing_authorization_hold, issuing_authorization_release, issuing_dispute, issuing_transaction, obligation_outbound, obligation_reversal_inbound, payment, payment_failure_refund, payment_network_reserve_hold, payment_network_reserve_release, payment_refund, payment_reversal, payment_unreconciled, payout, payout_cancel, payout_failure, refund, refund_failure, reserve_transaction, reserved_funds, stripe_fee, stripe_fx_fee, tax_fee, topup, topup_reversal, transfer, transfer_cancel, transfer_failure, transfer_refund]."
ERROR_MESSAGE_FOR_OBJECT = "invalid value for \"object\", must be one of [balance_transaction]."
MAX_LENGTH_FOR_DESCRIPTION = 5000
MAX_LENGTH_FOR_ID = 5000
MAX_LENGTH_FOR_REPORTING_CATEGORY = 5000
MAX_LENGTH_FOR_STATUS = 5000
VALID_VALUES_FOR__TYPE = String.static_array("adjustment", "advance", "advance_funding", "anticipation_repayment", "application_fee", "application_fee_refund", "charge", "climate_order_purchase", "climate_order_refund", "connect_collection_transfer", "contribution", "issuing_authorization_hold", "issuing_authorization_release", "issuing_dispute", "issuing_transaction", "obligation_outbound", "obligation_reversal_inbound", "payment", "payment_failure_refund", "payment_network_reserve_hold", "payment_network_reserve_release", "payment_refund", "payment_reversal", "payment_unreconciled", "payout", "payout_cancel", "payout_failure", "refund", "refund_failure", "reserve_transaction", "reserved_funds", "stripe_fee", "stripe_fx_fee", "tax_fee", "topup", "topup_reversal", "transfer", "transfer_cancel", "transfer_failure", "transfer_refund")
VALID_VALUES_FOR_OBJECT = String.static_array("balance_transaction")

Constructors

Class Method Summary

Instance Method Summary

Instance methods inherited from module OpenApi::Json

after_initialize after_initialize, eql?(o : self) eql?, to_hash : Hash(String, JSON::Any) to_hash, to_json_any : JSON::Any to_json_any

Class methods inherited from module OpenApi::Json

build_from_hash(hash : Hash) build_from_hash, build_from_json_any(json_any : JSON::Any) build_from_json_any

Instance methods inherited from module OpenApi::Validatable

list_invalid_properties : Array(String) list_invalid_properties, list_invalid_properties_for(key : String) : Array(String) list_invalid_properties_for, valid? : Bool valid?, validate : Nil validate

Constructor Detail

def self.new(pull : JSON::PullParser) #

[View source]
def self.new(*, amount : Int64 | Nil = nil, available_on : Int64 | Nil = nil, created : Int64 | Nil = nil, currency : String | Nil = nil, description : String | Nil = nil, exchange_rate : Float64 | Nil = nil, fee : Int64 | Nil = nil, fee_details : Array(Stripe::Fee) | Nil = nil, id : String | Nil = nil, net : Int64 | Nil = nil, object : String | Nil = nil, reporting_category : String | Nil = nil, source : Stripe::BalanceTransactionSource1 | Nil = nil, status : String | Nil = nil, _type : String | Nil = nil) #

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


[View source]

Class Method Detail

def self.openapi_any_of #

End of Required Properties List of class defined in anyOf (OpenAPI v3)


[View source]

Instance Method Detail

def ==(other : self) #

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


def _type : String | Nil #

[View source]
def _type=(_type : String | Nil) #

[View source]
def amount : Int64 | Nil #

[View source]
def amount=(amount : Int64 | Nil) #

[View source]
def available_on : Int64 | Nil #

[View source]
def available_on=(available_on : Int64 | Nil) #

[View source]
def created : Int64 | Nil #

[View source]
def created=(created : Int64 | Nil) #

[View source]
def currency : String | Nil #

[View source]
def currency=(currency : String | Nil) #

[View source]
def description : String | Nil #

[View source]
def description=(description : String | Nil) #

[View source]
def exchange_rate : Float64 | Nil #

[View source]
def exchange_rate=(exchange_rate : Float64 | Nil) #

[View source]
def fee : Int64 | Nil #

[View source]
def fee=(fee : Int64 | Nil) #

[View source]
def fee_details : Array(Stripe::Fee) | Nil #

[View source]
def fee_details=(fee_details : Array(Stripe::Fee) | Nil) #

[View source]
def hash(hasher) #

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


def id : String | Nil #

[View source]
def id=(id : String | Nil) #

[View source]
def list_invalid_properties : Array(String) #

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


[View source]
def net : Int64 | Nil #

[View source]
def net=(net : Int64 | Nil) #

[View source]
def object : String | Nil #

[View source]
def object=(object : String | Nil) #

[View source]
def reporting_category : String | Nil #

[View source]
def reporting_category=(reporting_category : String | Nil) #

[View source]

[View source]
def source=(source : Stripe::BalanceTransactionSource1 | Nil) #

[View source]
def status : String | Nil #

[View source]
def status=(status : String | Nil) #

[View source]
def valid? : Bool #

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


[View source]