BalanceTransactionService.php — GiveWP – Donation Plugin and Fundraising Platform 4.16.3

give / vendor / stripe / stripe-php / lib / Service / BalanceTransactionService.php

give / vendor / stripe / stripe-php / lib / Service Last commit date

BalanceTransactionService.php

48 lines

1	<?php
2
3	// File generated from our OpenAPI spec
4
5	namespace Stripe\Service;
6
7	class BalanceTransactionService extends \Stripe\Service\AbstractService
8	{
9	/**
10	* Returns a list of transactions that have contributed to the Stripe account
11	* balance (e.g., charges, transfers, and so forth). The transactions are returned
12	* in sorted order, with the most recent transactions appearing first.
13	*
14	* Note that this endpoint was previously called “Balance history” and used the
15	* path <code>/v1/balance/history</code>.
16	*
17	* @param null\|array $params
18	* @param null\|array\|\Stripe\Util\RequestOptions $opts
19	*
20	* @throws \Stripe\Exception\ApiErrorException if the request fails
21	*
22	* @return \Stripe\Collection<\Stripe\BalanceTransaction>
23	*/
24	public function all($params = null, $opts = null)
25	{
26	return $this->requestCollection('get', '/v1/balance_transactions', $params, $opts);
27	}
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\|array\|\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	}
48