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

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

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

ChargeService.php

123 lines

1	<?php
2
3	// File generated from our OpenAPI spec
4
5	namespace Stripe\Service;
6
7	class ChargeService extends \Stripe\Service\AbstractService
8	{
9	/**
10	* Returns a list of charges you’ve previously created. The charges are returned in
11	* sorted order, with the most recent charges appearing first.
12	*
13	* @param null\|array $params
14	* @param null\|array\|\Stripe\Util\RequestOptions $opts
15	*
16	* @throws \Stripe\Exception\ApiErrorException if the request fails
17	*
18	* @return \Stripe\Collection<\Stripe\Charge>
19	*/
20	public function all($params = null, $opts = null)
21	{
22	return $this->requestCollection('get', '/v1/charges', $params, $opts);
23	}
24
25	/**
26	* Capture the payment of an existing, uncaptured, charge. This is the second half
27	* of the two-step payment flow, where first you <a href="#create_charge">created a
28	* charge</a> with the capture option set to false.
29	*
30	* Uncaptured payments expire a set number of days after they are created (<a
31	* href="/docs/charges/placing-a-hold">7 by default</a>). If they are not captured
32	* by that point in time, they will be marked as refunded and will no longer be
33	* capturable.
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\Charge
42	*/
43	public function capture($id, $params = null, $opts = null)
44	{
45	return $this->request('post', $this->buildPath('/v1/charges/%s/capture', $id), $params, $opts);
46	}
47
48	/**
49	* To charge a credit card or other payment source, you create a
50	* <code>Charge</code> object. If your API key is in test mode, the supplied
51	* payment source (e.g., card) won’t actually be charged, although everything else
52	* will occur as if in live mode. (Stripe assumes that the charge would have
53	* completed successfully).
54	*
55	* @param null\|array $params
56	* @param null\|array\|\Stripe\Util\RequestOptions $opts
57	*
58	* @throws \Stripe\Exception\ApiErrorException if the request fails
59	*
60	* @return \Stripe\Charge
61	*/
62	public function create($params = null, $opts = null)
63	{
64	return $this->request('post', '/v1/charges', $params, $opts);
65	}
66
67	/**
68	* Retrieves the details of a charge that has previously been created. Supply the
69	* unique charge ID that was returned from your previous request, and Stripe will
70	* return the corresponding charge information. The same information is returned
71	* when creating or refunding the charge.
72	*
73	* @param string $id
74	* @param null\|array $params
75	* @param null\|array\|\Stripe\Util\RequestOptions $opts
76	*
77	* @throws \Stripe\Exception\ApiErrorException if the request fails
78	*
79	* @return \Stripe\Charge
80	*/
81	public function retrieve($id, $params = null, $opts = null)
82	{
83	return $this->request('get', $this->buildPath('/v1/charges/%s', $id), $params, $opts);
84	}
85
86	/**
87	* Search for charges you’ve previously created using Stripe’s <a
88	* href="/docs/search#search-query-language">Search Query Language</a>. Don’t use
89	* search in read-after-write flows where strict consistency is necessary. Under
90	* normal operating conditions, data is searchable in less than a minute.
91	* Occasionally, propagation of new or updated data can be up to an hour behind
92	* during outages. Search functionality is not available to merchants in India.
93	*
94	* @param null\|array $params
95	* @param null\|array\|\Stripe\Util\RequestOptions $opts
96	*
97	* @throws \Stripe\Exception\ApiErrorException if the request fails
98	*
99	* @return \Stripe\SearchResult<\Stripe\Charge>
100	*/
101	public function search($params = null, $opts = null)
102	{
103	return $this->requestSearchResult('get', '/v1/charges/search', $params, $opts);
104	}
105
106	/**
107	* Updates the specified charge by setting the values of the parameters passed. Any
108	* parameters not provided will be left unchanged.
109	*
110	* @param string $id
111	* @param null\|array $params
112	* @param null\|array\|\Stripe\Util\RequestOptions $opts
113	*
114	* @throws \Stripe\Exception\ApiErrorException if the request fails
115	*
116	* @return \Stripe\Charge
117	*/
118	public function update($id, $params = null, $opts = null)
119	{
120	return $this->request('post', $this->buildPath('/v1/charges/%s', $id), $params, $opts);
121	}
122	}
123