Balance.php 2.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445
  1. <?php
  2. // File generated from our OpenAPI spec
  3. namespace Stripe;
  4. /**
  5. * This is an object representing your Stripe balance. You can retrieve it to see
  6. * the balance currently on your Stripe account.
  7. *
  8. * You can also retrieve the balance history, which contains a list of <a
  9. * href="https://stripe.com/docs/reporting/balance-transaction-types">transactions</a>
  10. * that contributed to the balance (charges, payouts, and so forth).
  11. *
  12. * The available and pending amounts for each currency are broken down further by
  13. * payment source types.
  14. *
  15. * Related guide: <a
  16. * href="https://stripe.com/docs/connect/account-balances">Understanding Connect
  17. * 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 \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.
  21. * @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.
  22. * @property \Stripe\StripeObject[] $instant_available Funds that can be paid out using Instant Payouts.
  23. * @property \Stripe\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 \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.
  26. */
  27. class Balance extends SingletonApiResource
  28. {
  29. const OBJECT_NAME = 'balance';
  30. /**
  31. * @param null|array|string $opts
  32. *
  33. * @throws \Stripe\Exception\ApiErrorException if the request fails
  34. *
  35. * @return \Stripe\Balance
  36. */
  37. public static function retrieve($opts = null)
  38. {
  39. return self::_singletonRetrieve($opts);
  40. }
  41. }