ApiOperations
2 years ago
BillingPortal
2 years ago
Checkout
2 years ago
Exception
4 years ago
FinancialConnections
2 years ago
HttpClient
2 years ago
Identity
2 years ago
Issuing
2 years ago
Radar
2 years ago
Reporting
4 years ago
Service
2 years ago
Sigma
4 years ago
Terminal
2 years ago
TestHelpers
2 years ago
Util
2 years ago
Account.php
2 years ago
AccountLink.php
4 years ago
AlipayAccount.php
4 years ago
ApiRequestor.php
2 years ago
ApiResource.php
2 years ago
ApiResponse.php
4 years ago
ApplePayDomain.php
4 years ago
ApplicationFee.php
2 years ago
ApplicationFeeRefund.php
4 years ago
Balance.php
4 years ago
BalanceTransaction.php
4 years ago
BankAccount.php
4 years ago
BaseStripeClient.php
2 years ago
BaseStripeClientInterface.php
4 years ago
BitcoinReceiver.php
2 years ago
BitcoinTransaction.php
4 years ago
Capability.php
4 years ago
Card.php
2 years ago
CashBalance.php
2 years ago
Charge.php
2 years ago
Collection.php
2 years ago
CountrySpec.php
4 years ago
Coupon.php
2 years ago
CreditNote.php
2 years ago
CreditNoteLineItem.php
4 years ago
Customer.php
2 years ago
CustomerBalanceTransaction.php
4 years ago
Discount.php
2 years ago
Dispute.php
4 years ago
EphemeralKey.php
4 years ago
ErrorObject.php
4 years ago
Event.php
2 years ago
ExchangeRate.php
4 years ago
File.php
2 years ago
FileLink.php
4 years ago
FundingInstructions.php
2 years ago
Invoice.php
2 years ago
InvoiceItem.php
2 years ago
InvoiceLineItem.php
2 years ago
LineItem.php
4 years ago
LoginLink.php
4 years ago
Mandate.php
4 years ago
OAuth.php
4 years ago
OAuthErrorObject.php
4 years ago
Order.php
2 years ago
OrderItem.php
4 years ago
OrderReturn.php
4 years ago
PaymentIntent.php
2 years ago
PaymentLink.php
2 years ago
PaymentMethod.php
2 years ago
Payout.php
4 years ago
Person.php
2 years ago
Plan.php
2 years ago
Price.php
2 years ago
Product.php
2 years ago
PromotionCode.php
2 years ago
Quote.php
2 years ago
Recipient.php
2 years ago
RecipientTransfer.php
4 years ago
Refund.php
2 years ago
RequestTelemetry.php
4 years ago
Review.php
4 years ago
SKU.php
2 years ago
SearchResult.php
2 years ago
SetupAttempt.php
4 years ago
SetupIntent.php
2 years ago
ShippingRate.php
2 years ago
SingletonApiResource.php
2 years ago
Source.php
4 years ago
SourceTransaction.php
4 years ago
Stripe.php
2 years ago
StripeClient.php
2 years ago
StripeClientInterface.php
4 years ago
StripeObject.php
2 years ago
StripeStreamingClientInterface.php
4 years ago
Subscription.php
2 years ago
SubscriptionItem.php
2 years ago
SubscriptionSchedule.php
2 years ago
TaxCode.php
2 years ago
TaxId.php
2 years ago
TaxRate.php
4 years ago
ThreeDSecure.php
4 years ago
Token.php
4 years ago
Topup.php
4 years ago
Transfer.php
2 years ago
TransferReversal.php
4 years ago
UsageRecord.php
4 years ago
UsageRecordSummary.php
4 years ago
Webhook.php
4 years ago
WebhookEndpoint.php
4 years ago
WebhookSignature.php
4 years ago
PaymentMethod.php
96 lines
| 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 |