CreditReversal.php
6 months ago
DebitReversal.php
6 months ago
FinancialAccount.php
6 months ago
FinancialAccountFeatures.php
6 months ago
InboundTransfer.php
6 months ago
OutboundPayment.php
6 months ago
OutboundTransfer.php
6 months ago
ReceivedCredit.php
6 months ago
ReceivedDebit.php
6 months ago
Transaction.php
6 months ago
TransactionEntry.php
6 months ago
Transaction.php
80 lines
| 1 | <?php |
| 2 | |
| 3 | // File generated from our OpenAPI spec |
| 4 | |
| 5 | namespace AmeliaVendor\Stripe\Treasury; |
| 6 | |
| 7 | /** |
| 8 | * Transactions represent changes to a <a href="https://stripe.com/docs/api#financial_accounts">FinancialAccount's</a> balance. |
| 9 | * |
| 10 | * @property string $id Unique identifier for the object. |
| 11 | * @property string $object String representing the object's type. Objects of the same type share the same value. |
| 12 | * @property int $amount Amount (in cents) transferred. |
| 13 | * @property (object{cash: int, inbound_pending: int, outbound_pending: int}&\AmeliaVendor\Stripe\StripeObject) $balance_impact Change to a FinancialAccount's balance |
| 14 | * @property int $created Time at which the object was created. Measured in seconds since the Unix epoch. |
| 15 | * @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>. |
| 16 | * @property string $description An arbitrary string attached to the object. Often useful for displaying to users. |
| 17 | * @property null|\AmeliaVendor\Stripe\Collection<TransactionEntry> $entries A list of TransactionEntries that are part of this Transaction. This cannot be expanded in any list endpoints. |
| 18 | * @property string $financial_account The FinancialAccount associated with this object. |
| 19 | * @property null|string $flow ID of the flow that created the Transaction. |
| 20 | * @property null|(object{credit_reversal?: CreditReversal, debit_reversal?: DebitReversal, inbound_transfer?: InboundTransfer, issuing_authorization?: \AmeliaVendor\Stripe\Issuing\Authorization, outbound_payment?: OutboundPayment, outbound_transfer?: OutboundTransfer, received_credit?: ReceivedCredit, received_debit?: ReceivedDebit, type: string}&\AmeliaVendor\Stripe\StripeObject) $flow_details Details of the flow that created the Transaction. |
| 21 | * @property string $flow_type Type of the flow that created the Transaction. |
| 22 | * @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. |
| 23 | * @property string $status Status of the Transaction. |
| 24 | * @property (object{posted_at: null|int, void_at: null|int}&\AmeliaVendor\Stripe\StripeObject) $status_transitions |
| 25 | */ |
| 26 | class Transaction extends \AmeliaVendor\Stripe\ApiResource |
| 27 | { |
| 28 | const OBJECT_NAME = 'treasury.transaction'; |
| 29 | |
| 30 | const FLOW_TYPE_CREDIT_REVERSAL = 'credit_reversal'; |
| 31 | const FLOW_TYPE_DEBIT_REVERSAL = 'debit_reversal'; |
| 32 | const FLOW_TYPE_INBOUND_TRANSFER = 'inbound_transfer'; |
| 33 | const FLOW_TYPE_ISSUING_AUTHORIZATION = 'issuing_authorization'; |
| 34 | const FLOW_TYPE_OTHER = 'other'; |
| 35 | const FLOW_TYPE_OUTBOUND_PAYMENT = 'outbound_payment'; |
| 36 | const FLOW_TYPE_OUTBOUND_TRANSFER = 'outbound_transfer'; |
| 37 | const FLOW_TYPE_RECEIVED_CREDIT = 'received_credit'; |
| 38 | const FLOW_TYPE_RECEIVED_DEBIT = 'received_debit'; |
| 39 | |
| 40 | const STATUS_OPEN = 'open'; |
| 41 | const STATUS_POSTED = 'posted'; |
| 42 | const STATUS_VOID = 'void'; |
| 43 | |
| 44 | /** |
| 45 | * Retrieves a list of Transaction objects. |
| 46 | * |
| 47 | * @param null|array{created?: array|int, ending_before?: string, expand?: string[], financial_account: string, limit?: int, order_by?: string, starting_after?: string, status?: string, status_transitions?: array{posted_at?: array|int}} $params |
| 48 | * @param null|array|string $opts |
| 49 | * |
| 50 | * @return \AmeliaVendor\Stripe\Collection<Transaction> of ApiResources |
| 51 | * |
| 52 | * @throws \AmeliaVendor\Stripe\Exception\ApiErrorException if the request fails |
| 53 | */ |
| 54 | public static function all($params = null, $opts = null) |
| 55 | { |
| 56 | $url = static::classUrl(); |
| 57 | |
| 58 | return static::_requestPage($url, \AmeliaVendor\Stripe\Collection::class, $params, $opts); |
| 59 | } |
| 60 | |
| 61 | /** |
| 62 | * Retrieves the details of an existing Transaction. |
| 63 | * |
| 64 | * @param array|string $id the ID of the API resource to retrieve, or an options array containing an `id` key |
| 65 | * @param null|array|string $opts |
| 66 | * |
| 67 | * @return Transaction |
| 68 | * |
| 69 | * @throws \AmeliaVendor\Stripe\Exception\ApiErrorException if the request fails |
| 70 | */ |
| 71 | public static function retrieve($id, $opts = null) |
| 72 | { |
| 73 | $opts = \AmeliaVendor\Stripe\Util\RequestOptions::parse($opts); |
| 74 | $instance = new static($id, $opts); |
| 75 | $instance->refresh(); |
| 76 | |
| 77 | return $instance; |
| 78 | } |
| 79 | } |
| 80 |