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

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

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

ChargeService.php

102 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
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 exactly seven days after they are created. If they
31	* are not captured by that point in time, they will be marked as refunded and will
32	* no longer be capturable.
33	*
34	* @param string $id
35	* @param null\|array $params
36	* @param null\|array\|\Stripe\Util\RequestOptions $opts
37	*
38	* @throws \Stripe\Exception\ApiErrorException if the request fails
39	*
40	* @return \Stripe\Charge
41	*/
42	public function capture($id, $params = null, $opts = null)
43	{
44	return $this->request('post', $this->buildPath('/v1/charges/%s/capture', $id), $params, $opts);
45	}
46
47	/**
48	* To charge a credit card or other payment source, you create a
49	* <code>Charge</code> object. If your API key is in test mode, the supplied
50	* payment source (e.g., card) won’t actually be charged, although everything else
51	* will occur as if in live mode. (Stripe assumes that the charge would have
52	* completed successfully).
53	*
54	* @param null\|array $params
55	* @param null\|array\|\Stripe\Util\RequestOptions $opts
56	*
57	* @throws \Stripe\Exception\ApiErrorException if the request fails
58	*
59	* @return \Stripe\Charge
60	*/
61	public function create($params = null, $opts = null)
62	{
63	return $this->request('post', '/v1/charges', $params, $opts);
64	}
65
66	/**
67	* Retrieves the details of a charge that has previously been created. Supply the
68	* unique charge ID that was returned from your previous request, and Stripe will
69	* return the corresponding charge information. The same information is returned
70	* when creating or refunding the charge.
71	*
72	* @param string $id
73	* @param null\|array $params
74	* @param null\|array\|\Stripe\Util\RequestOptions $opts
75	*
76	* @throws \Stripe\Exception\ApiErrorException if the request fails
77	*
78	* @return \Stripe\Charge
79	*/
80	public function retrieve($id, $params = null, $opts = null)
81	{
82	return $this->request('get', $this->buildPath('/v1/charges/%s', $id), $params, $opts);
83	}
84
85	/**
86	* Updates the specified charge by setting the values of the parameters passed. Any
87	* parameters not provided will be left unchanged.
88	*
89	* @param string $id
90	* @param null\|array $params
91	* @param null\|array\|\Stripe\Util\RequestOptions $opts
92	*
93	* @throws \Stripe\Exception\ApiErrorException if the request fails
94	*
95	* @return \Stripe\Charge
96	*/
97	public function update($id, $params = null, $opts = null)
98	{
99	return $this->request('post', $this->buildPath('/v1/charges/%s', $id), $params, $opts);
100	}
101	}
102