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

TransferService.php in GiveWP – Donation Plugin and Fundraising Platform 4.15.5, at vendor/stripe/stripe-php/lib/Service/TransferService.php

176 lines 6.2 KB

Raw Download Zip

1	<?php
2
3	// File generated from our OpenAPI spec
4
5	namespace Stripe\Service;
6
7	class TransferService extends \Stripe\Service\AbstractService
8	{
9	/**
10	* Returns a list of existing transfers sent to connected accounts. The transfers
11	* are returned in sorted order, with the most recently created transfers appearing
12	* first.
13	*
14	* @param null\|array $params
15	* @param null\|array\|\Stripe\Util\RequestOptions $opts
16	*
17	* @throws \Stripe\Exception\ApiErrorException if the request fails
18	*
19	* @return \Stripe\Collection<\Stripe\Transfer>
20	*/
21	public function all($params = null, $opts = null)
22	{
23	return $this->requestCollection('get', '/v1/transfers', $params, $opts);
24	}
25
26	/**
27	* You can see a list of the reversals belonging to a specific transfer. Note that
28	* the 10 most recent reversals are always available by default on the transfer
29	* object. If you need more than those 10, you can use this API method and the
30	* <code>limit</code> and <code>starting_after</code> parameters to page through
31	* additional reversals.
32	*
33	* @param string $parentId
34	* @param null\|array $params
35	* @param null\|array\|\Stripe\Util\RequestOptions $opts
36	*
37	* @throws \Stripe\Exception\ApiErrorException if the request fails
38	*
39	* @return \Stripe\Collection<\Stripe\TransferReversal>
40	*/
41	public function allReversals($parentId, $params = null, $opts = null)
42	{
43	return $this->requestCollection('get', $this->buildPath('/v1/transfers/%s/reversals', $parentId), $params, $opts);
44	}
45
46	/**
47	* @param string $id
48	* @param null\|array $params
49	* @param null\|array\|\Stripe\Util\RequestOptions $opts
50	*
51	* @throws \Stripe\Exception\ApiErrorException if the request fails
52	*
53	* @return \Stripe\Transfer
54	*/
55	public function cancel($id, $params = null, $opts = null)
56	{
57	return $this->request('post', $this->buildPath('/v1/transfers/%s/cancel', $id), $params, $opts);
58	}
59
60	/**
61	* To send funds from your Stripe account to a connected account, you create a new
62	* transfer object. Your <a href="#balance">Stripe balance</a> must be able to
63	* cover the transfer amount, or you’ll receive an “Insufficient Funds” error.
64	*
65	* @param null\|array $params
66	* @param null\|array\|\Stripe\Util\RequestOptions $opts
67	*
68	* @throws \Stripe\Exception\ApiErrorException if the request fails
69	*
70	* @return \Stripe\Transfer
71	*/
72	public function create($params = null, $opts = null)
73	{
74	return $this->request('post', '/v1/transfers', $params, $opts);
75	}
76
77	/**
78	* When you create a new reversal, you must specify a transfer to create it on.
79	*
80	* When reversing transfers, you can optionally reverse part of the transfer. You
81	* can do so as many times as you wish until the entire transfer has been reversed.
82	*
83	* Once entirely reversed, a transfer can’t be reversed again. This method will
84	* return an error when called on an already-reversed transfer, or when trying to
85	* reverse more money than is left on a transfer.
86	*
87	* @param string $parentId
88	* @param null\|array $params
89	* @param null\|array\|\Stripe\Util\RequestOptions $opts
90	*
91	* @throws \Stripe\Exception\ApiErrorException if the request fails
92	*
93	* @return \Stripe\TransferReversal
94	*/
95	public function createReversal($parentId, $params = null, $opts = null)
96	{
97	return $this->request('post', $this->buildPath('/v1/transfers/%s/reversals', $parentId), $params, $opts);
98	}
99
100	/**
101	* Retrieves the details of an existing transfer. Supply the unique transfer ID
102	* from either a transfer creation request or the transfer list, and Stripe will
103	* return the corresponding transfer information.
104	*
105	* @param string $id
106	* @param null\|array $params
107	* @param null\|array\|\Stripe\Util\RequestOptions $opts
108	*
109	* @throws \Stripe\Exception\ApiErrorException if the request fails
110	*
111	* @return \Stripe\Transfer
112	*/
113	public function retrieve($id, $params = null, $opts = null)
114	{
115	return $this->request('get', $this->buildPath('/v1/transfers/%s', $id), $params, $opts);
116	}
117
118	/**
119	* By default, you can see the 10 most recent reversals stored directly on the
120	* transfer object, but you can also retrieve details about a specific reversal
121	* stored on the transfer.
122	*
123	* @param string $parentId
124	* @param string $id
125	* @param null\|array $params
126	* @param null\|array\|\Stripe\Util\RequestOptions $opts
127	*
128	* @throws \Stripe\Exception\ApiErrorException if the request fails
129	*
130	* @return \Stripe\TransferReversal
131	*/
132	public function retrieveReversal($parentId, $id, $params = null, $opts = null)
133	{
134	return $this->request('get', $this->buildPath('/v1/transfers/%s/reversals/%s', $parentId, $id), $params, $opts);
135	}
136
137	/**
138	* Updates the specified transfer by setting the values of the parameters passed.
139	* Any parameters not provided will be left unchanged.
140	*
141	* This request accepts only metadata as an argument.
142	*
143	* @param string $id
144	* @param null\|array $params
145	* @param null\|array\|\Stripe\Util\RequestOptions $opts
146	*
147	* @throws \Stripe\Exception\ApiErrorException if the request fails
148	*
149	* @return \Stripe\Transfer
150	*/
151	public function update($id, $params = null, $opts = null)
152	{
153	return $this->request('post', $this->buildPath('/v1/transfers/%s', $id), $params, $opts);
154	}
155
156	/**
157	* Updates the specified reversal by setting the values of the parameters passed.
158	* Any parameters not provided will be left unchanged.
159	*
160	* This request only accepts metadata and description as arguments.
161	*
162	* @param string $parentId
163	* @param string $id
164	* @param null\|array $params
165	* @param null\|array\|\Stripe\Util\RequestOptions $opts
166	*
167	* @throws \Stripe\Exception\ApiErrorException if the request fails
168	*
169	* @return \Stripe\TransferReversal
170	*/
171	public function updateReversal($parentId, $id, $params = null, $opts = null)
172	{
173	return $this->request('post', $this->buildPath('/v1/transfers/%s/reversals/%s', $parentId, $id), $params, $opts);
174	}
175	}
176