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

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

128 lines 4.6 KB

Raw Download Zip

1	<?php
2
3	// File generated from our OpenAPI spec
4
5	namespace Stripe\Service;
6
7	class PayoutService extends \Stripe\Service\AbstractService
8	{
9	/**
10	* Returns a list of existing payouts sent to third-party bank accounts or that
11	* Stripe has sent you. The payouts are returned in sorted order, with the most
12	* recently created payouts appearing 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\Payout>
20	*/
21	public function all($params = null, $opts = null)
22	{
23	return $this->requestCollection('get', '/v1/payouts', $params, $opts);
24	}
25
26	/**
27	* A previously created payout can be canceled if it has not yet been paid out.
28	* Funds will be refunded to your available balance. You may not cancel automatic
29	* Stripe payouts.
30	*
31	* @param string $id
32	* @param null\|array $params
33	* @param null\|array\|\Stripe\Util\RequestOptions $opts
34	*
35	* @throws \Stripe\Exception\ApiErrorException if the request fails
36	*
37	* @return \Stripe\Payout
38	*/
39	public function cancel($id, $params = null, $opts = null)
40	{
41	return $this->request('post', $this->buildPath('/v1/payouts/%s/cancel', $id), $params, $opts);
42	}
43
44	/**
45	* To send funds to your own bank account, you create a new payout object. Your <a
46	* href="#balance">Stripe balance</a> must be able to cover the payout amount, or
47	* you’ll receive an “Insufficient Funds” error.
48	*
49	* If your API key is in test mode, money won’t actually be sent, though everything
50	* else will occur as if in live mode.
51	*
52	* If you are creating a manual payout on a Stripe account that uses multiple
53	* payment source types, you’ll need to specify the source type balance that the
54	* payout should draw from. The <a href="#balance_object">balance object</a>
55	* details available and pending amounts by source type.
56	*
57	* @param null\|array $params
58	* @param null\|array\|\Stripe\Util\RequestOptions $opts
59	*
60	* @throws \Stripe\Exception\ApiErrorException if the request fails
61	*
62	* @return \Stripe\Payout
63	*/
64	public function create($params = null, $opts = null)
65	{
66	return $this->request('post', '/v1/payouts', $params, $opts);
67	}
68
69	/**
70	* Retrieves the details of an existing payout. Supply the unique payout ID from
71	* either a payout creation request or the payout list, and Stripe will return the
72	* corresponding payout information.
73	*
74	* @param string $id
75	* @param null\|array $params
76	* @param null\|array\|\Stripe\Util\RequestOptions $opts
77	*
78	* @throws \Stripe\Exception\ApiErrorException if the request fails
79	*
80	* @return \Stripe\Payout
81	*/
82	public function retrieve($id, $params = null, $opts = null)
83	{
84	return $this->request('get', $this->buildPath('/v1/payouts/%s', $id), $params, $opts);
85	}
86
87	/**
88	* Reverses a payout by debiting the destination bank account. Only payouts for
89	* connected accounts to US bank accounts may be reversed at this time. If the
90	* payout is in the <code>pending</code> status,
91	* <code>/v1/payouts/:id/cancel</code> should be used instead.
92	*
93	* By requesting a reversal via <code>/v1/payouts/:id/reverse</code>, you confirm
94	* that the authorized signatory of the selected bank account has authorized the
95	* debit on the bank account and that no other authorization is required.
96	*
97	* @param string $id
98	* @param null\|array $params
99	* @param null\|array\|\Stripe\Util\RequestOptions $opts
100	*
101	* @throws \Stripe\Exception\ApiErrorException if the request fails
102	*
103	* @return \Stripe\Payout
104	*/
105	public function reverse($id, $params = null, $opts = null)
106	{
107	return $this->request('post', $this->buildPath('/v1/payouts/%s/reverse', $id), $params, $opts);
108	}
109
110	/**
111	* Updates the specified payout by setting the values of the parameters passed. Any
112	* parameters not provided will be left unchanged. This request accepts only the
113	* metadata as arguments.
114	*
115	* @param string $id
116	* @param null\|array $params
117	* @param null\|array\|\Stripe\Util\RequestOptions $opts
118	*
119	* @throws \Stripe\Exception\ApiErrorException if the request fails
120	*
121	* @return \Stripe\Payout
122	*/
123	public function update($id, $params = null, $opts = null)
124	{
125	return $this->request('post', $this->buildPath('/v1/payouts/%s', $id), $params, $opts);
126	}
127	}
128