class Stripe::TreasuryOutboundPayment

• Stripe::TreasuryOutboundPayment
• Reference
• Object

Overview

Use OutboundPayments to send funds to another party's external bank account or FinancialAccount. To send money to an account belonging to the same user, use an OutboundTransfer. Simulate OutboundPayment state changes with the /v1/test_helpers/treasury/outbound_payments endpoints. These methods can only be called on test mode objects. Related guide: Moving money with Treasury using OutboundPayment objects

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 [treasury.outbound_payment]."

ERROR_MESSAGE_FOR_STATUS = "invalid value for \"status\", must be one of [canceled, failed, posted, processing, returned]."

MAX_LENGTH_FOR_CUSTOMER = 5000

MAX_LENGTH_FOR_DESCRIPTION = 5000

MAX_LENGTH_FOR_DESTINATION_PAYMENT_METHOD = 5000

MAX_LENGTH_FOR_FINANCIAL_ACCOUNT = 5000

MAX_LENGTH_FOR_HOSTED_REGULATORY_RECEIPT_URL = 5000

MAX_LENGTH_FOR_ID = 5000

MAX_LENGTH_FOR_STATEMENT_DESCRIPTOR = 5000

VALID_VALUES_FOR_OBJECT = String.static_array("treasury.outbound_payment")

VALID_VALUES_FOR_STATUS = String.static_array("canceled", "failed", "posted", "processing", "returned")

Constructors

• .new(pull : JSON::PullParser)
• .new(*, amount : Int64 | Nil = nil, cancelable : Bool | Nil = nil, created : Int64 | Nil = nil, currency : String | Nil = nil, customer : String | Nil = nil, description : String | Nil = nil, destination_payment_method : String | Nil = nil, destination_payment_method_details : Stripe::TreasuryOutboundPaymentDestinationPaymentMethodDetails | Nil = nil, end_user_details : Stripe::TreasuryOutboundPaymentEndUserDetails | Nil = nil, expected_arrival_date : Int64 | Nil = nil, financial_account : String | Nil = nil, hosted_regulatory_receipt_url : String | Nil = nil, id : String | Nil = nil, livemode : Bool | Nil = nil, metadata : Hash(String, String) | Nil = nil, object : String | Nil = nil, returned_details : Stripe::TreasuryOutboundPaymentReturnedDetails | Nil = nil, statement_descriptor : String | Nil = nil, status : String | Nil = nil, status_transitions : Stripe::TreasuryOutboundPaymentsResourceOutboundPaymentResourceStatusTransitions | Nil = nil, tracking_details : Stripe::TreasuryOutboundPaymentTrackingDetails | Nil = nil, transaction : Stripe::TreasuryOutboundPaymentTransaction | 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).

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

• #customer : String | Nil
• #customer=(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_payment_method : String | Nil
• #destination_payment_method=(new_value : String | Nil)

  Custom attribute writer method checking allowed values (enum).

• #destination_payment_method_details : Stripe::TreasuryOutboundPaymentDestinationPaymentMethodDetails | Nil
• #destination_payment_method_details=(new_value : Stripe::TreasuryOutboundPaymentDestinationPaymentMethodDetails | Nil)

  Custom attribute writer method checking allowed values (enum).

• #end_user_details : Stripe::TreasuryOutboundPaymentEndUserDetails | Nil
• #end_user_details=(new_value : Stripe::TreasuryOutboundPaymentEndUserDetails | Nil)

  Custom attribute writer method checking allowed values (enum).

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

  Custom attribute writer method checking allowed values (enum).

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

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

  Custom attribute writer method checking allowed values (enum).

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

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

• #status_transitions : Stripe::TreasuryOutboundPaymentsResourceOutboundPaymentResourceStatusTransitions | Nil
• #status_transitions=(new_value : Stripe::TreasuryOutboundPaymentsResourceOutboundPaymentResourceStatusTransitions | Nil)

  Custom attribute writer method checking allowed values (enum).

• #tracking_details : Stripe::TreasuryOutboundPaymentTrackingDetails | Nil
• #tracking_details=(new_value : Stripe::TreasuryOutboundPaymentTrackingDetails | Nil)

  Custom attribute writer method checking allowed values (enum).

• #transaction : Stripe::TreasuryOutboundPaymentTransaction | Nil
• #transaction=(new_value : Stripe::TreasuryOutboundPaymentTransaction | 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