BalanceTransactionService.php 1.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051
  1. <?php
  2. // File generated from our OpenAPI spec
  3. namespace Stripe\Service;
  4. /**
  5. * @phpstan-import-type RequestOptionsArray from \Stripe\Util\RequestOptions
  6. * @psalm-import-type RequestOptionsArray from \Stripe\Util\RequestOptions
  7. */
  8. class BalanceTransactionService extends \Stripe\Service\AbstractService
  9. {
  10. /**
  11. * Returns a list of transactions that have contributed to the Stripe account
  12. * balance (e.g., charges, transfers, and so forth). The transactions are returned
  13. * in sorted order, with the most recent transactions appearing first.
  14. *
  15. * Note that this endpoint was previously called “Balance history” and used the
  16. * path <code>/v1/balance/history</code>.
  17. *
  18. * @param null|array $params
  19. * @param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts
  20. *
  21. * @throws \Stripe\Exception\ApiErrorException if the request fails
  22. *
  23. * @return \Stripe\Collection<\Stripe\BalanceTransaction>
  24. */
  25. public function all($params = null, $opts = null)
  26. {
  27. return $this->requestCollection('get', '/v1/balance_transactions', $params, $opts);
  28. }
  29. /**
  30. * Retrieves the balance transaction with the given ID.
  31. *
  32. * Note that this endpoint previously used the path
  33. * <code>/v1/balance/history/:id</code>.
  34. *
  35. * @param string $id
  36. * @param null|array $params
  37. * @param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts
  38. *
  39. * @throws \Stripe\Exception\ApiErrorException if the request fails
  40. *
  41. * @return \Stripe\BalanceTransaction
  42. */
  43. public function retrieve($id, $params = null, $opts = null)
  44. {
  45. return $this->request('get', $this->buildPath('/v1/balance_transactions/%s', $id), $params, $opts);
  46. }
  47. }