charitable / vendor / stripe / stripe-php / lib / Service / Treasury / InboundTransferService.php

InboundTransferService.php in Charitable – Donation & Fundraising Platform (Donation Forms, Recurring Donations & Fundraising Campaigns) 1.8.13, at vendor/stripe/stripe-php/lib/Service/Treasury/InboundTransferService.php

71 lines 2.1 KB

Raw Download Zip

1	<?php
2
3	// File generated from our OpenAPI spec
4
5	namespace Stripe\Service\Treasury;
6
7	class InboundTransferService extends \Stripe\Service\AbstractService
8	{
9	/**
10	* Returns a list of InboundTransfers sent from the specified FinancialAccount.
11	*
12	* @param null\|array $params
13	* @param null\|array\|\Stripe\Util\RequestOptions $opts
14	*
15	* @throws \Stripe\Exception\ApiErrorException if the request fails
16	*
17	* @return \Stripe\Collection<\Stripe\Treasury\InboundTransfer>
18	*/
19	public function all($params = null, $opts = null)
20	{
21	return $this->requestCollection('get', '/v1/treasury/inbound_transfers', $params, $opts);
22	}
23
24	/**
25	* Cancels an InboundTransfer.
26	*
27	* @param string $id
28	* @param null\|array $params
29	* @param null\|array\|\Stripe\Util\RequestOptions $opts
30	*
31	* @throws \Stripe\Exception\ApiErrorException if the request fails
32	*
33	* @return \Stripe\Treasury\InboundTransfer
34	*/
35	public function cancel($id, $params = null, $opts = null)
36	{
37	return $this->request('post', $this->buildPath('/v1/treasury/inbound_transfers/%s/cancel', $id), $params, $opts);
38	}
39
40	/**
41	* Creates an InboundTransfer.
42	*
43	* @param null\|array $params
44	* @param null\|array\|\Stripe\Util\RequestOptions $opts
45	*
46	* @throws \Stripe\Exception\ApiErrorException if the request fails
47	*
48	* @return \Stripe\Treasury\InboundTransfer
49	*/
50	public function create($params = null, $opts = null)
51	{
52	return $this->request('post', '/v1/treasury/inbound_transfers', $params, $opts);
53	}
54
55	/**
56	* Retrieves the details of an existing InboundTransfer.
57	*
58	* @param string $id
59	* @param null\|array $params
60	* @param null\|array\|\Stripe\Util\RequestOptions $opts
61	*
62	* @throws \Stripe\Exception\ApiErrorException if the request fails
63	*
64	* @return \Stripe\Treasury\InboundTransfer
65	*/
66	public function retrieve($id, $params = null, $opts = null)
67	{
68	return $this->request('get', $this->buildPath('/v1/treasury/inbound_transfers/%s', $id), $params, $opts);
69	}
70	}
71