ApiOperations
6 years ago
Checkout
6 years ago
Error
6 years ago
HttpClient
6 years ago
Issuing
6 years ago
Radar
6 years ago
Reporting
6 years ago
Sigma
6 years ago
Terminal
6 years ago
Util
6 years ago
Account.php
6 years ago
AccountLink.php
6 years ago
AlipayAccount.php
6 years ago
ApiRequestor.php
6 years ago
ApiResource.php
6 years ago
ApiResponse.php
6 years ago
ApplePayDomain.php
6 years ago
ApplicationFee.php
6 years ago
ApplicationFeeRefund.php
6 years ago
Balance.php
6 years ago
BalanceTransaction.php
6 years ago
BankAccount.php
6 years ago
BitcoinReceiver.php
6 years ago
BitcoinTransaction.php
6 years ago
Capability.php
6 years ago
Card.php
6 years ago
Charge.php
6 years ago
Collection.php
6 years ago
CountrySpec.php
6 years ago
Coupon.php
6 years ago
CreditNote.php
6 years ago
Customer.php
6 years ago
CustomerBalanceTransaction.php
6 years ago
Discount.php
6 years ago
Dispute.php
6 years ago
EphemeralKey.php
6 years ago
Event.php
6 years ago
ExchangeRate.php
6 years ago
File.php
6 years ago
FileLink.php
6 years ago
FileUpload.php
6 years ago
Invoice.php
6 years ago
InvoiceItem.php
6 years ago
InvoiceLineItem.php
6 years ago
IssuerFraudRecord.php
6 years ago
LoginLink.php
6 years ago
OAuth.php
6 years ago
Order.php
6 years ago
OrderItem.php
6 years ago
OrderReturn.php
6 years ago
PaymentIntent.php
6 years ago
PaymentMethod.php
6 years ago
Payout.php
6 years ago
Person.php
6 years ago
Plan.php
6 years ago
Product.php
6 years ago
Recipient.php
6 years ago
RecipientTransfer.php
6 years ago
Refund.php
6 years ago
RequestTelemetry.php
6 years ago
Review.php
6 years ago
SKU.php
6 years ago
SetupIntent.php
6 years ago
SingletonApiResource.php
6 years ago
Source.php
6 years ago
SourceTransaction.php
6 years ago
Stripe.php
6 years ago
StripeObject.php
6 years ago
Subscription.php
6 years ago
SubscriptionItem.php
6 years ago
SubscriptionSchedule.php
6 years ago
TaxId.php
6 years ago
TaxRate.php
6 years ago
ThreeDSecure.php
6 years ago
Token.php
6 years ago
Topup.php
6 years ago
Transfer.php
6 years ago
TransferReversal.php
6 years ago
UsageRecord.php
6 years ago
UsageRecordSummary.php
6 years ago
Webhook.php
6 years ago
WebhookEndpoint.php
6 years ago
WebhookSignature.php
6 years ago
Source.php
154 lines
| 1 | <?php |
| 2 | |
| 3 | namespace Stripe; |
| 4 | |
| 5 | /** |
| 6 | * Class Source |
| 7 | * |
| 8 | * @property string $id |
| 9 | * @property string $object |
| 10 | * @property mixed $ach_credit_transfer |
| 11 | * @property mixed $ach_debit |
| 12 | * @property mixed $alipay |
| 13 | * @property int $amount |
| 14 | * @property mixed $bancontact |
| 15 | * @property mixed $card |
| 16 | * @property mixed $card_present |
| 17 | * @property string $client_secret |
| 18 | * @property mixed $code_verification |
| 19 | * @property int $created |
| 20 | * @property string $currency |
| 21 | * @property string $customer |
| 22 | * @property mixed $eps |
| 23 | * @property string $flow |
| 24 | * @property mixed $giropay |
| 25 | * @property mixed $ideal |
| 26 | * @property bool $livemode |
| 27 | * @property StripeObject $metadata |
| 28 | * @property mixed $multibanco |
| 29 | * @property mixed $owner |
| 30 | * @property mixed $p24 |
| 31 | * @property mixed $receiver |
| 32 | * @property mixed $redirect |
| 33 | * @property mixed $sepa_debit |
| 34 | * @property mixed $sofort |
| 35 | * @property string $statement_descriptor |
| 36 | * @property string $status |
| 37 | * @property mixed $three_d_secure |
| 38 | * @property string $type |
| 39 | * @property string $usage |
| 40 | * @property mixed $wechat |
| 41 | |
| 42 | * @package Stripe |
| 43 | */ |
| 44 | class Source extends ApiResource |
| 45 | { |
| 46 | const OBJECT_NAME = "source"; |
| 47 | |
| 48 | use ApiOperations\Create; |
| 49 | use ApiOperations\Retrieve; |
| 50 | use ApiOperations\Update; |
| 51 | |
| 52 | /** |
| 53 | * Possible string representations of source flows. |
| 54 | * @link https://stripe.com/docs/api#source_object-flow |
| 55 | */ |
| 56 | const FLOW_REDIRECT = 'redirect'; |
| 57 | const FLOW_RECEIVER = 'receiver'; |
| 58 | const FLOW_CODE_VERIFICATION = 'code_verification'; |
| 59 | const FLOW_NONE = 'none'; |
| 60 | |
| 61 | /** |
| 62 | * Possible string representations of source statuses. |
| 63 | * @link https://stripe.com/docs/api#source_object-status |
| 64 | */ |
| 65 | const STATUS_CANCELED = 'canceled'; |
| 66 | const STATUS_CHARGEABLE = 'chargeable'; |
| 67 | const STATUS_CONSUMED = 'consumed'; |
| 68 | const STATUS_FAILED = 'failed'; |
| 69 | const STATUS_PENDING = 'pending'; |
| 70 | |
| 71 | /** |
| 72 | * Possible string representations of source usage. |
| 73 | * @link https://stripe.com/docs/api#source_object-usage |
| 74 | */ |
| 75 | const USAGE_REUSABLE = 'reusable'; |
| 76 | const USAGE_SINGLE_USE = 'single_use'; |
| 77 | |
| 78 | /** |
| 79 | * @param array|null $params |
| 80 | * @param array|string|null $options |
| 81 | * |
| 82 | * @return Source The detached source. |
| 83 | */ |
| 84 | public function detach($params = null, $options = null) |
| 85 | { |
| 86 | self::_validateParams($params); |
| 87 | |
| 88 | $id = $this['id']; |
| 89 | if (!$id) { |
| 90 | $class = get_class($this); |
| 91 | $msg = "Could not determine which URL to request: $class instance " |
| 92 | . "has invalid ID: $id"; |
| 93 | throw new Error\InvalidRequest($msg, null); |
| 94 | } |
| 95 | |
| 96 | if ($this['customer']) { |
| 97 | $base = Customer::classUrl(); |
| 98 | $parentExtn = urlencode(Util\Util::utf8($this['customer'])); |
| 99 | $extn = urlencode(Util\Util::utf8($id)); |
| 100 | $url = "$base/$parentExtn/sources/$extn"; |
| 101 | |
| 102 | list($response, $opts) = $this->_request('delete', $url, $params, $options); |
| 103 | $this->refreshFrom($response, $opts); |
| 104 | return $this; |
| 105 | } else { |
| 106 | $message = "This source object does not appear to be currently attached " |
| 107 | . "to a customer object."; |
| 108 | throw new Error\Api($message); |
| 109 | } |
| 110 | } |
| 111 | |
| 112 | /** |
| 113 | * @param array|null $params |
| 114 | * @param array|string|null $options |
| 115 | * |
| 116 | * @return Source The detached source. |
| 117 | * |
| 118 | * @deprecated Use the `detach` method instead. |
| 119 | */ |
| 120 | public function delete($params = null, $options = null) |
| 121 | { |
| 122 | $this->detach($params, $options); |
| 123 | } |
| 124 | |
| 125 | /** |
| 126 | * @param array|null $params |
| 127 | * @param array|string|null $options |
| 128 | * |
| 129 | * @return Collection The list of source transactions. |
| 130 | */ |
| 131 | public function sourceTransactions($params = null, $options = null) |
| 132 | { |
| 133 | $url = $this->instanceUrl() . '/source_transactions'; |
| 134 | list($response, $opts) = $this->_request('get', $url, $params, $options); |
| 135 | $obj = Util\Util::convertToStripeObject($response, $opts); |
| 136 | $obj->setLastResponse($response); |
| 137 | return $obj; |
| 138 | } |
| 139 | |
| 140 | /** |
| 141 | * @param array|null $params |
| 142 | * @param array|string|null $options |
| 143 | * |
| 144 | * @return Source The verified source. |
| 145 | */ |
| 146 | public function verify($params = null, $options = null) |
| 147 | { |
| 148 | $url = $this->instanceUrl() . '/verify'; |
| 149 | list($response, $opts) = $this->_request('post', $url, $params, $options); |
| 150 | $this->refreshFrom($response, $opts); |
| 151 | return $this; |
| 152 | } |
| 153 | } |
| 154 |