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

PaymentMethodService.php in GiveWP – Donation Plugin and Fundraising Platform 4.15.5, at vendor/stripe/stripe-php/lib/Service/PaymentMethodService.php

131 lines 4.8 KB

Raw Download Zip

1	<?php
2
3	// File generated from our OpenAPI spec
4
5	namespace Stripe\Service;
6
7	class PaymentMethodService extends \Stripe\Service\AbstractService
8	{
9	/**
10	* Returns a list of PaymentMethods. For listing a customer’s payment methods, you
11	* should use <a href="/docs/api/payment_methods/customer_list">List a Customer’s
12	* PaymentMethods</a>.
13	*
14	* @param null\|array $params
15	* @param null\|array\|\Stripe\Util\RequestOptions $opts
16	*
17	* @throws \Stripe\Exception\ApiErrorException if the request fails
18	*
19	* @return \Stripe\Collection<\Stripe\PaymentMethod>
20	*/
21	public function all($params = null, $opts = null)
22	{
23	return $this->requestCollection('get', '/v1/payment_methods', $params, $opts);
24	}
25
26	/**
27	* Attaches a PaymentMethod object to a Customer.
28	*
29	* To attach a new PaymentMethod to a customer for future payments, we recommend
30	* you use a <a href="/docs/api/setup_intents">SetupIntent</a> or a PaymentIntent
31	* with <a
32	* href="/docs/api/payment_intents/create#create_payment_intent-setup_future_usage">setup_future_usage</a>.
33	* These approaches will perform any necessary steps to ensure that the
34	* PaymentMethod can be used in a future payment. Using the
35	* <code>/v1/payment_methods/:id/attach</code> endpoint does not ensure that future
36	* payments can be made with the attached PaymentMethod. See <a
37	* href="/docs/payments/payment-intents#future-usage">Optimizing cards for future
38	* payments</a> for more information about setting up future payments.
39	*
40	* To use this PaymentMethod as the default for invoice or subscription payments,
41	* set <a
42	* href="/docs/api/customers/update#update_customer-invoice_settings-default_payment_method"><code>invoice_settings.default_payment_method</code></a>,
43	* on the Customer to the PaymentMethod’s ID.
44	*
45	* @param string $id
46	* @param null\|array $params
47	* @param null\|array\|\Stripe\Util\RequestOptions $opts
48	*
49	* @throws \Stripe\Exception\ApiErrorException if the request fails
50	*
51	* @return \Stripe\PaymentMethod
52	*/
53	public function attach($id, $params = null, $opts = null)
54	{
55	return $this->request('post', $this->buildPath('/v1/payment_methods/%s/attach', $id), $params, $opts);
56	}
57
58	/**
59	* Creates a PaymentMethod object. Read the <a
60	* href="/docs/stripe-js/reference#stripe-create-payment-method">Stripe.js
61	* reference</a> to learn how to create PaymentMethods via Stripe.js.
62	*
63	* Instead of creating a PaymentMethod directly, we recommend using the <a
64	* href="/docs/payments/accept-a-payment">PaymentIntents</a> API to accept a
65	* payment immediately or the <a
66	* href="/docs/payments/save-and-reuse">SetupIntent</a> API to collect payment
67	* method details ahead of a future payment.
68	*
69	* @param null\|array $params
70	* @param null\|array\|\Stripe\Util\RequestOptions $opts
71	*
72	* @throws \Stripe\Exception\ApiErrorException if the request fails
73	*
74	* @return \Stripe\PaymentMethod
75	*/
76	public function create($params = null, $opts = null)
77	{
78	return $this->request('post', '/v1/payment_methods', $params, $opts);
79	}
80
81	/**
82	* Detaches a PaymentMethod object from a Customer. After a PaymentMethod is
83	* detached, it can no longer be used for a payment or re-attached to a Customer.
84	*
85	* @param string $id
86	* @param null\|array $params
87	* @param null\|array\|\Stripe\Util\RequestOptions $opts
88	*
89	* @throws \Stripe\Exception\ApiErrorException if the request fails
90	*
91	* @return \Stripe\PaymentMethod
92	*/
93	public function detach($id, $params = null, $opts = null)
94	{
95	return $this->request('post', $this->buildPath('/v1/payment_methods/%s/detach', $id), $params, $opts);
96	}
97
98	/**
99	* Retrieves a PaymentMethod object.
100	*
101	* @param string $id
102	* @param null\|array $params
103	* @param null\|array\|\Stripe\Util\RequestOptions $opts
104	*
105	* @throws \Stripe\Exception\ApiErrorException if the request fails
106	*
107	* @return \Stripe\PaymentMethod
108	*/
109	public function retrieve($id, $params = null, $opts = null)
110	{
111	return $this->request('get', $this->buildPath('/v1/payment_methods/%s', $id), $params, $opts);
112	}
113
114	/**
115	* Updates a PaymentMethod object. A PaymentMethod must be attached a customer to
116	* be updated.
117	*
118	* @param string $id
119	* @param null\|array $params
120	* @param null\|array\|\Stripe\Util\RequestOptions $opts
121	*
122	* @throws \Stripe\Exception\ApiErrorException if the request fails
123	*
124	* @return \Stripe\PaymentMethod
125	*/
126	public function update($id, $params = null, $opts = null)
127	{
128	return $this->request('post', $this->buildPath('/v1/payment_methods/%s', $id), $params, $opts);
129	}
130	}
131