TransferReversal.php — Paid Membership Plugin, Ecommerce, User Registration Form, Login Form, User Profile & Restrict Content – ProfilePress 4.17.1

wp-user-avatar / third-party / vendor / stripe / stripe-php / lib / TransferReversal.php

wp-user-avatar / third-party / vendor / stripe / stripe-php / lib Last commit date

TransferReversal.php

67 lines

1	<?php
2
3	// File generated from our OpenAPI spec
4	namespace ProfilePressVendor\Stripe;
5
6	/**
7	* <a href="https://stripe.com/docs/connect">Stripe Connect</a> platforms can reverse transfers made to a
8	* connected account, either entirely or partially, and can also specify whether
9	* to refund any related application fees. Transfer reversals add to the
10	* platform's balance and subtract from the destination account's balance.
11	*
12	* Reversing a transfer that was made for a <a href="/docs/connect/destination-charges">destination
13	* charge</a> is allowed only up to the amount of
14	* the charge. It is possible to reverse a
15	* <a href="https://stripe.com/docs/connect/separate-charges-and-transfers#transfer-options">transfer_group</a>
16	* transfer only if the destination account has enough balance to cover the
17	* reversal.
18	*
19	* Related guide: <a href="https://stripe.com/docs/connect/separate-charges-and-transfers#reverse-transfers">Reverse transfers</a>
20	*
21	* @property string $id Unique identifier for the object.
22	* @property string $object String representing the object's type. Objects of the same type share the same value.
23	* @property int $amount Amount, in cents (or local equivalent).
24	* @property null\|string\|\Stripe\BalanceTransaction $balance_transaction Balance transaction that describes the impact on your account balance.
25	* @property int $created Time at which the object was created. Measured in seconds since the Unix epoch.
26	* @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>.
27	* @property null\|string\|\Stripe\Refund $destination_payment_refund Linked payment refund for the transfer reversal.
28	* @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.
29	* @property null\|string\|\Stripe\Refund $source_refund ID of the refund responsible for the transfer reversal.
30	* @property string\|\Stripe\Transfer $transfer ID of the transfer that was reversed.
31	*/
32	class TransferReversal extends ApiResource
33	{
34	const OBJECT_NAME = 'transfer_reversal';
35	use ApiOperations\Update {
36	save as protected _save;
37	}
38	/**
39	* @return string the API URL for this Stripe transfer reversal
40	*/
41	public function instanceUrl()
42	{
43	$id = $this['id'];
44	$transfer = $this['transfer'];
45	if (!$id) {
46	throw new Exception\UnexpectedValueException('Could not determine which URL to request: ' . "class instance has invalid ID: {$id}", null);
47	}
48	$id = Util\Util::utf8($id);
49	$transfer = Util\Util::utf8($transfer);
50	$base = Transfer::classUrl();
51	$transferExtn = \urlencode($transfer);
52	$extn = \urlencode($id);
53	return "{$base}/{$transferExtn}/reversals/{$extn}";
54	}
55	/**
56	* @param null\|array\|string $opts
57	*
58	* @throws \Stripe\Exception\ApiErrorException if the request fails
59	*
60	* @return TransferReversal the saved reversal
61	*/
62	public function save($opts = null)
63	{
64	return $this->_save($opts);
65	}
66	}
67