summaryrefslogtreecommitdiffstats
path: root/vendor/stripe/stripe-php/lib/Service/PaymentMethodService.php
diff options
context:
space:
mode:
Diffstat (limited to 'vendor/stripe/stripe-php/lib/Service/PaymentMethodService.php')
-rw-r--r--vendor/stripe/stripe-php/lib/Service/PaymentMethodService.php251
1 files changed, 130 insertions, 121 deletions
diff --git a/vendor/stripe/stripe-php/lib/Service/PaymentMethodService.php b/vendor/stripe/stripe-php/lib/Service/PaymentMethodService.php
index 7111b9e..3ab1d24 100644
--- a/vendor/stripe/stripe-php/lib/Service/PaymentMethodService.php
+++ b/vendor/stripe/stripe-php/lib/Service/PaymentMethodService.php
@@ -1,121 +1,130 @@
-<?php
-
-// File generated from our OpenAPI spec
-
-namespace Stripe\Service;
-
-class PaymentMethodService extends \Stripe\Service\AbstractService
-{
- /**
- * Returns a list of PaymentMethods for a given Customer.
- *
- * @param null|array $params
- * @param null|array|\Stripe\Util\RequestOptions $opts
- *
- * @throws \Stripe\Exception\ApiErrorException if the request fails
- *
- * @return \Stripe\Collection
- */
- public function all($params = null, $opts = null)
- {
- return $this->requestCollection('get', '/v1/payment_methods', $params, $opts);
- }
-
- /**
- * Attaches a PaymentMethod object to a Customer.
- *
- * To attach a new PaymentMethod to a customer for future payments, we recommend
- * you use a <a href="/docs/api/setup_intents">SetupIntent</a> or a PaymentIntent
- * with <a
- * href="/docs/api/payment_intents/create#create_payment_intent-setup_future_usage">setup_future_usage</a>.
- * These approaches will perform any necessary steps to ensure that the
- * PaymentMethod can be used in a future payment. Using the
- * <code>/v1/payment_methods/:id/attach</code> endpoint does not ensure that future
- * payments can be made with the attached PaymentMethod. See <a
- * href="/docs/payments/payment-intents#future-usage">Optimizing cards for future
- * payments</a> for more information about setting up future payments.
- *
- * To use this PaymentMethod as the default for invoice or subscription payments,
- * set <a
- * href="/docs/api/customers/update#update_customer-invoice_settings-default_payment_method"><code>invoice_settings.default_payment_method</code></a>,
- * on the Customer to the PaymentMethod’s ID.
- *
- * @param string $id
- * @param null|array $params
- * @param null|array|\Stripe\Util\RequestOptions $opts
- *
- * @throws \Stripe\Exception\ApiErrorException if the request fails
- *
- * @return \Stripe\PaymentMethod
- */
- public function attach($id, $params = null, $opts = null)
- {
- return $this->request('post', $this->buildPath('/v1/payment_methods/%s/attach', $id), $params, $opts);
- }
-
- /**
- * Creates a PaymentMethod object. Read the <a
- * href="/docs/stripe-js/reference#stripe-create-payment-method">Stripe.js
- * reference</a> to learn how to create PaymentMethods via Stripe.js.
- *
- * @param null|array $params
- * @param null|array|\Stripe\Util\RequestOptions $opts
- *
- * @throws \Stripe\Exception\ApiErrorException if the request fails
- *
- * @return \Stripe\PaymentMethod
- */
- public function create($params = null, $opts = null)
- {
- return $this->request('post', '/v1/payment_methods', $params, $opts);
- }
-
- /**
- * Detaches a PaymentMethod object from a Customer.
- *
- * @param string $id
- * @param null|array $params
- * @param null|array|\Stripe\Util\RequestOptions $opts
- *
- * @throws \Stripe\Exception\ApiErrorException if the request fails
- *
- * @return \Stripe\PaymentMethod
- */
- public function detach($id, $params = null, $opts = null)
- {
- return $this->request('post', $this->buildPath('/v1/payment_methods/%s/detach', $id), $params, $opts);
- }
-
- /**
- * Retrieves a PaymentMethod object.
- *
- * @param string $id
- * @param null|array $params
- * @param null|array|\Stripe\Util\RequestOptions $opts
- *
- * @throws \Stripe\Exception\ApiErrorException if the request fails
- *
- * @return \Stripe\PaymentMethod
- */
- public function retrieve($id, $params = null, $opts = null)
- {
- return $this->request('get', $this->buildPath('/v1/payment_methods/%s', $id), $params, $opts);
- }
-
- /**
- * Updates a PaymentMethod object. A PaymentMethod must be attached a customer to
- * be updated.
- *
- * @param string $id
- * @param null|array $params
- * @param null|array|\Stripe\Util\RequestOptions $opts
- *
- * @throws \Stripe\Exception\ApiErrorException if the request fails
- *
- * @return \Stripe\PaymentMethod
- */
- public function update($id, $params = null, $opts = null)
- {
- return $this->request('post', $this->buildPath('/v1/payment_methods/%s', $id), $params, $opts);
- }
-}
+<?php
+
+// File generated from our OpenAPI spec
+
+namespace Stripe\Service;
+
+class PaymentMethodService extends \Stripe\Service\AbstractService
+{
+ /**
+ * Returns a list of PaymentMethods. For listing a customer’s payment methods, you
+ * should use <a href="/docs/api/payment_methods/customer_list">List a Customer’s
+ * PaymentMethods</a>.
+ *
+ * @param null|array $params
+ * @param null|array|\Stripe\Util\RequestOptions $opts
+ *
+ * @throws \Stripe\Exception\ApiErrorException if the request fails
+ *
+ * @return \Stripe\Collection<\Stripe\PaymentMethod>
+ */
+ public function all($params = null, $opts = null)
+ {
+ return $this->requestCollection('get', '/v1/payment_methods', $params, $opts);
+ }
+
+ /**
+ * Attaches a PaymentMethod object to a Customer.
+ *
+ * To attach a new PaymentMethod to a customer for future payments, we recommend
+ * you use a <a href="/docs/api/setup_intents">SetupIntent</a> or a PaymentIntent
+ * with <a
+ * href="/docs/api/payment_intents/create#create_payment_intent-setup_future_usage">setup_future_usage</a>.
+ * These approaches will perform any necessary steps to ensure that the
+ * PaymentMethod can be used in a future payment. Using the
+ * <code>/v1/payment_methods/:id/attach</code> endpoint does not ensure that future
+ * payments can be made with the attached PaymentMethod. See <a
+ * href="/docs/payments/payment-intents#future-usage">Optimizing cards for future
+ * payments</a> for more information about setting up future payments.
+ *
+ * To use this PaymentMethod as the default for invoice or subscription payments,
+ * set <a
+ * href="/docs/api/customers/update#update_customer-invoice_settings-default_payment_method"><code>invoice_settings.default_payment_method</code></a>,
+ * on the Customer to the PaymentMethod’s ID.
+ *
+ * @param string $id
+ * @param null|array $params
+ * @param null|array|\Stripe\Util\RequestOptions $opts
+ *
+ * @throws \Stripe\Exception\ApiErrorException if the request fails
+ *
+ * @return \Stripe\PaymentMethod
+ */
+ public function attach($id, $params = null, $opts = null)
+ {
+ return $this->request('post', $this->buildPath('/v1/payment_methods/%s/attach', $id), $params, $opts);
+ }
+
+ /**
+ * Creates a PaymentMethod object. Read the <a
+ * href="/docs/stripe-js/reference#stripe-create-payment-method">Stripe.js
+ * reference</a> to learn how to create PaymentMethods via Stripe.js.
+ *
+ * Instead of creating a PaymentMethod directly, we recommend using the <a
+ * href="/docs/payments/accept-a-payment">PaymentIntents</a> API to accept a
+ * payment immediately or the <a
+ * href="/docs/payments/save-and-reuse">SetupIntent</a> API to collect payment
+ * method details ahead of a future payment.
+ *
+ * @param null|array $params
+ * @param null|array|\Stripe\Util\RequestOptions $opts
+ *
+ * @throws \Stripe\Exception\ApiErrorException if the request fails
+ *
+ * @return \Stripe\PaymentMethod
+ */
+ public function create($params = null, $opts = null)
+ {
+ return $this->request('post', '/v1/payment_methods', $params, $opts);
+ }
+
+ /**
+ * Detaches a PaymentMethod object from a Customer. After a PaymentMethod is
+ * detached, it can no longer be used for a payment or re-attached to a Customer.
+ *
+ * @param string $id
+ * @param null|array $params
+ * @param null|array|\Stripe\Util\RequestOptions $opts
+ *
+ * @throws \Stripe\Exception\ApiErrorException if the request fails
+ *
+ * @return \Stripe\PaymentMethod
+ */
+ public function detach($id, $params = null, $opts = null)
+ {
+ return $this->request('post', $this->buildPath('/v1/payment_methods/%s/detach', $id), $params, $opts);
+ }
+
+ /**
+ * Retrieves a PaymentMethod object.
+ *
+ * @param string $id
+ * @param null|array $params
+ * @param null|array|\Stripe\Util\RequestOptions $opts
+ *
+ * @throws \Stripe\Exception\ApiErrorException if the request fails
+ *
+ * @return \Stripe\PaymentMethod
+ */
+ public function retrieve($id, $params = null, $opts = null)
+ {
+ return $this->request('get', $this->buildPath('/v1/payment_methods/%s', $id), $params, $opts);
+ }
+
+ /**
+ * Updates a PaymentMethod object. A PaymentMethod must be attached a customer to
+ * be updated.
+ *
+ * @param string $id
+ * @param null|array $params
+ * @param null|array|\Stripe\Util\RequestOptions $opts
+ *
+ * @throws \Stripe\Exception\ApiErrorException if the request fails
+ *
+ * @return \Stripe\PaymentMethod
+ */
+ public function update($id, $params = null, $opts = null)
+ {
+ return $this->request('post', $this->buildPath('/v1/payment_methods/%s', $id), $params, $opts);
+ }
+}