class

Stripe::TreasuryOutboundPayment

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

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

Constants

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

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

amount

Amount (in cents) transferred.

Source
amount=(new_value : Int64 | Nil)

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

Source
cancelable

Returns true if the object can be canceled, and false otherwise.

Source
cancelable=(new_value : Bool | Nil)

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

ID of the customer to whom an OutboundPayment is sent.

Source
customer=(new_value : String | Nil)

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

The PaymentMethod via which an OutboundPayment is sent. This field can be empty if the OutboundPayment was created using destination_payment_method_data.

Source
destination_payment_method=(new_value : String | Nil)

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

Source
destination_payment_method_details
Source
destination_payment_method_details=(new_value : Stripe::TreasuryOutboundPaymentDestinationPaymentMethodDetails | Nil)

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

Source
end_user_details
Source
end_user_details=(new_value : Stripe::TreasuryOutboundPaymentEndUserDetails | Nil)

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

Source
expected_arrival_date

The date when funds are expected to arrive in the destination account.

Source
expected_arrival_date=(new_value : Int64 | Nil)

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

Source
financial_account

The FinancialAccount that funds were pulled from.

Source
financial_account=(new_value : String | Nil)

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

hosted_regulatory_receipt_url

A hosted transaction receipt URL that is provided when money movement is considered regulated under Stripe's money transmission licenses.

Source
hosted_regulatory_receipt_url=(new_value : String | Nil)

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

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

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

Source
statement_descriptor

The description that appears on the receiving end for an OutboundPayment (for example, bank statement for external bank transfer).

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 OutboundPayment: processing, failed, posted, returned, canceled. An OutboundPayment is processing if it has been created and is pending. The status changes to posted once the OutboundPayment has been "confirmed" and funds have left the account, or to failed or canceled. If an OutboundPayment fails to arrive at its destination, its status will change to returned.

Source
status=(new_value : String | Nil)

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

Source
status_transitions
Source
status_transitions=(new_value : Stripe::TreasuryOutboundPaymentsResourceOutboundPaymentResourceStatusTransitions | Nil)

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

Source
tracking_details
Source
tracking_details=(new_value : Stripe::TreasuryOutboundPaymentTrackingDetails | Nil)

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

Source
transaction
Source
transaction=(new_value : Stripe::TreasuryOutboundPaymentTransaction | Nil)

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