<?php

[0] Fix | Delete

[1] Fix | Delete

// File generated from our OpenAPI spec

[2] Fix | Delete

namespace WPForms\Vendor\Stripe;

[3] Fix | Delete

[4] Fix | Delete

/**

[5] Fix | Delete

* <a href="https://stripe.com/docs/connect">Stripe Connect</a> platforms can reverse transfers made to a

[6] Fix | Delete

* connected account, either entirely or partially, and can also specify whether

[7] Fix | Delete

* to refund any related application fees. Transfer reversals add to the

[8] Fix | Delete

* platform's balance and subtract from the destination account's balance.

[9] Fix | Delete

*

[10] Fix | Delete

* Reversing a transfer that was made for a <a href="/docs/connect/destination-charges">destination

[11] Fix | Delete

* charge</a> is allowed only up to the amount of

[12] Fix | Delete

* the charge. It is possible to reverse a

[13] Fix | Delete

* <a href="https://stripe.com/docs/connect/separate-charges-and-transfers#transfer-options">transfer_group</a>

[14] Fix | Delete

* transfer only if the destination account has enough balance to cover the

[15] Fix | Delete

* reversal.

[16] Fix | Delete

*

[17] Fix | Delete

* Related guide: <a href="https://stripe.com/docs/connect/separate-charges-and-transfers#reversing-transfers">Reversing transfers</a>

[18] Fix | Delete

*

[19] Fix | Delete

* @property string $id Unique identifier for the object.

[20] Fix | Delete

* @property string $object String representing the object's type. Objects of the same type share the same value.

[21] Fix | Delete

* @property int $amount Amount, in cents (or local equivalent).

[22] Fix | Delete

* @property null|string|\Stripe\BalanceTransaction $balance_transaction Balance transaction that describes the impact on your account balance.

[23] Fix | Delete

* @property int $created Time at which the object was created. Measured in seconds since the Unix epoch.

[24] Fix | Delete

* @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>.

[25] Fix | Delete

* @property null|string|\Stripe\Refund $destination_payment_refund Linked payment refund for the transfer reversal.

[26] Fix | Delete

* @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.

[27] Fix | Delete

* @property null|string|\Stripe\Refund $source_refund ID of the refund responsible for the transfer reversal.

[28] Fix | Delete

* @property string|\Stripe\Transfer $transfer ID of the transfer that was reversed.

[29] Fix | Delete

*/

[30] Fix | Delete

class TransferReversal extends ApiResource

[31] Fix | Delete

{

[32] Fix | Delete

const OBJECT_NAME = 'transfer_reversal';

[33] Fix | Delete

use ApiOperations\Update {

[34] Fix | Delete

save as protected _save;

[35] Fix | Delete

}

[36] Fix | Delete

/**

[37] Fix | Delete

* @return string the API URL for this Stripe transfer reversal

[38] Fix | Delete

*/

[39] Fix | Delete

public function instanceUrl()

[40] Fix | Delete

{

[41] Fix | Delete

$id = $this['id'];

[42] Fix | Delete

$transfer = $this['transfer'];

[43] Fix | Delete

if (!$id) {

[44] Fix | Delete

throw new Exception\UnexpectedValueException('Could not determine which URL to request: ' . "class instance has invalid ID: {$id}", null);

[45] Fix | Delete

}

[46] Fix | Delete

$id = Util\Util::utf8($id);

[47] Fix | Delete

$transfer = Util\Util::utf8($transfer);

[48] Fix | Delete

$base = Transfer::classUrl();

[49] Fix | Delete

$transferExtn = \urlencode($transfer);

[50] Fix | Delete

$extn = \urlencode($id);

[51] Fix | Delete

return "{$base}/{$transferExtn}/reversals/{$extn}";

[52] Fix | Delete

}

[53] Fix | Delete

/**

[54] Fix | Delete

* @param null|array|string $opts

[55] Fix | Delete

*

[56] Fix | Delete

* @throws \Stripe\Exception\ApiErrorException if the request fails

[57] Fix | Delete

*

[58] Fix | Delete

* @return TransferReversal the saved reversal

[59] Fix | Delete

*/

[60] Fix | Delete

public function save($opts = null)

[61] Fix | Delete

{

[62] Fix | Delete

return $this->_save($opts);

[63] Fix | Delete

}

[64] Fix | Delete

}

[65] Fix | Delete

[66] Fix | Delete