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

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

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

PaymentMethodService.php

128 lines

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 a given Customer.
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_methods', $params, $opts);
22	}
23
24	/**
25	* Attaches a PaymentMethod object to a Customer.
26	*
27	* To attach a new PaymentMethod to a customer for future payments, we recommend
28	* you use a <a href="/docs/api/setup_intents">SetupIntent</a> or a PaymentIntent
29	* with <a
30	* href="/docs/api/payment_intents/create#create_payment_intent-setup_future_usage">setup_future_usage</a>.
31	* These approaches will perform any necessary steps to ensure that the
32	* PaymentMethod can be used in a future payment. Using the
33	* <code>/v1/payment_methods/:id/attach</code> endpoint does not ensure that future
34	* payments can be made with the attached PaymentMethod. See <a
35	* href="/docs/payments/payment-intents#future-usage">Optimizing cards for future
36	* payments</a> for more information about setting up future payments.
37	*
38	* To use this PaymentMethod as the default for invoice or subscription payments,
39	* set <a
40	* href="/docs/api/customers/update#update_customer-invoice_settings-default_payment_method"><code>invoice_settings.default_payment_method</code></a>,
41	* on the Customer to the PaymentMethod’s ID.
42	*
43	* @param string $id
44	* @param null\|array $params
45	* @param null\|array\|\Stripe\Util\RequestOptions $opts
46	*
47	* @throws \Stripe\Exception\ApiErrorException if the request fails
48	*
49	* @return \Stripe\PaymentMethod
50	*/
51	public function attach($id, $params = null, $opts = null)
52	{
53	return $this->request('post', $this->buildPath('/v1/payment_methods/%s/attach', $id), $params, $opts);
54	}
55
56	/**
57	* Creates a PaymentMethod object. Read the <a
58	* href="/docs/stripe-js/reference#stripe-create-payment-method">Stripe.js
59	* reference</a> to learn how to create PaymentMethods via Stripe.js.
60	*
61	* Instead of creating a PaymentMethod directly, we recommend using the <a
62	* href="/docs/payments/accept-a-payment">PaymentIntents</a> API to accept a
63	* payment immediately or the <a
64	* href="/docs/payments/save-and-reuse">SetupIntent</a> API to collect payment
65	* method details ahead of a future payment.
66	*
67	* @param null\|array $params
68	* @param null\|array\|\Stripe\Util\RequestOptions $opts
69	*
70	* @throws \Stripe\Exception\ApiErrorException if the request fails
71	*
72	* @return \Stripe\PaymentMethod
73	*/
74	public function create($params = null, $opts = null)
75	{
76	return $this->request('post', '/v1/payment_methods', $params, $opts);
77	}
78
79	/**
80	* Detaches a PaymentMethod object from a Customer.
81	*
82	* @param string $id
83	* @param null\|array $params
84	* @param null\|array\|\Stripe\Util\RequestOptions $opts
85	*
86	* @throws \Stripe\Exception\ApiErrorException if the request fails
87	*
88	* @return \Stripe\PaymentMethod
89	*/
90	public function detach($id, $params = null, $opts = null)
91	{
92	return $this->request('post', $this->buildPath('/v1/payment_methods/%s/detach', $id), $params, $opts);
93	}
94
95	/**
96	* Retrieves a PaymentMethod object.
97	*
98	* @param string $id
99	* @param null\|array $params
100	* @param null\|array\|\Stripe\Util\RequestOptions $opts
101	*
102	* @throws \Stripe\Exception\ApiErrorException if the request fails
103	*
104	* @return \Stripe\PaymentMethod
105	*/
106	public function retrieve($id, $params = null, $opts = null)
107	{
108	return $this->request('get', $this->buildPath('/v1/payment_methods/%s', $id), $params, $opts);
109	}
110
111	/**
112	* Updates a PaymentMethod object. A PaymentMethod must be attached a customer to
113	* be updated.
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\PaymentMethod
122	*/
123	public function update($id, $params = null, $opts = null)
124	{
125	return $this->request('post', $this->buildPath('/v1/payment_methods/%s', $id), $params, $opts);
126	}
127	}
128