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