SetupIntentService.php — GiveWP – Donation Plugin and Fundraising Platform 4.16.3

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

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

SetupIntentService.php

144 lines

1	<?php
2
3	// File generated from our OpenAPI spec
4
5	namespace Stripe\Service;
6
7	class SetupIntentService extends \Stripe\Service\AbstractService
8	{
9	/**
10	* Returns a list of SetupIntents.
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<\Stripe\SetupIntent>
18	*/
19	public function all($params = null, $opts = null)
20	{
21	return $this->requestCollection('get', '/v1/setup_intents', $params, $opts);
22	}
23
24	/**
25	* A SetupIntent object can be canceled when it is in one of these statuses:
26	* <code>requires_payment_method</code>, <code>requires_confirmation</code>, or
27	* <code>requires_action</code>.
28	*
29	* Once canceled, setup is abandoned and any operations on the SetupIntent will
30	* fail with an error.
31	*
32	* @param string $id
33	* @param null\|array $params
34	* @param null\|array\|\Stripe\Util\RequestOptions $opts
35	*
36	* @throws \Stripe\Exception\ApiErrorException if the request fails
37	*
38	* @return \Stripe\SetupIntent
39	*/
40	public function cancel($id, $params = null, $opts = null)
41	{
42	return $this->request('post', $this->buildPath('/v1/setup_intents/%s/cancel', $id), $params, $opts);
43	}
44
45	/**
46	* Confirm that your customer intends to set up the current or provided payment
47	* method. For example, you would confirm a SetupIntent when a customer hits the
48	* “Save” button on a payment method management page on your website.
49	*
50	* If the selected payment method does not require any additional steps from the
51	* customer, the SetupIntent will transition to the <code>succeeded</code> status.
52	*
53	* Otherwise, it will transition to the <code>requires_action</code> status and
54	* suggest additional actions via <code>next_action</code>. If setup fails, the
55	* SetupIntent will transition to the <code>requires_payment_method</code> status.
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\SetupIntent
64	*/
65	public function confirm($id, $params = null, $opts = null)
66	{
67	return $this->request('post', $this->buildPath('/v1/setup_intents/%s/confirm', $id), $params, $opts);
68	}
69
70	/**
71	* Creates a SetupIntent object.
72	*
73	* After the SetupIntent is created, attach a payment method and <a
74	* href="/docs/api/setup_intents/confirm">confirm</a> to collect any required
75	* permissions to charge the payment method later.
76	*
77	* @param null\|array $params
78	* @param null\|array\|\Stripe\Util\RequestOptions $opts
79	*
80	* @throws \Stripe\Exception\ApiErrorException if the request fails
81	*
82	* @return \Stripe\SetupIntent
83	*/
84	public function create($params = null, $opts = null)
85	{
86	return $this->request('post', '/v1/setup_intents', $params, $opts);
87	}
88
89	/**
90	* Retrieves the details of a SetupIntent that has previously been created.
91	*
92	* Client-side retrieval using a publishable key is allowed when the
93	* <code>client_secret</code> is provided in the query string.
94	*
95	* When retrieved with a publishable key, only a subset of properties will be
96	* returned. Please refer to the <a href="#setup_intent_object">SetupIntent</a>
97	* object reference for more details.
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\SetupIntent
106	*/
107	public function retrieve($id, $params = null, $opts = null)
108	{
109	return $this->request('get', $this->buildPath('/v1/setup_intents/%s', $id), $params, $opts);
110	}
111
112	/**
113	* Updates a SetupIntent object.
114	*
115	* @param string $id
116	* @param null\|array $params
117	* @param null\|array\|\Stripe\Util\RequestOptions $opts
118	*
119	* @throws \Stripe\Exception\ApiErrorException if the request fails
120	*
121	* @return \Stripe\SetupIntent
122	*/
123	public function update($id, $params = null, $opts = null)
124	{
125	return $this->request('post', $this->buildPath('/v1/setup_intents/%s', $id), $params, $opts);
126	}
127
128	/**
129	* Verifies microdeposits on a SetupIntent object.
130	*
131	* @param string $id
132	* @param null\|array $params
133	* @param null\|array\|\Stripe\Util\RequestOptions $opts
134	*
135	* @throws \Stripe\Exception\ApiErrorException if the request fails
136	*
137	* @return \Stripe\SetupIntent
138	*/
139	public function verifyMicrodeposits($id, $params = null, $opts = null)
140	{
141	return $this->request('post', $this->buildPath('/v1/setup_intents/%s/verify_microdeposits', $id), $params, $opts);
142	}
143	}
144