class

Stripe::SetupAttempt

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

A SetupAttempt describes one attempted confirmation of a SetupIntent, whether that confirmation is successful or unsuccessful. You can use SetupAttempts to inspect details of a specific attempt at setting up a payment method using a SetupIntent.

Constants

ERROR_MESSAGE_FOR_FLOW_DIRECTIONS = "invalid value for \"flow_directions\", must be one of [inbound, outbound]."

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

MAX_LENGTH_FOR_ID = 5000

MAX_LENGTH_FOR_STATUS = 5000

MAX_LENGTH_FOR_USAGE = 5000

VALID_VALUES_FOR_FLOW_DIRECTIONS = String.static_array("inbound", "outbound")

VALID_VALUES_FOR_OBJECT = String.static_array("setup_attempt")

Constructors

new(pull : JSON::PullParser)

Source

new(*, __pull_for_json_serializable pull : JSON::PullParser)

Source

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

application

Source

application=(new_value : Stripe::SetupAttemptApplication | Nil)

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

Source

attach_to_self

If present, the SetupIntent's payment method will be attached to the in-context Stripe Account. It can only be used for this Stripe Account’s own money movement flows like InboundTransfer and OutboundTransfers. It cannot be set to true when setting up a PaymentMethod for a Customer, and defaults to false when attaching a PaymentMethod to a Customer.

Source

attach_to_self=(new_value : Bool | Nil)

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

customer

Source

customer=(new_value : Stripe::SetupAttemptCustomer | Nil)

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

Source

flow_directions

Indicates the directions of money movement for which this payment method is intended to be used. Include inbound if you intend to use the payment method as the origin to pull funds from. Include outbound if you intend to use the payment method as the destination to send funds to. You can include both if you intend to use the payment method for both purposes.

Source

flow_directions=(new_value : Array(String) | Nil)

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

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

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

on_behalf_of

Source

on_behalf_of=(new_value : Stripe::SetupAttemptOnBehalfOf | Nil)

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

Source

payment_method

Source

payment_method=(new_value : Stripe::SetupAttemptPaymentMethod | Nil)

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

Source

payment_method_details

Source

payment_method_details=(new_value : Stripe::SetupAttemptPaymentMethodDetails | Nil)

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

Source

setup_error

Source

setup_error=(new_value : Stripe::SetupAttemptSetupError | Nil)

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

Source

setup_intent

Source

setup_intent=(new_value : Stripe::SetupAttemptSetupIntent | Nil)

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

Source

status

Status of this SetupAttempt, one of requires_confirmation, requires_action, processing, succeeded, failed, or abandoned.

Source

status=(new_value : String | Nil)

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

Source

usage

The value of usage on the SetupIntent at the time of this confirmation, one of off_session or on_session.

Source

usage=(new_value : String | Nil)

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