PaymentIntent

A payment intent tracks the lifecycle of a customer checkout flow and triggers payment method authentication when required.

Properties

• id (string): Unique identifier for the payment intent.
• object (string): String representing the object's type (always "payment_intent").
• amount (number): Amount intended to be collected in cents.
• amountCapturable (number): Amount that can be captured in cents.
• amountReceived (number): Amount that was collected in cents.
• application (string): ID of the Connect application that created the payment intent.
• applicationFeeAmount (number): The amount of the application fee in cents.
• canceledAt (number): Time at which the payment intent was canceled (Unix timestamp).
• cancellationReason (string): Reason for cancellation (duplicate, fraudulent, requested_by_customer, abandoned).
• captureMethod (string): Method to capture the payment (automatic, automatic_async, manual).
• charges ([[Charge]][]): List of charges created for this payment intent.
• clientSecret (string): The client secret used for client-side retrieval.
• confirmationMethod (string): How the payment intent will be confirmed (automatic, manual).
• created (number): Time at which the object was created (Unix timestamp).
• currency (string): Three-letter ISO currency code.
• customer ([[Customer]]): ID of the customer this payment intent belongs to.
• description (string): An arbitrary string attached to the object.
• invoice ([[Invoice]]): ID of the invoice that created this payment intent.
• lastPaymentError (object): The payment error encountered in the previous attempt.
• metadata (object): Set of key-value pairs for storing additional information.
• paymentMethod ([[PaymentMethod]]): ID of the payment method used with this payment intent.
• paymentMethodTypes (string[]): Payment method types that can be used with this intent.
• receiptEmail ([[EmailAddress]]): Email address that the receipt will be sent to.
• status (string): Status of the payment intent (requires_payment_method, requires_confirmation, requires_action, processing, requires_capture, canceled, succeeded).
• statementDescriptor (string): Text appearing on customer's statement.

Actions

create

Create a new payment intent.

Input: [[PaymentIntent]]
Output: [[PaymentIntent]]

retrieve

Retrieve the details of a payment intent.

Input: [[PaymentIntent]]
Output: [[PaymentIntent]]

update

Update properties of a payment intent.

Input: [[PaymentIntent]]
Output: [[PaymentIntent]]

confirm

Confirm that the customer intends to pay with current or provided payment method.

Input: [[PaymentIntent]]
Output: [[PaymentIntent]]

capture

Capture the funds of an existing uncaptured payment intent.

Input: [[PaymentIntent]]
Output: [[PaymentIntent]]

cancel

Cancel a payment intent.

Input: [[PaymentIntent]]
Output: [[PaymentIntent]]

list

Return a list of payment intents.

Input: [[ListRequest]]
Output: [[PaymentIntentList]]

search

Search for payment intents.

Input: [[SearchRequest]]
Output: [[PaymentIntentList]]

Events

• created: Triggered when a payment intent is created.
• updated: Triggered when a payment intent is updated.
• amountCapturableUpdated: Triggered when the capturable amount changes.
• canceled: Triggered when a payment intent is canceled.
• partiallyFunded: Triggered when a payment intent is partially funded.
• paymentFailed: Triggered when a payment attempt fails.
• processing: Triggered when a payment intent is processing.
• requiresAction: Triggered when a payment intent requires customer action.
• succeeded: Triggered when a payment intent succeeds.