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

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

46 lines 2.3 KB

Raw Download Zip

1	<?php
2
3	// File generated from our OpenAPI spec
4
5	namespace Stripe;
6
7	/**
8	* This is an object representing your Stripe balance. You can retrieve it to see
9	* the balance currently on your Stripe account.
10	*
11	* You can also retrieve the balance history, which contains a list of <a
12	* href="https://stripe.com/docs/reporting/balance-transaction-types">transactions</a>
13	* that contributed to the balance (charges, payouts, and so forth).
14	*
15	* The available and pending amounts for each currency are broken down further by
16	* payment source types.
17	*
18	* Related guide: <a
19	* href="https://stripe.com/docs/connect/account-balances">Understanding Connect
20	* Account Balances</a>.
21	*
22	* @property string $object String representing the object's type. Objects of the same type share the same value.
23	* @property \Stripe\StripeObject[] $available Funds that are available to be transferred or paid out, whether automatically by Stripe or explicitly via the <a href="https://stripe.com/docs/api#transfers">Transfers API</a> or <a href="https://stripe.com/docs/api#payouts">Payouts API</a>. The available balance for each currency and payment type can be found in the <code>source_types</code> property.
24	* @property \Stripe\StripeObject[] $connect_reserved Funds held due to negative balances on connected Custom accounts. The connect reserve balance for each currency and payment type can be found in the <code>source_types</code> property.
25	* @property \Stripe\StripeObject[] $instant_available Funds that can be paid out using Instant Payouts.
26	* @property \Stripe\StripeObject $issuing
27	* @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.
28	* @property \Stripe\StripeObject[] $pending Funds that are not yet available in the balance, due to the 7-day rolling pay cycle. The pending balance for each currency, and for each payment type, can be found in the <code>source_types</code> property.
29	*/
30	class Balance extends SingletonApiResource
31	{
32	const OBJECT_NAME = 'balance';
33
34	/**
35	* @param null\|array\|string $opts
36	*
37	* @throws \Stripe\Exception\ApiErrorException if the request fails
38	*
39	* @return \Stripe\Balance
40	*/
41	public static function retrieve($opts = null)
42	{
43	return self::_singletonRetrieve($opts);
44	}
45	}
46