ConfirmationToken.php — Paid Membership Plugin, Ecommerce, User Registration Form, Login Form, User Profile & Restrict Content – ProfilePress 4.17.1

wp-user-avatar / third-party / vendor / stripe / stripe-php / lib / ConfirmationToken.php

wp-user-avatar / third-party / vendor / stripe / stripe-php / lib Last commit date

ConfirmationToken.php

53 lines

1	<?php
2
3	// File generated from our OpenAPI spec
4	namespace ProfilePressVendor\Stripe;
5
6	/**
7	* ConfirmationTokens help transport client side data collected by Stripe JS over
8	* to your server for confirming a PaymentIntent or SetupIntent. If the confirmation
9	* is successful, values present on the ConfirmationToken are written onto the Intent.
10	*
11	* To learn more about how to use ConfirmationToken, visit the related guides:
12	* - <a href="https://stripe.com/docs/payments/finalize-payments-on-the-server">Finalize payments on the server</a>
13	* - <a href="https://stripe.com/docs/payments/build-a-two-step-confirmation">Build two-step confirmation</a>.
14	*
15	* @property string $id Unique identifier for the object.
16	* @property string $object String representing the object's type. Objects of the same type share the same value.
17	* @property int $created Time at which the object was created. Measured in seconds since the Unix epoch.
18	* @property null\|int $expires_at Time at which this ConfirmationToken expires and can no longer be used to confirm a PaymentIntent or SetupIntent.
19	* @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.
20	* @property null\|\Stripe\StripeObject $mandate_data Data used for generating a Mandate.
21	* @property null\|string $payment_intent ID of the PaymentIntent that this ConfirmationToken was used to confirm, or null if this ConfirmationToken has not yet been used.
22	* @property null\|\Stripe\StripeObject $payment_method_options Payment-method-specific configuration for this ConfirmationToken.
23	* @property null\|\Stripe\StripeObject $payment_method_preview Payment details collected by the Payment Element, used to create a PaymentMethod when a PaymentIntent or SetupIntent is confirmed with this ConfirmationToken.
24	* @property null\|string $return_url Return URL used to confirm the Intent.
25	* @property null\|string $setup_future_usage <p>Indicates that you intend to make future payments with this ConfirmationToken's payment method.</p><p>The presence of this property will <a href="https://stripe.com/docs/payments/save-during-payment">attach the payment method</a> to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete.</p>
26	* @property null\|string $setup_intent ID of the SetupIntent that this ConfirmationToken was used to confirm, or null if this ConfirmationToken has not yet been used.
27	* @property null\|\Stripe\StripeObject $shipping Shipping information collected on this ConfirmationToken.
28	* @property bool $use_stripe_sdk Indicates whether the Stripe SDK is used to handle confirmation flow. Defaults to <code>true</code> on ConfirmationToken.
29	*/
30	class ConfirmationToken extends ApiResource
31	{
32	const OBJECT_NAME = 'confirmation_token';
33	const SETUP_FUTURE_USAGE_OFF_SESSION = 'off_session';
34	const SETUP_FUTURE_USAGE_ON_SESSION = 'on_session';
35	/**
36	* Retrieves an existing ConfirmationToken object.
37	*
38	* @param array\|string $id the ID of the API resource to retrieve, or an options array containing an `id` key
39	* @param null\|array\|string $opts
40	*
41	* @throws \Stripe\Exception\ApiErrorException if the request fails
42	*
43	* @return \Stripe\ConfirmationToken
44	*/
45	public static function retrieve($id, $opts = null)
46	{
47	$opts = \ProfilePressVendor\Stripe\Util\RequestOptions::parse($opts);
48	$instance = new static($id, $opts);
49	$instance->refresh();
50	return $instance;
51	}
52	}
53