643 matches
27 actions
Stripe
27 actions
Finance/Stripe
Retrieves the details of a PaymentIntent that has previously been created.
Client-side retrieval using a publishable key is allowed when the client_secret is provided in the query string.
When retrieved with a publishable key, only a subset of properties will be returned. Please refer to the object reference for more details.
{
"type": "object",
"properties": {
"client_secret": {
"type": "string"
},
"expand": {
"type": "array",
"items": {
"type": "string"
}
},
"intent": {
"type": "string"
}
},
"required": [
"intent"
],
"additionalProperties": false
}{
"type": "object",
"description": "A PaymentIntent guides you through the process of collecting a payment from your customer.\nWe recommend that you create exactly one PaymentIntent for each order or\ncustomer session in your system. You can reference the PaymentIntent later to\nsee the history of payment attempts for a particular session.\n\nA PaymentIntent transitions through\n[multiple statuses](https://stripe.com/docs/payments/intents#intent-statuses)\nthroughout its lifetime as it interfaces with Stripe.js to perform\nauthentication flows and ultimately creates at most one successful charge.\n\nRelated guide: [Payment Intents API](https://stripe.com/docs/payments/payment-intents).",
"required": [
"amount",
"capture_method",
"confirmation_method",
"created",
"currency",
"id",
"livemode",
"object",
"payment_method_types",
"status"
],
"properties": {
"amount": {
"type": "integer",
"description": "Amount intended to be collected by this PaymentIntent. A positive integer representing how much to charge in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal) (e.g., 100 cents to charge $1.00 or 100 to charge ¥100, a zero-decimal currency). The minimum amount is $0.50 US or [equivalent in charge currency](https://stripe.com/docs/currencies#minimum-and-maximum-charge-amounts). The amount value supports up to eight digits (e.g., a value of 99999999 for a USD charge of $999,999.99)."
},
"amount_capturable": {
"type": "integer",
"description": "Amount that can be captured from this PaymentIntent."
},
"amount_details": {
"type": "object",
"properties": {
"tip": {
"type": "object",
"properties": {
"amount": {
"type": "integer",
"description": "Portion of the amount that corresponds to a tip."
}
}
}
}
},
"amount_received": {
"type": "integer",
"description": "Amount that was collected by this PaymentIntent."
},
"application": {
"description": "ID of the Connect application that created the PaymentIntent.",
"type": "object"
},
"application_fee_amount": {
"type": "integer",
"description": "The amount of the application fee (if any) that will be requested to be applied to the payment and transferred to the application owner's Stripe account. The amount of the application fee collected will be capped at the total payment amount. For more information, see the PaymentIntents [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts)."
},
"automatic_payment_methods": {
"description": "Settings to configure compatible payment methods from the [Stripe Dashboard](https://dashboard.stripe.com/settings/payment_methods)",
"type": "object"
},
"canceled_at": {
"type": "integer",
"format": "unix-time",
"description": "Populated when `status` is `canceled`, this is the time at which the PaymentIntent was canceled. Measured in seconds since the Unix epoch."
},
"cancellation_reason": {
"type": "string",
"description": "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`).",
"enum": [
"abandoned",
"automatic",
"duplicate",
"failed_invoice",
"fraudulent",
"requested_by_customer",
"void_invoice"
]
},
"capture_method": {
"type": "string",
"description": "Controls when the funds will be captured from the customer's account.",
"enum": [
"automatic",
"manual"
]
},
"client_secret": {
"type": "string",
"description": "The client secret of this PaymentIntent. Used for client-side retrieval using a publishable key. \n\nThe client secret can be used to complete a payment from your frontend. It should not be stored, logged, or exposed to anyone other than the customer. Make sure that you have TLS enabled on any page that includes the client secret.\n\nRefer to our docs to [accept a payment](https://stripe.com/docs/payments/accept-a-payment?ui=elements) and learn about how `client_secret` should be handled."
},
"confirmation_method": {
"type": "string",
"enum": [
"automatic",
"manual"
]
},
"created": {
"type": "integer",
"format": "unix-time",
"description": "Time at which the object was created. Measured in seconds since the Unix epoch."
},
"currency": {
"type": "string",
"description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies)."
},
"customer": {
"description": "ID of the Customer this PaymentIntent belongs to, if one exists.\n\nPayment methods attached to other Customers cannot be used with this PaymentIntent.\n\nIf present in combination with [setup_future_usage](https://stripe.com/docs/api#payment_intent_object-setup_future_usage), this PaymentIntent's payment method will be attached to the Customer after the PaymentIntent has been confirmed and any required actions from the user are complete.",
"type": "object"
},
"description": {
"type": "string",
"description": "An arbitrary string attached to the object. Often useful for displaying to users."
},
"id": {
"type": "string",
"description": "Unique identifier for the object."
},
"invoice": {
"description": "ID of the invoice that created this PaymentIntent, if it exists.",
"type": "object"
},
"last_payment_error": {
"description": "The payment error encountered in the previous PaymentIntent confirmation. It will be cleared if the PaymentIntent is later updated for any reason.",
"type": "object"
},
"latest_charge": {
"description": "The latest charge created by this payment intent.",
"type": "object"
},
"livemode": {
"type": "boolean",
"description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode."
},
"metadata": {
"type": "object",
"description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. For more information, see the [documentation](https://stripe.com/docs/payments/payment-intents/creating-payment-intents#storing-information-in-metadata)."
},
"next_action": {
"description": "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.",
"type": "object"
},
"object": {
"type": "string",
"description": "String representing the object's type. Objects of the same type share the same value.",
"enum": [
"payment_intent"
]
},
"on_behalf_of": {
"description": "The account (if any) for which the funds of the PaymentIntent are intended. See the PaymentIntents [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts) for details.",
"type": "object"
},
"payment_method": {
"description": "ID of the payment method used in this PaymentIntent.",
"type": "object"
},
"payment_method_options": {
"description": "Payment-method-specific configuration for this PaymentIntent.",
"type": "object"
},
"payment_method_types": {
"type": "array",
"description": "The list of payment method types (e.g. card) that this PaymentIntent is allowed to use.",
"items": {
"type": "string"
}
},
"processing": {
"description": "If present, this property tells you about the processing state of the payment.",
"type": "object"
},
"receipt_email": {
"type": "string",
"description": "Email address that the receipt for the resulting payment will be sent to. If `receipt_email` is specified for a payment in live mode, a receipt will be sent regardless of your [email settings](https://dashboard.stripe.com/account/emails)."
},
"review": {
"description": "ID of the review associated with this PaymentIntent, if any.",
"type": "object"
},
"setup_future_usage": {
"type": "string",
"description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\n\nWhen processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication).",
"enum": [
"off_session",
"on_session"
]
},
"shipping": {
"description": "Shipping information for this PaymentIntent.",
"type": "object"
},
"statement_descriptor": {
"type": "string",
"description": "For non-card charges, you can use this value as the complete description that appears on your customers’ statements. Must contain at least one letter, maximum 22 characters."
},
"statement_descriptor_suffix": {
"type": "string",
"description": "Provides information about a card payment that customers see on their statements. Concatenated with the prefix (shortened descriptor) or statement descriptor that’s set on the account to form the complete statement descriptor. Maximum 22 characters for the concatenated descriptor."
},
"status": {
"type": "string",
"description": "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](https://stripe.com/docs/payments/intents#intent-statuses).",
"enum": [
"canceled",
"processing",
"requires_action",
"requires_capture",
"requires_confirmation",
"requires_payment_method",
"succeeded"
]
},
"transfer_data": {
"description": "The data with which to automatically create a Transfer when the payment is finalized. See the PaymentIntents [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts) for details.",
"type": "object"
},
"transfer_group": {
"type": "string",
"description": "A string that identifies the resulting payment as part of a group. See the PaymentIntents [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts) for details."
}
}
}