PaymentIntentService.php — GiveWP – Donation Plugin and Fundraising Platform 2.24.0

give / vendor / stripe / stripe-php / lib / Service / PaymentIntentService.php

give / vendor / stripe / stripe-php / lib / Service Last commit date

PaymentIntentService.php

183 lines

1	<?php
2
3	// File generated from our OpenAPI spec
4
5	namespace Stripe\Service;
6
7	class PaymentIntentService extends \Stripe\Service\AbstractService
8	{
9	/**
10	* Returns a list of PaymentIntents.
11	*
12	* @param null\|array $params
13	* @param null\|array\|\Stripe\Util\RequestOptions $opts
14	*
15	* @throws \Stripe\Exception\ApiErrorException if the request fails
16	*
17	* @return \Stripe\Collection
18	*/
19	public function all($params = null, $opts = null)
20	{
21	return $this->requestCollection('get', '/v1/payment_intents', $params, $opts);
22	}
23
24	/**
25	* A PaymentIntent object can be canceled when it is in one of these statuses:
26	* <code>requires_payment_method</code>, <code>requires_capture</code>,
27	* <code>requires_confirmation</code>, <code>requires_action</code>, or
28	* <code>processing</code>.
29	*
30	* Once canceled, no additional charges will be made by the PaymentIntent and any
31	* operations on the PaymentIntent will fail with an error. For PaymentIntents with
32	* <code>status=’requires_capture’</code>, the remaining
33	* <code>amount_capturable</code> will automatically be refunded.
34	*
35	* @param string $id
36	* @param null\|array $params
37	* @param null\|array\|\Stripe\Util\RequestOptions $opts
38	*
39	* @throws \Stripe\Exception\ApiErrorException if the request fails
40	*
41	* @return \Stripe\PaymentIntent
42	*/
43	public function cancel($id, $params = null, $opts = null)
44	{
45	return $this->request('post', $this->buildPath('/v1/payment_intents/%s/cancel', $id), $params, $opts);
46	}
47
48	/**
49	* Capture the funds of an existing uncaptured PaymentIntent when its status is
50	* <code>requires_capture</code>.
51	*
52	* Uncaptured PaymentIntents will be canceled a set number of days after they are
53	* created (7 by default).
54	*
55	* Learn more about <a href="/docs/payments/capture-later">separate authorization
56	* and capture</a>.
57	*
58	* @param string $id
59	* @param null\|array $params
60	* @param null\|array\|\Stripe\Util\RequestOptions $opts
61	*
62	* @throws \Stripe\Exception\ApiErrorException if the request fails
63	*
64	* @return \Stripe\PaymentIntent
65	*/
66	public function capture($id, $params = null, $opts = null)
67	{
68	return $this->request('post', $this->buildPath('/v1/payment_intents/%s/capture', $id), $params, $opts);
69	}
70
71	/**
72	* Confirm that your customer intends to pay with current or provided payment
73	* method. Upon confirmation, the PaymentIntent will attempt to initiate a payment.
74	*
75	* If the selected payment method requires additional authentication steps, the
76	* PaymentIntent will transition to the <code>requires_action</code> status and
77	* suggest additional actions via <code>next_action</code>. If payment fails, the
78	* PaymentIntent will transition to the <code>requires_payment_method</code>
79	* status. If payment succeeds, the PaymentIntent will transition to the
80	* <code>succeeded</code> status (or <code>requires_capture</code>, if
81	* <code>capture_method</code> is set to <code>manual</code>).
82	*
83	* If the <code>confirmation_method</code> is <code>automatic</code>, payment may
84	* be attempted using our <a
85	* href="/docs/stripe-js/reference#stripe-handle-card-payment">client SDKs</a> and
86	* the PaymentIntent’s <a
87	* href="#payment_intent_object-client_secret">client_secret</a>. After
88	* <code>next_action</code>s are handled by the client, no additional confirmation
89	* is required to complete the payment.
90	*
91	* If the <code>confirmation_method</code> is <code>manual</code>, all payment
92	* attempts must be initiated using a secret key. If any actions are required for
93	* the payment, the PaymentIntent will return to the
94	* <code>requires_confirmation</code> state after those actions are completed. Your
95	* server needs to then explicitly re-confirm the PaymentIntent to initiate the
96	* next payment attempt. Read the <a
97	* href="/docs/payments/payment-intents/web-manual">expanded documentation</a> to
98	* learn more about manual confirmation.
99	*
100	* @param string $id
101	* @param null\|array $params
102	* @param null\|array\|\Stripe\Util\RequestOptions $opts
103	*
104	* @throws \Stripe\Exception\ApiErrorException if the request fails
105	*
106	* @return \Stripe\PaymentIntent
107	*/
108	public function confirm($id, $params = null, $opts = null)
109	{
110	return $this->request('post', $this->buildPath('/v1/payment_intents/%s/confirm', $id), $params, $opts);
111	}
112
113	/**
114	* Creates a PaymentIntent object.
115	*
116	* After the PaymentIntent is created, attach a payment method and <a
117	* href="/docs/api/payment_intents/confirm">confirm</a> to continue the payment.
118	* You can read more about the different payment flows available via the Payment
119	* Intents API <a href="/docs/payments/payment-intents">here</a>.
120	*
121	* When <code>confirm=true</code> is used during creation, it is equivalent to
122	* creating and confirming the PaymentIntent in the same call. You may use any
123	* parameters available in the <a href="/docs/api/payment_intents/confirm">confirm
124	* API</a> when <code>confirm=true</code> is supplied.
125	*
126	* @param null\|array $params
127	* @param null\|array\|\Stripe\Util\RequestOptions $opts
128	*
129	* @throws \Stripe\Exception\ApiErrorException if the request fails
130	*
131	* @return \Stripe\PaymentIntent
132	*/
133	public function create($params = null, $opts = null)
134	{
135	return $this->request('post', '/v1/payment_intents', $params, $opts);
136	}
137
138	/**
139	* Retrieves the details of a PaymentIntent that has previously been created.
140	*
141	* Client-side retrieval using a publishable key is allowed when the
142	* <code>client_secret</code> is provided in the query string.
143	*
144	* When retrieved with a publishable key, only a subset of properties will be
145	* returned. Please refer to the <a href="#payment_intent_object">payment
146	* intent</a> object reference for more details.
147	*
148	* @param string $id
149	* @param null\|array $params
150	* @param null\|array\|\Stripe\Util\RequestOptions $opts
151	*
152	* @throws \Stripe\Exception\ApiErrorException if the request fails
153	*
154	* @return \Stripe\PaymentIntent
155	*/
156	public function retrieve($id, $params = null, $opts = null)
157	{
158	return $this->request('get', $this->buildPath('/v1/payment_intents/%s', $id), $params, $opts);
159	}
160
161	/**
162	* Updates properties on a PaymentIntent object without confirming.
163	*
164	* Depending on which properties you update, you may need to confirm the
165	* PaymentIntent again. For example, updating the <code>payment_method</code> will
166	* always require you to confirm the PaymentIntent again. If you prefer to update
167	* and confirm at the same time, we recommend updating properties via the <a
168	* href="/docs/api/payment_intents/confirm">confirm API</a> instead.
169	*
170	* @param string $id
171	* @param null\|array $params
172	* @param null\|array\|\Stripe\Util\RequestOptions $opts
173	*
174	* @throws \Stripe\Exception\ApiErrorException if the request fails
175	*
176	* @return \Stripe\PaymentIntent
177	*/
178	public function update($id, $params = null, $opts = null)
179	{
180	return $this->request('post', $this->buildPath('/v1/payment_intents/%s', $id), $params, $opts);
181	}
182	}
183