Balance.php — Booking for Appointments and Events Calendar – Amelia 2.4.4

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

ameliabooking / vendor / stripe / stripe-php / lib Last commit date

Balance.php

49 lines

1	<?php
2
3	// File generated from our OpenAPI spec
4	namespace AmeliaVendor\Stripe;
5
6	/**
7	* This is an object representing your Stripe balance. You can retrieve it to see
8	* the balance currently on your Stripe account.
9	*
10	* You can also retrieve the balance history, which contains a list of
11	* <a href="https://stripe.com/docs/reporting/balance-transaction-types">transactions</a> that contributed to the balance
12	* (charges, payouts, and so forth).
13	*
14	* The available and pending amounts for each currency are broken down further by
15	* payment source types.
16	*
17	* Related guide: <a href="https://stripe.com/docs/connect/account-balances">Understanding Connect account balances</a>
18	*
19	* @property string $object String representing the object's type. Objects of the same type share the same value.
20	* @property (object{amount: int, currency: string, source_types?: (object{bank_account?: int, card?: int, fpx?: int}&StripeObject)}&StripeObject)[] $available Available funds that you can transfer or pay out automatically by Stripe or explicitly through the <a href="https://stripe.com/docs/api#transfers">Transfers API</a> or <a href="https://stripe.com/docs/api#payouts">Payouts API</a>. You can find the available balance for each currency and payment type in the <code>source_types</code> property.
21	* @property null\|(object{amount: int, currency: string, source_types?: (object{bank_account?: int, card?: int, fpx?: int}&StripeObject)}&StripeObject)[] $connect_reserved Funds held due to negative balances on connected accounts where <a href="/api/accounts/object#account_object-controller-requirement_collection">account.controller.requirement_collection</a> is <code>application</code>, which includes Custom accounts. You can find the connect reserve balance for each currency and payment type in the <code>source_types</code> property.
22	* @property null\|(object{amount: int, currency: string, net_available?: (object{amount: int, destination: string, source_types?: (object{bank_account?: int, card?: int, fpx?: int}&StripeObject)}&StripeObject)[], source_types?: (object{bank_account?: int, card?: int, fpx?: int}&StripeObject)}&StripeObject)[] $instant_available Funds that you can pay out using Instant Payouts.
23	* @property null\|(object{available: (object{amount: int, currency: string, source_types?: (object{bank_account?: int, card?: int, fpx?: int}&StripeObject)}&StripeObject)[]}&StripeObject) $issuing
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 (object{amount: int, currency: string, source_types?: (object{bank_account?: int, card?: int, fpx?: int}&StripeObject)}&StripeObject)[] $pending Funds that aren't available in the balance yet. You can find the pending balance for each currency and each payment type in the <code>source_types</code> property.
26	*/
27	class Balance extends SingletonApiResource
28	{
29	const OBJECT_NAME = 'balance';
30	/**
31	* Retrieves the current account balance, based on the authentication that was used
32	* to make the request. For a sample request, see <a
33	* href="/docs/connect/account-balances#accounting-for-negative-balances">Accounting
34	* for negative balances</a>.
35	*
36	* @param null\|array\|string $opts
37	*
38	* @return Balance
39	*
40	* @throws Exception\ApiErrorException if the request fails
41	*/
42	public static function retrieve($opts = null)
43	{
44	$opts = \AmeliaVendor\Stripe\Util\RequestOptions::parse($opts);
45	$instance = new static(null, $opts);
46	$instance->refresh();
47	return $instance;
48	}
49	}