PaymentIntent

A PaymentIntent guides you through the process of collecting a payment from your customer.

Table-Specific Information

SELECT

The driver uses the Stripe API to filter the results by the following columns and operators while the rest of the filter is executed client-side within the driver.


Column	Supported Operators
Id	=
Amount	=, >, <, >=, <=, !=
Customer	=, !=
Currency	=, !=
MetadataAggregate	=
Status	=, !=
Created	=, !=, >, >=, <, <=

You can select from the PaymentIntent table with the following queries:

SELECT * FROM PaymentIntent WHERE Id = 'pi_3MOZgsSC4snQ4WkO1git8c00'
SELECT * FROM PaymentIntent WHERE Customer = 'cus_N8rO0qc7j1SJJ9'
SELECT * FROM PaymentIntent WHERE MetadataAggregate = '{\"key\":\"value\"}'

INSERT

Amount and Currency are required to create a payment intent:

INSERT INTO PaymentIntent (Amount, Currency, MetadataAggregate) VALUES (123, 'usd', '[{\"nsame\":\"asdsa\"}]')

UPDATE

To update a payment intent, specify the Id column:

UPDATE PaymentIntent SET description = 'andasdn' WHERE Id = 'pi_3OQAkKCZ8rn6qR6h1liiAZfx'

Columns


Name	Type	ReadOnly	References	Description
Id [KEY]	String	True		Unique identifier for the object.
Amount	Integer	False		The amount intended to be collected by this PaymentIntent.
AmountDetailsTip	String	True		The tip portion of the amount for this PaymentIntent.
AmountCapturable	Integer	True		The amount that can be captured from this PaymentIntent.
AmountReceived	Integer	True		The amount that was collected by this PaymentIntent.
ApplicationFeeAmount	Integer	False		The amount of the application fee (if any) requested to be applied to the payment and transferred to the application owner's Stripe account.
AutomaticPaymentMethodsEnabled	Boolean	False		Indicates whether compatible payment methods are calculated automatically.
AutomaticPaymentMethodsAllowRedirects	String	False		Controls whether this PaymentIntent will accept redirect-based payment methods.
CanceledAt	Datetime	True		Populated when status is canceled, this is the time at which the PaymentIntent was canceled.
CancellationReason	String	True		Reason for cancellation of this PaymentIntent, either user-provided (duplicate, fraudulent, requested_by_customer, or abandoned) or generated by Stripe internally (failed_invoice, void_invoice, or automatic).
CaptureMethod	String	False		Controls when the funds are captured from the customer's account.
ClientSecret	String	True		The client secret of this PaymentIntent. Used for client-side retrieval using a publishable key.
ConfirmationMethod	String	False		The confirmation method for the PaymentIntent, such as automatic or manual.
Created	Datetime	True		Time at which the object was created. Measured in seconds since the Unix epoch.
Currency	String	False		Three-letter ISO currency code, in lowercase.
Application	String	True		The Id of the Connect application that created the PaymentIntent.
Customer	String	False	Customers.Id	The Id of the customer this PaymentIntent belongs to, if one exists.
LatestCharge	String	True		The latest charge created by this payment intent.
PaymentMethod	String	False		The Id of the payment method used in this PaymentIntent.
TransferDataDestination	String	False		The account (if any) the payment will be attributed to for tax reporting, and where funds from the payment will be transferred to upon payment success.
OnBehalfOf	String	False		The account (if any) for which the funds of the PaymentIntent are intended.
Review	String	True		The Id of the review associated with this PaymentIntent, if any.
Description	String	False		An arbitrary string attached to the object. Often useful for displaying to users.
LastPaymentErrorCharge	String	True		For card errors, the Id of the failed charge.
LastPaymentErrorCode	String	True		For some errors that could be handled programmatically, a short string indicating the error code reported.
LastPaymentErrorDeclineCode	String	True		For some errors that could be handled programmatically, a short string indicating the error code reported.
LastPaymentErrorDocURL	String	True		A URL to more information about the error code reported.
LastPaymentErrorMessage	String	True		A human-readable message providing more details about the error. For card errors, these messages can be shown to your users.
LastPaymentErrorParam	String	True		If the error is parameter-specific, the parameter related to the error. For example, you can use this to display a message near the correct form field.
LastPaymentErrorPaymentMethod	String	True		The PaymentMethod object for errors returned on a request involving a PaymentMethod.
LastPaymentErrorPaymentMethodType	String	True		If the error is specific to the type of payment method, the payment method type that had a problem. This field is only populated for invoice-related errors.
LastPaymentErrorType	String	True		The type of error returned, one of api_error, card_error, idempotency_error, or invalid_request_error.
LiveMode	Boolean	True		Has the value true if the object exists in live mode or the value false if the object exists in test mode.
NextAction	String	True		If present, this property tells you what actions you need to take in order for your customer to fulfill a payment using the provided source.
Object	String	True		The string representing the object's type. Objects of the same type share the same value.
PaymentMethodOptions	String	False		Payment-method-specific configuration for this PaymentIntent.
PaymentMethodTypes	String	False		The list of payment method types (e.g. card) that this PaymentIntent is allowed to use.
PaymentMethodConfigurationDetailsId	String	False		The Id of the payment method configuration used.
PaymentMethodConfigurationDetailsParent	String	False		The Id of the parent payment method configuration used.
ProcessingCard	String	True		If the PaymentIntent payment_method_types includes card, this hash contains the details on the processing state of the payment.
ProcessingType	String	True		Type of the payment method for which payment is in processing state, one of card.
ReceiptEmail	String	False		The email address to send the receipt to for this PaymentIntent.
MetadataAggregate	String	False		Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
CustomerAccount	String	False		The Id of the Account representing the customer that this PaymentIntent belongs to.
ExcludedPaymentMethodTypesAggregate	String	False		Payment methods to exclude from the PaymentIntent.
HooksConfirmationTriggered	Boolean	True		DEPRECATED. Whether a webhook hook was triggered on confirmation.
ManagedPaymentsExclusiveManagement	String	True		DEPRECATED. Managed payments exclusive management setting.
PaymentDetailsCarRentalAffiliateName	String	False		Car rental affiliate name for payment details.
PresentmentDetailsPresentmentCurrency	String	True		The currency presented to the customer.
PresentmentDetailsPresentmentAmount	Integer	True		The amount presented to the customer in presentment currency.
SetupFutureUsage	String	False		Indicates that you intend to make future payments with the payment method of this PaymentIntent.
ShippingAddressCity	String	False		The city, district, suburb, town, or village of the shipping address.
ShippingAddressCountry	String	False		The two-letter country code of the shipping address.
ShippingAddressline1	String	False		The first line of the shipping address.
ShippingAddressline2	String	False		The second line of the shipping address.
ShippingAddressPostalCode	String	False		The ZIP or postal code of the shipping address.
ShippingAddressState	String	False		The state, county, province, or region of the shipping address.
ShippingCarrier	String	False		The delivery service that shipped a physical product, such as Fedex, UPS, USPS, etc.
ShippingName	String	False		Recipient name.
ShippingPhone	String	False		Recipient phone (including extension).
ShippingTrackingNumber	String	False		The tracking number for a physical product, obtained from the delivery service.
StatementDescriptor	String	False		For non-card charges, you can use this value as the complete description that appears on your customers' statements.
StatementDescriptorSuffix	String	False		Provides information about a card payment that customers see on their statements.
Status	String	True		Status of this PaymentIntent, one of requires_payment_method, requires_confirmation, requires_action, processing, requires_capture, canceled, or succeeded. Read more about each PaymentIntent status.
TransferDataAmount	Integer	False		The amount transferred to the destination account when the payment succeeds.
TransferGroup	String	False		A string that identifies the resulting payment as part of a group. See the PaymentIntents use case for connected accounts for details.
HooksInputsTaxCalculation	String	False		The TaxCalculation id.
ManagedPaymentsEnabled	Boolean	True		Indicates whether Managed Payments is enabled for this transaction.
PaymentDetailsAggregate	String	True		Provides industry-specific information about the charge.

Pseudocolumns

Pseudocolumn fields are used in the WHERE clause of SELECT statements and offer more granular control over the data returned from the data source.


Name	Type	Description
Confirm	Boolean	Set to true to attempt to confirm this PaymentIntent immediately. This column is supported in INSERT.
OffSession	Boolean	Set to true to indicate that the customer is not in your checkout flow during this payment attempt and cannot authenticate. This parameter can only be used with confirm=true. This column is supported in INSERT.
ErrorOnRequiresAction	Boolean	Set to true to fail the payment attempt if the PaymentIntent transitions into requires_action. Use this parameter for simpler integrations that do not handle customer actions, such as saving cards without authentication. This parameter can only be used with confirm=true. This column is supported in INSERT.
Mandate	String	The Id of the mandate used for this payment. This parameter can only be used with confirm=true. This column is supported in INSERT.
MandateDataCustomerAcceptanceType	String	The type of customer acceptance information included with the Mandate. One of online or offline. This parameter can only be used with confirm=true. This column is supported in INSERT. The allowed values are online, offline.
MandateDataCustomerAcceptanceAcceptedAt	Datetime	The time at which the customer accepted the Mandate. This parameter can only be used with confirm=true. This column is supported in INSERT.
MandateDataCustomerAcceptanceOffline	String	If this is a Mandate accepted offline, this hash contains details about the offline acceptance. This parameter can only be used with confirm=true. This column is supported in INSERT.
MandateDataCustomerAcceptanceOnlineIPAddress	String	The IP address from which the Mandate was accepted by the customer. This parameter can only be used with confirm=true. This column is supported in INSERT.
MandateDataCustomerAcceptanceOnlineUserAgent	String	The user agent of the browser from which the Mandate was accepted by the customer. This parameter can only be used with confirm=true. This column is supported in INSERT.
RadarOptionsSession	String	A Radar Session is a snapshot of the browser metadata and device details that help Radar make more accurate predictions on your payments. This column is supported in INSERT.
ReturnURL	String	The URL to redirect your customer back to after they authenticate or cancel their payment on the payment method's app or site. This parameter can only be used with confirm=true. This column is supported in INSERT.