vendor/stripe/stripe-php/lib/PaymentIntent.php line 118

Open in your IDE?
  1. <?php
  3. // File generated from our OpenAPI spec
  5. namespace Stripe;
  7. /**
  8.  * A PaymentIntent guides you through the process of collecting a payment from your customer.
  9.  * We recommend that you create exactly one PaymentIntent for each order or
  10.  * customer session in your system. You can reference the PaymentIntent later to
  11.  * see the history of payment attempts for a particular session.
  12.  *
  13.  * A PaymentIntent transitions through
  14.  * <a href="https://stripe.com/docs/payments/intents#intent-statuses">multiple statuses</a>
  15.  * throughout its lifetime as it interfaces with Stripe.js to perform
  16.  * authentication flows and ultimately creates at most one successful charge.
  17.  *
  18.  * Related guide: <a href="https://stripe.com/docs/payments/payment-intents">Payment Intents API</a>
  19.  *
  20.  * @property string $id Unique identifier for the object.
  21.  * @property string $object String representing the object's type. Objects of the same type share the same value.
  22.  * @property int $amount Amount intended to be collected by this PaymentIntent. A positive integer representing how much to charge in the <a href="https://stripe.com/docs/currencies#zero-decimal">smallest currency unit</a> (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 <a href="https://stripe.com/docs/currencies#minimum-and-maximum-charge-amounts">equivalent in charge currency</a>. The amount value supports up to eight digits (e.g., a value of 99999999 for a USD charge of $999,999.99).
  23.  * @property int $amount_capturable Amount that can be captured from this PaymentIntent.
  24.  * @property null|\Stripe\StripeObject $amount_details
  25.  * @property int $amount_received Amount that this PaymentIntent collects.
  26.  * @property null|string|\Stripe\Application $application ID of the Connect application that created the PaymentIntent.
  27.  * @property null|int $application_fee_amount 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 <a href="https://stripe.com/docs/payments/connected-accounts">use case for connected accounts</a>.
  28.  * @property null|\Stripe\StripeObject $automatic_payment_methods Settings to configure compatible payment methods from the <a href="https://dashboard.stripe.com/settings/payment_methods">Stripe Dashboard</a>
  29.  * @property null|int $canceled_at Populated when <code>status</code> is <code>canceled</code>, this is the time at which the PaymentIntent was canceled. Measured in seconds since the Unix epoch.
  30.  * @property null|string $cancellation_reason Reason for cancellation of this PaymentIntent, either user-provided (<code>duplicate</code>, <code>fraudulent</code>, <code>requested_by_customer</code>, or <code>abandoned</code>) or generated by Stripe internally (<code>failed_invoice</code>, <code>void_invoice</code>, or <code>automatic</code>).
  31.  * @property string $capture_method Controls when the funds will be captured from the customer's account.
  32.  * @property null|string $client_secret <p>The client secret of this PaymentIntent. Used for client-side retrieval using a publishable key.</p><p>The 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.</p><p>Refer to our docs to <a href="https://stripe.com/docs/payments/accept-a-payment?ui=elements">accept a payment</a> and learn about how <code>client_secret</code> should be handled.</p>
  33.  * @property string $confirmation_method Describes whether we can confirm this PaymentIntent automatically, or if it requires customer action to confirm the payment.
  34.  * @property int $created Time at which the object was created. Measured in seconds since the Unix epoch.
  35.  * @property string $currency Three-letter <a href="https://www.iso.org/iso-4217-currency-codes.html">ISO currency code</a>, in lowercase. Must be a <a href="https://stripe.com/docs/currencies">supported currency</a>.
  36.  * @property null|string|\Stripe\Customer $customer <p>ID of the Customer this PaymentIntent belongs to, if one exists.</p><p>Payment methods attached to other Customers cannot be used with this PaymentIntent.</p><p>If <a href="https://stripe.com/docs/api#payment_intent_object-setup_future_usage">setup_future_usage</a> is set and this PaymentIntent's payment method is not <code>card_present</code>, then the payment method attaches to the Customer after the PaymentIntent has been confirmed and any required actions from the user are complete. If the payment method is <code>card_present</code> and isn't a digital wallet, then a <a href="https://docs.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card">generated_card</a> payment method representing the card is created and attached to the Customer instead.</p>
  37.  * @property null|string $description An arbitrary string attached to the object. Often useful for displaying to users.
  38.  * @property null|string|\Stripe\Invoice $invoice ID of the invoice that created this PaymentIntent, if it exists.
  39.  * @property null|\Stripe\StripeObject $last_payment_error The payment error encountered in the previous PaymentIntent confirmation. It will be cleared if the PaymentIntent is later updated for any reason.
  40.  * @property null|string|\Stripe\Charge $latest_charge ID of the latest <a href="https://stripe.com/docs/api/charges">Charge object</a> created by this PaymentIntent. This property is <code>null</code> until PaymentIntent confirmation is attempted.
  41.  * @property bool $livemode Has the value <code>true</code> if the object exists in live mode or the value <code>false</code> if the object exists in test mode.
  42.  * @property \Stripe\StripeObject $metadata Set of <a href="https://stripe.com/docs/api/metadata">key-value pairs</a> that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Learn more about <a href="https://stripe.com/docs/payments/payment-intents/creating-payment-intents#storing-information-in-metadata">storing information in metadata</a>.
  43.  * @property null|\Stripe\StripeObject $next_action 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.
  44.  * @property null|string|\Stripe\Account $on_behalf_of The account (if any) for which the funds of the PaymentIntent are intended. See the PaymentIntents <a href="https://stripe.com/docs/payments/connected-accounts">use case for connected accounts</a> for details.
  45.  * @property null|string|\Stripe\PaymentMethod $payment_method ID of the payment method used in this PaymentIntent.
  46.  * @property null|\Stripe\StripeObject $payment_method_configuration_details Information about the payment method configuration used for this PaymentIntent.
  47.  * @property null|\Stripe\StripeObject $payment_method_options Payment-method-specific configuration for this PaymentIntent.
  48.  * @property string[] $payment_method_types The list of payment method types (e.g. card) that this PaymentIntent is allowed to use.
  49.  * @property null|\Stripe\StripeObject $processing If present, this property tells you about the processing state of the payment.
  50.  * @property null|string $receipt_email Email address that the receipt for the resulting payment will be sent to. If <code>receipt_email</code> is specified for a payment in live mode, a receipt will be sent regardless of your <a href="https://dashboard.stripe.com/account/emails">email settings</a>.
  51.  * @property null|string|\Stripe\Review $review ID of the review associated with this PaymentIntent, if any.
  52.  * @property null|string $setup_future_usage <p>Indicates that you intend to make future payments with this PaymentIntent's payment method.</p><p>If you provide a Customer with the PaymentIntent, you can use this parameter to <a href="/payments/save-during-payment">attach the payment method</a> to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still <a href="/api/payment_methods/attach">attach</a> the payment method to a Customer after the transaction completes.</p><p>If the payment method is <code>card_present</code> and isn't a digital wallet, Stripe creates and attaches a <a href="/api/charges/object#charge_object-payment_method_details-card_present-generated_card">generated_card</a> payment method representing the card to the Customer instead.</p><p>When processing card payments, Stripe uses <code>setup_future_usage</code> to help you comply with regional legislation and network rules, such as <a href="/strong-customer-authentication">SCA</a>.</p>
  53.  * @property null|\Stripe\StripeObject $shipping Shipping information for this PaymentIntent.
  54.  * @property null|string|\Stripe\Account|\Stripe\BankAccount|\Stripe\Card|\Stripe\Source $source This is a legacy field that will be removed in the future. It is the ID of the Source object that is associated with this PaymentIntent, if one was supplied.
  55.  * @property null|string $statement_descriptor <p>Text that appears on the customer's statement as the statement descriptor for a non-card charge. This value overrides the account's default statement descriptor. For information about requirements, including the 22-character limit, see <a href="https://docs.stripe.com/get-started/account/statement-descriptors">the Statement Descriptor docs</a>.</p><p>Setting this value for a card charge returns an error. For card charges, set the <a href="https://docs.stripe.com/get-started/account/statement-descriptors#dynamic">statement_descriptor_suffix</a> instead.</p>
  56.  * @property null|string $statement_descriptor_suffix Provides information about a card charge. Concatenated to the account's <a href="https://docs.stripe.com/get-started/account/statement-descriptors#static">statement descriptor prefix</a> to form the complete statement descriptor that appears on the customer's statement.
  57.  * @property string $status Status of this PaymentIntent, one of <code>requires_payment_method</code>, <code>requires_confirmation</code>, <code>requires_action</code>, <code>processing</code>, <code>requires_capture</code>, <code>canceled</code>, or <code>succeeded</code>. Read more about each PaymentIntent <a href="https://stripe.com/docs/payments/intents#intent-statuses">status</a>.
  58.  * @property null|\Stripe\StripeObject $transfer_data The data that automatically creates a Transfer after the payment finalizes. Learn more about the <a href="https://stripe.com/docs/payments/connected-accounts">use case for connected accounts</a>.
  59.  * @property null|string $transfer_group A string that identifies the resulting payment as part of a group. Learn more about the <a href="https://stripe.com/docs/connect/separate-charges-and-transfers">use case for connected accounts</a>.
  60.  */
  61. class PaymentIntent extends ApiResource
  62. {
  63.     const OBJECT_NAME = 'payment_intent';
  65.     use ApiOperations\Update;
  67.     const CANCELLATION_REASON_ABANDONED = 'abandoned';
  68.     const CANCELLATION_REASON_AUTOMATIC = 'automatic';
  69.     const CANCELLATION_REASON_DUPLICATE = 'duplicate';
  70.     const CANCELLATION_REASON_FAILED_INVOICE = 'failed_invoice';
  71.     const CANCELLATION_REASON_FRAUDULENT = 'fraudulent';
  72.     const CANCELLATION_REASON_REQUESTED_BY_CUSTOMER = 'requested_by_customer';
  73.     const CANCELLATION_REASON_VOID_INVOICE = 'void_invoice';
  75.     const CAPTURE_METHOD_AUTOMATIC = 'automatic';
  76.     const CAPTURE_METHOD_AUTOMATIC_ASYNC = 'automatic_async';
  77.     const CAPTURE_METHOD_MANUAL = 'manual';
  79.     const CONFIRMATION_METHOD_AUTOMATIC = 'automatic';
  80.     const CONFIRMATION_METHOD_MANUAL = 'manual';
  82.     const SETUP_FUTURE_USAGE_OFF_SESSION = 'off_session';
  83.     const SETUP_FUTURE_USAGE_ON_SESSION = 'on_session';
  85.     const STATUS_CANCELED = 'canceled';
  86.     const STATUS_PROCESSING = 'processing';
  87.     const STATUS_REQUIRES_ACTION = 'requires_action';
  88.     const STATUS_REQUIRES_CAPTURE = 'requires_capture';
  89.     const STATUS_REQUIRES_CONFIRMATION = 'requires_confirmation';
  90.     const STATUS_REQUIRES_PAYMENT_METHOD = 'requires_payment_method';
  91.     const STATUS_SUCCEEDED = 'succeeded';
  93.     /**
  94.      * Creates a PaymentIntent object.
  95.      *
  96.      * After the PaymentIntent is created, attach a payment method and <a
  97.      * href="/docs/api/payment_intents/confirm">confirm</a> to continue the payment.
  98.      * Learn more about <a href="/docs/payments/payment-intents">the available payment
  99.      * flows with the Payment Intents API</a>.
  100.      *
  101.      * When you use <code>confirm=true</code> during creation, it’s equivalent to
  102.      * creating and confirming the PaymentIntent in the same call. You can use any
  103.      * parameters available in the <a href="/docs/api/payment_intents/confirm">confirm
  104.      * API</a> when you supply <code>confirm=true</code>.
  105.      *
  106.      * @param null|array $params
  107.      * @param null|array|string $options
  108.      *
  109.      * @throws \Stripe\Exception\ApiErrorException if the request fails
  110.      *
  111.      * @return \Stripe\PaymentIntent the created resource
  112.      */
  113.     public static function create($params = null, $options = null)
  114.     {
  115.         self::_validateParams($params);
  116.         $url = static::classUrl();
  118.         list($response, $opts) = static::_staticRequest('post', $url, $params, $options);
  119.         $obj = \Stripe\Util\Util::convertToStripeObject($response->json, $opts);
  120.         $obj->setLastResponse($response);
  122.         return $obj;
  123.     }
  125.     /**
  126.      * Returns a list of PaymentIntents.
  127.      *
  128.      * @param null|array $params
  129.      * @param null|array|string $opts
  130.      *
  131.      * @throws \Stripe\Exception\ApiErrorException if the request fails
  132.      *
  133.      * @return \Stripe\Collection<\Stripe\PaymentIntent> of ApiResources
  134.      */
  135.     public static function all($params = null, $opts = null)
  136.     {
  137.         $url = static::classUrl();
  139.         return static::_requestPage($url, \Stripe\Collection::class, $params, $opts);
  140.     }
  142.     /**
  143.      * Retrieves the details of a PaymentIntent that has previously been created.
  144.      *
  145.      * You can retrieve a PaymentIntent client-side using a publishable key when the
  146.      * <code>client_secret</code> is in the query string.
  147.      *
  148.      * If you retrieve a PaymentIntent with a publishable key, it only returns a subset
  149.      * of properties. Refer to the <a href="#payment_intent_object">payment intent</a>
  150.      * object reference for more details.
  151.      *
  152.      * @param array|string $id the ID of the API resource to retrieve, or an options array containing an `id` key
  153.      * @param null|array|string $opts
  154.      *
  155.      * @throws \Stripe\Exception\ApiErrorException if the request fails
  156.      *
  157.      * @return \Stripe\PaymentIntent
  158.      */
  159.     public static function retrieve($id, $opts = null)
  160.     {
  161.         $opts = \Stripe\Util\RequestOptions::parse($opts);
  162.         $instance = new static($id, $opts);
  163.         $instance->refresh();
  165.         return $instance;
  166.     }
  168.     /**
  169.      * Updates properties on a PaymentIntent object without confirming.
  170.      *
  171.      * Depending on which properties you update, you might need to confirm the
  172.      * PaymentIntent again. For example, updating the <code>payment_method</code>
  173.      * always requires you to confirm the PaymentIntent again. If you prefer to update
  174.      * and confirm at the same time, we recommend updating properties through the <a
  175.      * href="/docs/api/payment_intents/confirm">confirm API</a> instead.
  176.      *
  177.      * @param string $id the ID of the resource to update
  178.      * @param null|array $params
  179.      * @param null|array|string $opts
  180.      *
  181.      * @throws \Stripe\Exception\ApiErrorException if the request fails
  182.      *
  183.      * @return \Stripe\PaymentIntent the updated resource
  184.      */
  185.     public static function update($id, $params = null, $opts = null)
  186.     {
  187.         self::_validateParams($params);
  188.         $url = static::resourceUrl($id);
  190.         list($response, $opts) = static::_staticRequest('post', $url, $params, $opts);
  191.         $obj = \Stripe\Util\Util::convertToStripeObject($response->json, $opts);
  192.         $obj->setLastResponse($response);
  194.         return $obj;
  195.     }
  197.     /**
  198.      * @param null|array $params
  199.      * @param null|array|string $opts
  200.      *
  201.      * @throws \Stripe\Exception\ApiErrorException if the request fails
  202.      *
  203.      * @return \Stripe\PaymentIntent the applied payment intent
  204.      */
  205.     public function applyCustomerBalance($params = null, $opts = null)
  206.     {
  207.         $url = $this->instanceUrl() . '/apply_customer_balance';
  208.         list($response, $opts) = $this->_request('post', $url, $params, $opts);
  209.         $this->refreshFrom($response, $opts);
  211.         return $this;
  212.     }
  214.     /**
  215.      * @param null|array $params
  216.      * @param null|array|string $opts
  217.      *
  218.      * @throws \Stripe\Exception\ApiErrorException if the request fails
  219.      *
  220.      * @return \Stripe\PaymentIntent the canceled payment intent
  221.      */
  222.     public function cancel($params = null, $opts = null)
  223.     {
  224.         $url = $this->instanceUrl() . '/cancel';
  225.         list($response, $opts) = $this->_request('post', $url, $params, $opts);
  226.         $this->refreshFrom($response, $opts);
  228.         return $this;
  229.     }
  231.     /**
  232.      * @param null|array $params
  233.      * @param null|array|string $opts
  234.      *
  235.      * @throws \Stripe\Exception\ApiErrorException if the request fails
  236.      *
  237.      * @return \Stripe\PaymentIntent the captured payment intent
  238.      */
  239.     public function capture($params = null, $opts = null)
  240.     {
  241.         $url = $this->instanceUrl() . '/capture';
  242.         list($response, $opts) = $this->_request('post', $url, $params, $opts);
  243.         $this->refreshFrom($response, $opts);
  245.         return $this;
  246.     }
  248.     /**
  249.      * @param null|array $params
  250.      * @param null|array|string $opts
  251.      *
  252.      * @throws \Stripe\Exception\ApiErrorException if the request fails
  253.      *
  254.      * @return \Stripe\PaymentIntent the confirmed payment intent
  255.      */
  256.     public function confirm($params = null, $opts = null)
  257.     {
  258.         $url = $this->instanceUrl() . '/confirm';
  259.         list($response, $opts) = $this->_request('post', $url, $params, $opts);
  260.         $this->refreshFrom($response, $opts);
  262.         return $this;
  263.     }
  265.     /**
  266.      * @param null|array $params
  267.      * @param null|array|string $opts
  268.      *
  269.      * @throws \Stripe\Exception\ApiErrorException if the request fails
  270.      *
  271.      * @return \Stripe\PaymentIntent the incremented payment intent
  272.      */
  273.     public function incrementAuthorization($params = null, $opts = null)
  274.     {
  275.         $url = $this->instanceUrl() . '/increment_authorization';
  276.         list($response, $opts) = $this->_request('post', $url, $params, $opts);
  277.         $this->refreshFrom($response, $opts);
  279.         return $this;
  280.     }
  282.     /**
  283.      * @param null|array $params
  284.      * @param null|array|string $opts
  285.      *
  286.      * @throws \Stripe\Exception\ApiErrorException if the request fails
  287.      *
  288.      * @return \Stripe\PaymentIntent the verified payment intent
  289.      */
  290.     public function verifyMicrodeposits($params = null, $opts = null)
  291.     {
  292.         $url = $this->instanceUrl() . '/verify_microdeposits';
  293.         list($response, $opts) = $this->_request('post', $url, $params, $opts);
  294.         $this->refreshFrom($response, $opts);
  296.         return $this;
  297.     }
  299.     /**
  300.      * @param null|array $params
  301.      * @param null|array|string $opts
  302.      *
  303.      * @throws \Stripe\Exception\ApiErrorException if the request fails
  304.      *
  305.      * @return \Stripe\SearchResult<\Stripe\PaymentIntent> the payment intent search results
  306.      */
  307.     public static function search($params = null, $opts = null)
  308.     {
  309.         $url = '/v1/payment_intents/search';
  311.         return static::_requestPage($url, \Stripe\SearchResult::class, $params, $opts);
  312.     }
  313. }