Authorization.php
2 months ago
Card.php
2 months ago
CardDetails.php
2 months ago
Cardholder.php
2 months ago
Dispute.php
2 months ago
PersonalizationDesign.php
2 months ago
PhysicalBundle.php
2 months ago
Token.php
2 months ago
Transaction.php
2 months ago
Transaction.php
102 lines
| 1 | <?php |
| 2 | |
| 3 | // File generated from our OpenAPI spec |
| 4 | namespace ProfilePressVendor\Stripe\Issuing; |
| 5 | |
| 6 | /** |
| 7 | * Any use of an <a href="https://stripe.com/docs/issuing">issued card</a> that results in funds entering or leaving |
| 8 | * your Stripe account, such as a completed purchase or refund, is represented by an Issuing |
| 9 | * <code>Transaction</code> object. |
| 10 | * |
| 11 | * Related guide: <a href="https://stripe.com/docs/issuing/purchases/transactions">Issued card transactions</a> |
| 12 | * |
| 13 | * @property string $id Unique identifier for the object. |
| 14 | * @property string $object String representing the object's type. Objects of the same type share the same value. |
| 15 | * @property int $amount The transaction amount, which will be reflected in your balance. This amount is in your currency and in the <a href="https://stripe.com/docs/currencies#zero-decimal">smallest currency unit</a>. |
| 16 | * @property null|\Stripe\StripeObject $amount_details Detailed breakdown of amount components. These amounts are denominated in <code>currency</code> and in the <a href="https://stripe.com/docs/currencies#zero-decimal">smallest currency unit</a>. |
| 17 | * @property null|string|\Stripe\Issuing\Authorization $authorization The <code>Authorization</code> object that led to this transaction. |
| 18 | * @property null|string|\Stripe\BalanceTransaction $balance_transaction ID of the <a href="https://stripe.com/docs/api/balance_transactions">balance transaction</a> associated with this transaction. |
| 19 | * @property string|\Stripe\Issuing\Card $card The card used to make this transaction. |
| 20 | * @property null|string|\Stripe\Issuing\Cardholder $cardholder The cardholder to whom this transaction belongs. |
| 21 | * @property int $created Time at which the object was created. Measured in seconds since the Unix epoch. |
| 22 | * @property string $currency Three-letter <a href="https://www.iso.org/iso-4217-currency-codes.html">ISO currency code</a>, in lowercase. Must be a <a href="https://stripe.com/docs/currencies">supported currency</a>. |
| 23 | * @property null|string|\Stripe\Issuing\Dispute $dispute If you've disputed the transaction, the ID of the dispute. |
| 24 | * @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. |
| 25 | * @property int $merchant_amount The amount that the merchant will receive, denominated in <code>merchant_currency</code> and in the <a href="https://stripe.com/docs/currencies#zero-decimal">smallest currency unit</a>. It will be different from <code>amount</code> if the merchant is taking payment in a different currency. |
| 26 | * @property string $merchant_currency The currency with which the merchant is taking payment. |
| 27 | * @property \Stripe\StripeObject $merchant_data |
| 28 | * @property \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. |
| 29 | * @property null|\Stripe\StripeObject $network_data Details about the transaction, such as processing dates, set by the card network. |
| 30 | * @property null|\Stripe\StripeObject $purchase_details Additional purchase information that is optionally provided by the merchant. |
| 31 | * @property null|string|\Stripe\Issuing\Token $token <a href="https://stripe.com/docs/api/issuing/tokens/object">Token</a> object used for this transaction. If a network token was not used for this transaction, this field will be null. |
| 32 | * @property null|\Stripe\StripeObject $treasury <a href="https://stripe.com/docs/api/treasury">Treasury</a> details related to this transaction if it was created on a [FinancialAccount](/docs/api/treasury/financial_accounts |
| 33 | * @property string $type The nature of the transaction. |
| 34 | * @property null|string $wallet The digital wallet used for this transaction. One of <code>apple_pay</code>, <code>google_pay</code>, or <code>samsung_pay</code>. |
| 35 | */ |
| 36 | class Transaction extends \ProfilePressVendor\Stripe\ApiResource |
| 37 | { |
| 38 | const OBJECT_NAME = 'issuing.transaction'; |
| 39 | use \ProfilePressVendor\Stripe\ApiOperations\Update; |
| 40 | const TYPE_CAPTURE = 'capture'; |
| 41 | const TYPE_REFUND = 'refund'; |
| 42 | const WALLET_APPLE_PAY = 'apple_pay'; |
| 43 | const WALLET_GOOGLE_PAY = 'google_pay'; |
| 44 | const WALLET_SAMSUNG_PAY = 'samsung_pay'; |
| 45 | /** |
| 46 | * Returns a list of Issuing <code>Transaction</code> objects. The objects are |
| 47 | * sorted in descending order by creation date, with the most recently created |
| 48 | * object appearing first. |
| 49 | * |
| 50 | * @param null|array $params |
| 51 | * @param null|array|string $opts |
| 52 | * |
| 53 | * @throws \Stripe\Exception\ApiErrorException if the request fails |
| 54 | * |
| 55 | * @return \Stripe\Collection<\Stripe\Issuing\Transaction> of ApiResources |
| 56 | */ |
| 57 | public static function all($params = null, $opts = null) |
| 58 | { |
| 59 | $url = static::classUrl(); |
| 60 | return static::_requestPage($url, \ProfilePressVendor\Stripe\Collection::class, $params, $opts); |
| 61 | } |
| 62 | /** |
| 63 | * Retrieves an Issuing <code>Transaction</code> object. |
| 64 | * |
| 65 | * @param array|string $id the ID of the API resource to retrieve, or an options array containing an `id` key |
| 66 | * @param null|array|string $opts |
| 67 | * |
| 68 | * @throws \Stripe\Exception\ApiErrorException if the request fails |
| 69 | * |
| 70 | * @return \Stripe\Issuing\Transaction |
| 71 | */ |
| 72 | public static function retrieve($id, $opts = null) |
| 73 | { |
| 74 | $opts = \ProfilePressVendor\Stripe\Util\RequestOptions::parse($opts); |
| 75 | $instance = new static($id, $opts); |
| 76 | $instance->refresh(); |
| 77 | return $instance; |
| 78 | } |
| 79 | /** |
| 80 | * Updates the specified Issuing <code>Transaction</code> object by setting the |
| 81 | * values of the parameters passed. Any parameters not provided will be left |
| 82 | * unchanged. |
| 83 | * |
| 84 | * @param string $id the ID of the resource to update |
| 85 | * @param null|array $params |
| 86 | * @param null|array|string $opts |
| 87 | * |
| 88 | * @throws \Stripe\Exception\ApiErrorException if the request fails |
| 89 | * |
| 90 | * @return \Stripe\Issuing\Transaction the updated resource |
| 91 | */ |
| 92 | public static function update($id, $params = null, $opts = null) |
| 93 | { |
| 94 | self::_validateParams($params); |
| 95 | $url = static::resourceUrl($id); |
| 96 | list($response, $opts) = static::_staticRequest('post', $url, $params, $opts); |
| 97 | $obj = \ProfilePressVendor\Stripe\Util\Util::convertToStripeObject($response->json, $opts); |
| 98 | $obj->setLastResponse($response); |
| 99 | return $obj; |
| 100 | } |
| 101 | } |
| 102 |