Source.php — GiveWP – Donation Plugin and Fundraising Platform 4.16.3

give / vendor / stripe / stripe-php / lib / Source.php

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

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

Source.php

169 lines

1	<?php
2
3	// File generated from our OpenAPI spec
4
5	namespace Stripe;
6
7	/**
8	* <code>Source</code> objects allow you to accept a variety of payment methods.
9	* They represent a customer's payment instrument, and can be used with the Stripe
10	* API just like a <code>Card</code> object: once chargeable, they can be charged,
11	* or can be attached to customers.
12	*
13	* Related guides: <a href="https://stripe.com/docs/sources">Sources API</a> and <a
14	* href="https://stripe.com/docs/sources/customers">Sources & Customers</a>.
15	*
16	* @property string $id Unique identifier for the object.
17	* @property string $object String representing the object's type. Objects of the same type share the same value.
18	* @property \Stripe\StripeObject $ach_credit_transfer
19	* @property \Stripe\StripeObject $ach_debit
20	* @property \Stripe\StripeObject $acss_debit
21	* @property \Stripe\StripeObject $alipay
22	* @property null\|int $amount A positive integer in the smallest currency unit (that is, 100 cents for $1.00, or 1 for ¥1, Japanese Yen being a zero-decimal currency) representing the total amount associated with the source. This is the amount for which the source will be chargeable once ready. Required for <code>single_use</code> sources.
23	* @property \Stripe\StripeObject $au_becs_debit
24	* @property \Stripe\StripeObject $bancontact
25	* @property \Stripe\StripeObject $card
26	* @property \Stripe\StripeObject $card_present
27	* @property string $client_secret The client secret of the source. Used for client-side retrieval using a publishable key.
28	* @property \Stripe\StripeObject $code_verification
29	* @property int $created Time at which the object was created. Measured in seconds since the Unix epoch.
30	* @property null\|string $currency Three-letter <a href="https://stripe.com/docs/currencies">ISO code for the currency</a> associated with the source. This is the currency for which the source will be chargeable once ready. Required for <code>single_use</code> sources.
31	* @property string $customer The ID of the customer to which this source is attached. This will not be present when the source has not been attached to a customer.
32	* @property \Stripe\StripeObject $eps
33	* @property string $flow The authentication <code>flow</code> of the source. <code>flow</code> is one of <code>redirect</code>, <code>receiver</code>, <code>code_verification</code>, <code>none</code>.
34	* @property \Stripe\StripeObject $giropay
35	* @property \Stripe\StripeObject $ideal
36	* @property \Stripe\StripeObject $klarna
37	* @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.
38	* @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.
39	* @property \Stripe\StripeObject $multibanco
40	* @property null\|\Stripe\StripeObject $owner Information about the owner of the payment instrument that may be used or required by particular source types.
41	* @property \Stripe\StripeObject $p24
42	* @property \Stripe\StripeObject $receiver
43	* @property \Stripe\StripeObject $redirect
44	* @property \Stripe\StripeObject $sepa_credit_transfer
45	* @property \Stripe\StripeObject $sepa_debit
46	* @property \Stripe\StripeObject $sofort
47	* @property \Stripe\StripeObject $source_order
48	* @property null\|string $statement_descriptor Extra information about a source. This will appear on your customer's statement every time you charge the source.
49	* @property string $status The status of the source, one of <code>canceled</code>, <code>chargeable</code>, <code>consumed</code>, <code>failed</code>, or <code>pending</code>. Only <code>chargeable</code> sources can be used to create a charge.
50	* @property \Stripe\StripeObject $three_d_secure
51	* @property string $type The <code>type</code> of the source. The <code>type</code> is a payment method, one of <code>ach_credit_transfer</code>, <code>ach_debit</code>, <code>alipay</code>, <code>bancontact</code>, <code>card</code>, <code>card_present</code>, <code>eps</code>, <code>giropay</code>, <code>ideal</code>, <code>multibanco</code>, <code>klarna</code>, <code>p24</code>, <code>sepa_debit</code>, <code>sofort</code>, <code>three_d_secure</code>, or <code>wechat</code>. An additional hash is included on the source with a name matching this value. It contains additional information specific to the <a href="https://stripe.com/docs/sources">payment method</a> used.
52	* @property null\|string $usage Either <code>reusable</code> or <code>single_use</code>. Whether this source should be reusable or not. Some source types may or may not be reusable by construction, while others may leave the option at creation. If an incompatible value is passed, an error will be returned.
53	* @property \Stripe\StripeObject $wechat
54	*/
55	class Source extends ApiResource
56	{
57	const OBJECT_NAME = 'source';
58
59	use ApiOperations\Create;
60	use ApiOperations\Retrieve;
61	use ApiOperations\Update;
62
63	const FLOW_CODE_VERIFICATION = 'code_verification';
64	const FLOW_NONE = 'none';
65	const FLOW_RECEIVER = 'receiver';
66	const FLOW_REDIRECT = 'redirect';
67
68	const STATUS_CANCELED = 'canceled';
69	const STATUS_CHARGEABLE = 'chargeable';
70	const STATUS_CONSUMED = 'consumed';
71	const STATUS_FAILED = 'failed';
72	const STATUS_PENDING = 'pending';
73
74	const USAGE_REUSABLE = 'reusable';
75	const USAGE_SINGLE_USE = 'single_use';
76
77	use ApiOperations\NestedResource;
78
79	/**
80	* @param null\|array $params
81	* @param null\|array\|string $opts
82	*
83	* @throws \Stripe\Exception\UnexpectedValueException if the source is not attached to a customer
84	* @throws \Stripe\Exception\ApiErrorException if the request fails
85	*
86	* @return \Stripe\Source the detached source
87	*/
88	public function detach($params = null, $opts = null)
89	{
90	self::_validateParams($params);
91
92	$id = $this['id'];
93	if (!$id) {
94	$class = static::class;
95	$msg = "Could not determine which URL to request: {$class} instance "
96	. "has invalid ID: {$id}";
97
98	throw new Exception\UnexpectedValueException($msg, null);
99	}
100
101	if ($this['customer']) {
102	$base = Customer::classUrl();
103	$parentExtn = \urlencode(Util\Util::utf8($this['customer']));
104	$extn = \urlencode(Util\Util::utf8($id));
105	$url = "{$base}/{$parentExtn}/sources/{$extn}";
106
107	list($response, $opts) = $this->_request('delete', $url, $params, $opts);
108	$this->refreshFrom($response, $opts);
109
110	return $this;
111	}
112	$message = 'This source object does not appear to be currently attached '
113	. 'to a customer object.';
114
115	throw new Exception\UnexpectedValueException($message);
116	}
117
118	/**
119	* @deprecated sourceTransactions is deprecated. Please use Source::allSourceTransactions instead.
120	*
121	* @param null\|array $params
122	* @param null\|array\|string $opts
123	*
124	* @throws \Stripe\Exception\ApiErrorException if the request fails
125	*
126	* @return \Stripe\Collection the list of source transactions
127	*/
128	public function sourceTransactions($params = null, $opts = null)
129	{
130	$url = $this->instanceUrl() . '/source_transactions';
131	list($response, $opts) = $this->_request('get', $url, $params, $opts);
132	$obj = \Stripe\Util\Util::convertToStripeObject($response, $opts);
133	$obj->setLastResponse($response);
134
135	return $obj;
136	}
137
138	/**
139	* @param string $id
140	* @param null\|array $params
141	* @param null\|array\|string $opts
142	*
143	* @throws \Stripe\Exception\ApiErrorException if the request fails
144	*
145	* @return \Stripe\Collection the list of source transactions
146	*/
147	public static function allSourceTransactions($id, $params = null, $opts = null)
148	{
149	return self::_allNestedResources($id, '/source_transactions', $params, $opts);
150	}
151
152	/**
153	* @param null\|array $params
154	* @param null\|array\|string $opts
155	*
156	* @throws \Stripe\Exception\ApiErrorException if the request fails
157	*
158	* @return \Stripe\Source the verified source
159	*/
160	public function verify($params = null, $opts = null)
161	{
162	$url = $this->instanceUrl() . '/verify';
163	list($response, $opts) = $this->_request('post', $url, $params, $opts);
164	$this->refreshFrom($response, $opts);
165
166	return $this;
167	}
168	}
169