give / vendor / stripe / stripe-php / lib / Refund.php

Refund.php in GiveWP – Donation Plugin and Fundraising Platform 4.15.0, at vendor/stripe/stripe-php/lib/Refund.php

79 lines 4.7 KB

Raw Download Zip

1	<?php
2
3	// File generated from our OpenAPI spec
4
5	namespace Stripe;
6
7	/**
8	* <code>Refund</code> objects allow you to refund a charge that has previously
9	* been created but not yet refunded. Funds will be refunded to the credit or debit
10	* card that was originally charged.
11	*
12	* Related guide: <a href="https://stripe.com/docs/refunds">Refunds</a>.
13	*
14	* @property string $id Unique identifier for the object.
15	* @property string $object String representing the object's type. Objects of the same type share the same value.
16	* @property int $amount Amount, in %s.
17	* @property null\|string\|\Stripe\BalanceTransaction $balance_transaction Balance transaction that describes the impact on your account balance.
18	* @property null\|string\|\Stripe\Charge $charge ID of the charge that was refunded.
19	* @property int $created Time at which the object was created. Measured in seconds since the Unix epoch.
20	* @property string $currency Three-letter <a href="https://www.iso.org/iso-4217-currency-codes.html">ISO currency code</a>, in lowercase. Must be a <a href="https://stripe.com/docs/currencies">supported currency</a>.
21	* @property string $description An arbitrary string attached to the object. Often useful for displaying to users. (Available on non-card refunds only)
22	* @property string\|\Stripe\BalanceTransaction $failure_balance_transaction If the refund failed, this balance transaction describes the adjustment made on your account balance that reverses the initial balance transaction.
23	* @property string $failure_reason If the refund failed, the reason for refund failure if known. Possible values are <code>lost_or_stolen_card</code>, <code>expired_or_canceled_card</code>, or <code>unknown</code>.
24	* @property string $instructions_email Email to which refund instructions, if required, are sent to.
25	* @property null\|\Stripe\StripeObject $metadata Set of <a href="https://stripe.com/docs/api/metadata">key-value pairs</a> that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
26	* @property \Stripe\StripeObject $next_action
27	* @property null\|string\|\Stripe\PaymentIntent $payment_intent ID of the PaymentIntent that was refunded.
28	* @property null\|string $reason Reason for the refund, either user-provided (<code>duplicate</code>, <code>fraudulent</code>, or <code>requested_by_customer</code>) or generated by Stripe internally (<code>expired_uncaptured_charge</code>).
29	* @property null\|string $receipt_number This is the transaction number that appears on email receipts sent for this refund.
30	* @property null\|string\|\Stripe\TransferReversal $source_transfer_reversal The transfer reversal that is associated with the refund. Only present if the charge came from another Stripe account. See the Connect documentation for details.
31	* @property null\|string $status Status of the refund. For credit card refunds, this can be <code>pending</code>, <code>succeeded</code>, or <code>failed</code>. For other types of refunds, it can be <code>pending</code>, <code>succeeded</code>, <code>failed</code>, or <code>canceled</code>. Refer to our <a href="https://stripe.com/docs/refunds#failed-refunds">refunds</a> documentation for more details.
32	* @property null\|string\|\Stripe\TransferReversal $transfer_reversal If the accompanying transfer was reversed, the transfer reversal object. Only applicable if the charge was created using the destination parameter.
33	*/
34	class Refund extends ApiResource
35	{
36	const OBJECT_NAME = 'refund';
37
38	use ApiOperations\All;
39	use ApiOperations\Create;
40	use ApiOperations\Retrieve;
41	use ApiOperations\Update;
42
43	const FAILURE_REASON_EXPIRED_OR_CANCELED_CARD = 'expired_or_canceled_card';
44	const FAILURE_REASON_LOST_OR_STOLEN_CARD = 'lost_or_stolen_card';
45	const FAILURE_REASON_UNKNOWN = 'unknown';
46
47	const REASON_DUPLICATE = 'duplicate';
48	const REASON_EXPIRED_UNCAPTURED_CHARGE = 'expired_uncaptured_charge';
49	const REASON_FRAUDULENT = 'fraudulent';
50	const REASON_REQUESTED_BY_CUSTOMER = 'requested_by_customer';
51
52	const STATUS_CANCELED = 'canceled';
53	const STATUS_FAILED = 'failed';
54	const STATUS_PENDING = 'pending';
55	const STATUS_SUCCEEDED = 'succeeded';
56
57	/**
58	* @deprecated use FAILURE_REASON_EXPIRED_OR_CANCELED_CARD instead
59	*/
60	const FAILURE_REASON = 'expired_or_canceled_card';
61
62	/**
63	* @param null\|array $params
64	* @param null\|array\|string $opts
65	*
66	* @throws \Stripe\Exception\ApiErrorException if the request fails
67	*
68	* @return \Stripe\Refund the canceled refund
69	*/
70	public function cancel($params = null, $opts = null)
71	{
72	$url = $this->instanceUrl() . '/cancel';
73	list($response, $opts) = $this->_request('post', $url, $params, $opts);
74	$this->refreshFrom($response, $opts);
75
76	return $this;
77	}
78	}
79