class Stripe::InvoicePaymentIntent

• Stripe::InvoicePaymentIntent
• Reference
• Object

Overview

The PaymentIntent associated with this invoice. The PaymentIntent is generated when the invoice is finalized, and can then be used to pay the invoice. Note that voiding an invoice will cancel the PaymentIntent.

Included Modules

• JSON::Serializable
• JSON::Serializable::Unmapped
• OpenApi::Json
• OpenApi::Validatable

Defined in:

Constant Summary

ERROR_MESSAGE_FOR_CANCELLATION_REASON = "invalid value for \"cancellation_reason\", must be one of [abandoned, automatic, duplicate, failed_invoice, fraudulent, requested_by_customer, void_invoice]."

ERROR_MESSAGE_FOR_CAPTURE_METHOD = "invalid value for \"capture_method\", must be one of [automatic, automatic_async, manual]."

ERROR_MESSAGE_FOR_CONFIRMATION_METHOD = "invalid value for \"confirmation_method\", must be one of [automatic, manual]."

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

ERROR_MESSAGE_FOR_SETUP_FUTURE_USAGE = "invalid value for \"setup_future_usage\", must be one of [off_session, on_session]."

ERROR_MESSAGE_FOR_STATUS = "invalid value for \"status\", must be one of [canceled, processing, requires_action, requires_capture, requires_confirmation, requires_payment_method, succeeded]."

MAX_LENGTH_FOR_CLIENT_SECRET = 5000

MAX_LENGTH_FOR_DESCRIPTION = 5000

MAX_LENGTH_FOR_ID = 5000

MAX_LENGTH_FOR_RECEIPT_EMAIL = 5000

MAX_LENGTH_FOR_STATEMENT_DESCRIPTOR = 5000

MAX_LENGTH_FOR_STATEMENT_DESCRIPTOR_SUFFIX = 5000

MAX_LENGTH_FOR_TRANSFER_GROUP = 5000

VALID_VALUES_FOR_CANCELLATION_REASON = String.static_array("abandoned", "automatic", "duplicate", "failed_invoice", "fraudulent", "requested_by_customer", "void_invoice")

VALID_VALUES_FOR_CAPTURE_METHOD = String.static_array("automatic", "automatic_async", "manual")

VALID_VALUES_FOR_CONFIRMATION_METHOD = String.static_array("automatic", "manual")

VALID_VALUES_FOR_OBJECT = String.static_array("payment_intent")

VALID_VALUES_FOR_SETUP_FUTURE_USAGE = String.static_array("off_session", "on_session")

VALID_VALUES_FOR_STATUS = String.static_array("canceled", "processing", "requires_action", "requires_capture", "requires_confirmation", "requires_payment_method", "succeeded")

Constructors

• .new(pull : JSON::PullParser)
• .new(*, amount : Int64 | Nil = nil, amount_capturable : Int64 | Nil = nil, amount_received : Int64 | Nil = nil, application : Stripe::PaymentIntentApplication | Nil = nil, application_fee_amount : Int64 | Nil = nil, automatic_payment_methods : Stripe::PaymentFlowsAutomaticPaymentMethodsPaymentIntent | Nil = nil, canceled_at : Int64 | Nil = nil, cancellation_reason : String | Nil = nil, capture_method : String | Nil = nil, client_secret : String | Nil = nil, confirmation_method : String | Nil = nil, created : Int64 | Nil = nil, currency : String | Nil = nil, customer : Stripe::PaymentIntentCustomer | Nil = nil, description : String | Nil = nil, id : String | Nil = nil, invoice : Stripe::PaymentIntentInvoice | Nil = nil, last_payment_error : Stripe::ApiErrors | Nil = nil, latest_charge : Stripe::PaymentIntentLatestCharge | Nil = nil, livemode : Bool | Nil = nil, metadata : Hash(String, String) | Nil = nil, next_action : Stripe::PaymentIntentNextAction | Nil = nil, object : String | Nil = nil, on_behalf_of : Stripe::PaymentIntentOnBehalfOf | Nil = nil, payment_method : Stripe::PaymentIntentPaymentMethod | Nil = nil, payment_method_configuration_details : Stripe::PaymentMethodConfigBizPaymentMethodConfigurationDetails | Nil = nil, payment_method_options : Stripe::PaymentIntentPaymentMethodOptions | Nil = nil, payment_method_types : Array(String) | Nil = nil, processing : Stripe::PaymentIntentProcessing | Nil = nil, receipt_email : String | Nil = nil, review : Stripe::PaymentIntentReview | Nil = nil, setup_future_usage : String | Nil = nil, shipping : Stripe::Shipping | Nil = nil, source : Stripe::PaymentIntentSource | Nil = nil, statement_descriptor : String | Nil = nil, statement_descriptor_suffix : String | Nil = nil, status : String | Nil = nil, transfer_data : Stripe::TransferData | Nil = nil, transfer_group : String | Nil = nil, amount_details : Stripe::PaymentFlowsAmountDetails | Nil = nil)

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

Class Method Summary

• .openapi_any_of

  List of class defined in anyOf (OpenAPI v3)

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=(amount : Int64 | Nil)
• #amount_capturable : Int64 | Nil
• #amount_capturable=(amount_capturable : Int64 | Nil)
• #amount_details : Stripe::PaymentFlowsAmountDetails | Nil
• #amount_details=(amount_details : Stripe::PaymentFlowsAmountDetails | Nil)
• #amount_received : Int64 | Nil
• #amount_received=(amount_received : Int64 | Nil)
• #application : Stripe::PaymentIntentApplication | Nil
• #application=(application : Stripe::PaymentIntentApplication | Nil)
• #application_fee_amount : Int64 | Nil
• #application_fee_amount=(application_fee_amount : Int64 | Nil)
• #automatic_payment_methods : Stripe::PaymentFlowsAutomaticPaymentMethodsPaymentIntent | Nil
• #automatic_payment_methods=(automatic_payment_methods : Stripe::PaymentFlowsAutomaticPaymentMethodsPaymentIntent | Nil)
• #canceled_at : Int64 | Nil
• #canceled_at=(canceled_at : Int64 | Nil)
• #cancellation_reason : String | Nil
• #cancellation_reason=(cancellation_reason : String | Nil)
• #capture_method : String | Nil
• #capture_method=(capture_method : String | Nil)
• #client_secret : String | Nil
• #client_secret=(client_secret : String | Nil)
• #confirmation_method : String | Nil
• #confirmation_method=(confirmation_method : String | Nil)
• #created : Int64 | Nil
• #created=(created : Int64 | Nil)
• #currency : String | Nil
• #currency=(currency : String | Nil)
• #customer : Stripe::PaymentIntentCustomer | Nil
• #customer=(customer : Stripe::PaymentIntentCustomer | Nil)
• #description : String | Nil
• #description=(description : String | Nil)
• #hash(hasher)

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

• #id : String | Nil
• #id=(id : String | Nil)
• #invoice : Stripe::PaymentIntentInvoice | Nil
• #invoice=(invoice : Stripe::PaymentIntentInvoice | Nil)
• #last_payment_error : Stripe::ApiErrors | Nil
• #last_payment_error=(last_payment_error : Stripe::ApiErrors | Nil)
• #latest_charge : Stripe::PaymentIntentLatestCharge | Nil
• #latest_charge=(latest_charge : Stripe::PaymentIntentLatestCharge | Nil)
• #list_invalid_properties : Array(String)

  Show invalid properties with the reasons.

• #livemode : Bool | Nil
• #livemode=(livemode : Bool | Nil)
• #metadata : Hash(String, String) | Nil
• #metadata=(metadata : Hash(String, String) | Nil)
• #next_action : Stripe::PaymentIntentNextAction | Nil
• #next_action=(next_action : Stripe::PaymentIntentNextAction | Nil)
• #object : String | Nil
• #object=(object : String | Nil)
• #on_behalf_of : Stripe::PaymentIntentOnBehalfOf | Nil
• #on_behalf_of=(on_behalf_of : Stripe::PaymentIntentOnBehalfOf | Nil)
• #payment_method : Stripe::PaymentIntentPaymentMethod | Nil
• #payment_method=(payment_method : Stripe::PaymentIntentPaymentMethod | Nil)
• #payment_method_configuration_details : Stripe::PaymentMethodConfigBizPaymentMethodConfigurationDetails | Nil
• #payment_method_configuration_details=(payment_method_configuration_details : Stripe::PaymentMethodConfigBizPaymentMethodConfigurationDetails | Nil)
• #payment_method_options : Stripe::PaymentIntentPaymentMethodOptions | Nil
• #payment_method_options=(payment_method_options : Stripe::PaymentIntentPaymentMethodOptions | Nil)
• #payment_method_types : Array(String) | Nil
• #payment_method_types=(payment_method_types : Array(String) | Nil)
• #processing : Stripe::PaymentIntentProcessing | Nil
• #processing=(processing : Stripe::PaymentIntentProcessing | Nil)
• #receipt_email : String | Nil
• #receipt_email=(receipt_email : String | Nil)
• #review : Stripe::PaymentIntentReview | Nil
• #review=(review : Stripe::PaymentIntentReview | Nil)
• #setup_future_usage : String | Nil
• #setup_future_usage=(setup_future_usage : String | Nil)
• #shipping : Stripe::Shipping | Nil
• #shipping=(shipping : Stripe::Shipping | Nil)
• #source : Stripe::PaymentIntentSource | Nil
• #source=(source : Stripe::PaymentIntentSource | Nil)
• #statement_descriptor : String | Nil
• #statement_descriptor=(statement_descriptor : String | Nil)
• #statement_descriptor_suffix : String | Nil
• #statement_descriptor_suffix=(statement_descriptor_suffix : String | Nil)
• #status : String | Nil
• #status=(status : String | Nil)
• #transfer_data : Stripe::TransferData | Nil
• #transfer_data=(transfer_data : Stripe::TransferData | Nil)
• #transfer_group : String | Nil
• #transfer_group=(transfer_group : String | Nil)
• #valid? : Bool

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

Constructor Detail

Class Method Detail

Instance Method Detail