| 12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879 |
- <?php
- // File generated from our OpenAPI spec
- namespace Stripe\Treasury;
- /**
- * Transactions represent changes to a <a href="https://stripe.com/docs/api#financial_accounts">FinancialAccount's</a> balance.
- *
- * @property string $id Unique identifier for the object.
- * @property string $object String representing the object's type. Objects of the same type share the same value.
- * @property int $amount Amount (in cents) transferred.
- * @property \Stripe\StripeObject $balance_impact Change to a FinancialAccount's balance
- * @property int $created Time at which the object was created. Measured in seconds since the Unix epoch.
- * @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>.
- * @property string $description An arbitrary string attached to the object. Often useful for displaying to users.
- * @property null|\Stripe\Collection<\Stripe\Treasury\TransactionEntry> $entries A list of TransactionEntries that are part of this Transaction. This cannot be expanded in any list endpoints.
- * @property string $financial_account The FinancialAccount associated with this object.
- * @property null|string $flow ID of the flow that created the Transaction.
- * @property null|\Stripe\StripeObject $flow_details Details of the flow that created the Transaction.
- * @property string $flow_type Type of the flow that created the Transaction.
- * @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.
- * @property string $status Status of the Transaction.
- * @property \Stripe\StripeObject $status_transitions
- */
- class Transaction extends \Stripe\ApiResource
- {
- const OBJECT_NAME = 'treasury.transaction';
- const FLOW_TYPE_CREDIT_REVERSAL = 'credit_reversal';
- const FLOW_TYPE_DEBIT_REVERSAL = 'debit_reversal';
- const FLOW_TYPE_INBOUND_TRANSFER = 'inbound_transfer';
- const FLOW_TYPE_ISSUING_AUTHORIZATION = 'issuing_authorization';
- const FLOW_TYPE_OTHER = 'other';
- const FLOW_TYPE_OUTBOUND_PAYMENT = 'outbound_payment';
- const FLOW_TYPE_OUTBOUND_TRANSFER = 'outbound_transfer';
- const FLOW_TYPE_RECEIVED_CREDIT = 'received_credit';
- const FLOW_TYPE_RECEIVED_DEBIT = 'received_debit';
- const STATUS_OPEN = 'open';
- const STATUS_POSTED = 'posted';
- const STATUS_VOID = 'void';
- /**
- * Retrieves a list of Transaction objects.
- *
- * @param null|array $params
- * @param null|array|string $opts
- *
- * @throws \Stripe\Exception\ApiErrorException if the request fails
- *
- * @return \Stripe\Collection<\Stripe\Treasury\Transaction> of ApiResources
- */
- public static function all($params = null, $opts = null)
- {
- $url = static::classUrl();
- return static::_requestPage($url, \Stripe\Collection::class, $params, $opts);
- }
- /**
- * Retrieves the details of an existing Transaction.
- *
- * @param array|string $id the ID of the API resource to retrieve, or an options array containing an `id` key
- * @param null|array|string $opts
- *
- * @throws \Stripe\Exception\ApiErrorException if the request fails
- *
- * @return \Stripe\Treasury\Transaction
- */
- public static function retrieve($id, $opts = null)
- {
- $opts = \Stripe\Util\RequestOptions::parse($opts);
- $instance = new static($id, $opts);
- $instance->refresh();
- return $instance;
- }
- }
|