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

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

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

PaymentIntentService.php

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