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

BalanceTransaction.php in GiveWP – Donation Plugin and Fundraising Platform 4.15.4, at vendor/stripe/stripe-php/lib/BalanceTransaction.php

72 lines 5.5 KB

Raw Download Zip

1	<?php
2
3	// File generated from our OpenAPI spec
4
5	namespace Stripe;
6
7	/**
8	* Balance transactions represent funds moving through your Stripe account. They're
9	* created for every type of transaction that comes into or flows out of your
10	* Stripe account balance.
11	*
12	* Related guide: <a
13	* href="https://stripe.com/docs/reports/balance-transaction-types">Balance
14	* Transaction Types</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 int $amount Gross amount of the transaction, in %s.
19	* @property int $available_on The date the transaction's net funds will become available in the Stripe balance.
20	* @property int $created Time at which the object was created. Measured in seconds since the Unix epoch.
21	* @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>.
22	* @property null\|string $description An arbitrary string attached to the object. Often useful for displaying to users.
23	* @property null\|float $exchange_rate The exchange rate used, if applicable, for this transaction. Specifically, if money was converted from currency A to currency B, then the <code>amount</code> in currency A, times <code>exchange_rate</code>, would be the <code>amount</code> in currency B. For example, suppose you charged a customer 10.00 EUR. Then the PaymentIntent's <code>amount</code> would be <code>1000</code> and <code>currency</code> would be <code>eur</code>. Suppose this was converted into 12.34 USD in your Stripe account. Then the BalanceTransaction's <code>amount</code> would be <code>1234</code>, <code>currency</code> would be <code>usd</code>, and <code>exchange_rate</code> would be <code>1.234</code>.
24	* @property int $fee Fees (in %s) paid for this transaction.
25	* @property \Stripe\StripeObject[] $fee_details Detailed breakdown of fees (in %s) paid for this transaction.
26	* @property int $net Net amount of the transaction, in %s.
27	* @property string $reporting_category <a href="https://stripe.com/docs/reports/reporting-categories">Learn more</a> about how reporting categories can help you understand balance transactions from an accounting perspective.
28	* @property null\|string\|\Stripe\StripeObject $source The Stripe object to which this transaction is related.
29	* @property string $status If the transaction's net funds are available in the Stripe balance yet. Either <code>available</code> or <code>pending</code>.
30	* @property string $type Transaction type: <code>adjustment</code>, <code>advance</code>, <code>advance_funding</code>, <code>anticipation_repayment</code>, <code>application_fee</code>, <code>application_fee_refund</code>, <code>charge</code>, <code>connect_collection_transfer</code>, <code>contribution</code>, <code>issuing_authorization_hold</code>, <code>issuing_authorization_release</code>, <code>issuing_dispute</code>, <code>issuing_transaction</code>, <code>payment</code>, <code>payment_failure_refund</code>, <code>payment_refund</code>, <code>payout</code>, <code>payout_cancel</code>, <code>payout_failure</code>, <code>refund</code>, <code>refund_failure</code>, <code>reserve_transaction</code>, <code>reserved_funds</code>, <code>stripe_fee</code>, <code>stripe_fx_fee</code>, <code>tax_fee</code>, <code>topup</code>, <code>topup_reversal</code>, <code>transfer</code>, <code>transfer_cancel</code>, <code>transfer_failure</code>, or <code>transfer_refund</code>. <a href="https://stripe.com/docs/reports/balance-transaction-types">Learn more</a> about balance transaction types and what they represent. If you are looking to classify transactions for accounting purposes, you might want to consider <code>reporting_category</code> instead.
31	*/
32	class BalanceTransaction extends ApiResource
33	{
34	const OBJECT_NAME = 'balance_transaction';
35
36	use ApiOperations\All;
37	use ApiOperations\Retrieve;
38
39	const TYPE_ADJUSTMENT = 'adjustment';
40	const TYPE_ADVANCE = 'advance';
41	const TYPE_ADVANCE_FUNDING = 'advance_funding';
42	const TYPE_ANTICIPATION_REPAYMENT = 'anticipation_repayment';
43	const TYPE_APPLICATION_FEE = 'application_fee';
44	const TYPE_APPLICATION_FEE_REFUND = 'application_fee_refund';
45	const TYPE_CHARGE = 'charge';
46	const TYPE_CONNECT_COLLECTION_TRANSFER = 'connect_collection_transfer';
47	const TYPE_CONTRIBUTION = 'contribution';
48	const TYPE_ISSUING_AUTHORIZATION_HOLD = 'issuing_authorization_hold';
49	const TYPE_ISSUING_AUTHORIZATION_RELEASE = 'issuing_authorization_release';
50	const TYPE_ISSUING_DISPUTE = 'issuing_dispute';
51	const TYPE_ISSUING_TRANSACTION = 'issuing_transaction';
52	const TYPE_PAYMENT = 'payment';
53	const TYPE_PAYMENT_FAILURE_REFUND = 'payment_failure_refund';
54	const TYPE_PAYMENT_REFUND = 'payment_refund';
55	const TYPE_PAYOUT = 'payout';
56	const TYPE_PAYOUT_CANCEL = 'payout_cancel';
57	const TYPE_PAYOUT_FAILURE = 'payout_failure';
58	const TYPE_REFUND = 'refund';
59	const TYPE_REFUND_FAILURE = 'refund_failure';
60	const TYPE_RESERVE_TRANSACTION = 'reserve_transaction';
61	const TYPE_RESERVED_FUNDS = 'reserved_funds';
62	const TYPE_STRIPE_FEE = 'stripe_fee';
63	const TYPE_STRIPE_FX_FEE = 'stripe_fx_fee';
64	const TYPE_TAX_FEE = 'tax_fee';
65	const TYPE_TOPUP = 'topup';
66	const TYPE_TOPUP_REVERSAL = 'topup_reversal';
67	const TYPE_TRANSFER = 'transfer';
68	const TYPE_TRANSFER_CANCEL = 'transfer_cancel';
69	const TYPE_TRANSFER_FAILURE = 'transfer_failure';
70	const TYPE_TRANSFER_REFUND = 'transfer_refund';
71	}
72