| 1 |
<?php |
| 2 |
|
| 3 |
// File generated from our OpenAPI spec |
| 4 |
|
| 5 |
namespace Stripe; |
| 6 |
|
| 7 |
/** |
| 8 |
* PaymentMethod objects represent your customer's payment instruments. You can use |
| 9 |
* them with <a |
| 10 |
* href="https://stripe.com/docs/payments/payment-intents">PaymentIntents</a> to |
| 11 |
* collect payments or save them to Customer objects to store instrument details |
| 12 |
* for future payments. |
| 13 |
* |
| 14 |
* Related guides: <a |
| 15 |
* href="https://stripe.com/docs/payments/payment-methods">Payment Methods</a> and |
| 16 |
* <a href="https://stripe.com/docs/payments/more-payment-scenarios">More Payment |
| 17 |
* Scenarios</a>. |
| 18 |
* |
| 19 |
* @property string $id Unique identifier for the object. |
| 20 |
* @property string $object String representing the object's type. Objects of the same type share the same value. |
| 21 |
* @property \Stripe\StripeObject $acss_debit |
| 22 |
* @property \Stripe\StripeObject $afterpay_clearpay |
| 23 |
* @property \Stripe\StripeObject $alipay |
| 24 |
* @property \Stripe\StripeObject $au_becs_debit |
| 25 |
* @property \Stripe\StripeObject $bacs_debit |
| 26 |
* @property \Stripe\StripeObject $bancontact |
| 27 |
* @property \Stripe\StripeObject $billing_details |
| 28 |
* @property \Stripe\StripeObject $boleto |
| 29 |
* @property \Stripe\StripeObject $card |
| 30 |
* @property \Stripe\StripeObject $card_present |
| 31 |
* @property int $created Time at which the object was created. Measured in seconds since the Unix epoch. |
| 32 |
* @property null|string|\Stripe\Customer $customer The ID of the Customer to which this PaymentMethod is saved. This will not be set when the PaymentMethod has not been saved to a Customer. |
| 33 |
* @property \Stripe\StripeObject $customer_balance |
| 34 |
* @property \Stripe\StripeObject $eps |
| 35 |
* @property \Stripe\StripeObject $fpx |
| 36 |
* @property \Stripe\StripeObject $giropay |
| 37 |
* @property \Stripe\StripeObject $grabpay |
| 38 |
* @property \Stripe\StripeObject $ideal |
| 39 |
* @property \Stripe\StripeObject $interac_present |
| 40 |
* @property \Stripe\StripeObject $klarna |
| 41 |
* @property \Stripe\StripeObject $konbini |
| 42 |
* @property bool $livemode Has the value <code>true</code> if the object exists in live mode or the value <code>false</code> if the object exists in test mode. |
| 43 |
* @property null|\Stripe\StripeObject $metadata Set of <a href="https://stripe.com/docs/api/metadata">key-value pairs</a> that you can attach to an object. This can be useful for storing additional information about the object in a structured format. |
| 44 |
* @property \Stripe\StripeObject $oxxo |
| 45 |
* @property \Stripe\StripeObject $p24 |
| 46 |
* @property \Stripe\StripeObject $paynow |
| 47 |
* @property \Stripe\StripeObject $sepa_debit |
| 48 |
* @property \Stripe\StripeObject $sofort |
| 49 |
* @property string $type The type of the PaymentMethod. An additional hash is included on the PaymentMethod with a name matching this value. It contains additional information specific to the PaymentMethod type. |
| 50 |
* @property \Stripe\StripeObject $us_bank_account |
| 51 |
* @property \Stripe\StripeObject $wechat_pay |
| 52 |
*/ |
| 53 |
class PaymentMethod extends ApiResource |
| 54 |
{ |
| 55 |
const OBJECT_NAME = 'payment_method'; |
| 56 |
|
| 57 |
use ApiOperations\All; |
| 58 |
use ApiOperations\Create; |
| 59 |
use ApiOperations\Retrieve; |
| 60 |
use ApiOperations\Update; |
| 61 |
|
| 62 |
/** |
| 63 |
* @param null|array $params |
| 64 |
* @param null|array|string $opts |
| 65 |
* |
| 66 |
* @throws \Stripe\Exception\ApiErrorException if the request fails |
| 67 |
* |
| 68 |
* @return \Stripe\PaymentMethod the attached payment method |
| 69 |
*/ |
| 70 |
public function attach($params = null, $opts = null) |
| 71 |
{ |
| 72 |
$url = $this->instanceUrl() . '/attach'; |
| 73 |
list($response, $opts) = $this->_request('post', $url, $params, $opts); |
| 74 |
$this->refreshFrom($response, $opts); |
| 75 |
|
| 76 |
return $this; |
| 77 |
} |
| 78 |
|
| 79 |
/** |
| 80 |
* @param null|array $params |
| 81 |
* @param null|array|string $opts |
| 82 |
* |
| 83 |
* @throws \Stripe\Exception\ApiErrorException if the request fails |
| 84 |
* |
| 85 |
* @return \Stripe\PaymentMethod the detached payment method |
| 86 |
*/ |
| 87 |
public function detach($params = null, $opts = null) |
| 88 |
{ |
| 89 |
$url = $this->instanceUrl() . '/detach'; |
| 90 |
list($response, $opts) = $this->_request('post', $url, $params, $opts); |
| 91 |
$this->refreshFrom($response, $opts); |
| 92 |
|
| 93 |
return $this; |
| 94 |
} |
| 95 |
} |
| 96 |
|
