<?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 <code>Transfer</code> object is created when you move funds between Stripe accounts as

[6] Fix | Delete

* part of Connect.

[7] Fix | Delete

*

[8] Fix | Delete

* Before April 6, 2017, transfers also represented movement of funds from a

[9] Fix | Delete

* Stripe account to a card or bank account. This behavior has since been split

[10] Fix | Delete

* out into a <a href="https://stripe.com/docs/api#payout_object">Payout</a> object, with corresponding payout endpoints. For more

[11] Fix | Delete

* information, read about the

[12] Fix | Delete

* <a href="https://stripe.com/docs/transfer-payout-split">transfer/payout split</a>.

[13] Fix | Delete

*

[14] Fix | Delete

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

[15] Fix | Delete

*

[16] Fix | Delete

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

[17] Fix | Delete

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

[18] Fix | Delete

* @property int $amount Amount in cents (or local equivalent) to be transferred.

[19] Fix | Delete

* @property int $amount_reversed Amount in cents (or local equivalent) reversed (can be less than the amount attribute on the transfer if a partial reversal was issued).

[20] Fix | Delete

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

[21] Fix | Delete

* @property int $created Time that this record of the transfer was first created.

[22] 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>.

[23] Fix | Delete

* @property null|string $description An arbitrary string attached to the object. Often useful for displaying to users.

[24] Fix | Delete

* @property null|string|\Stripe\Account $destination ID of the Stripe account the transfer was sent to.

[25] Fix | Delete

* @property null|string|\Stripe\Charge $destination_payment If the destination is a Stripe account, this will be the ID of the payment that the destination account received for the transfer.

[26] Fix | Delete

* @property bool $livemode Has the value <code>true</code> if the object exists in live mode or the value <code>false</code> if the object exists in test mode.

[27] Fix | Delete

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

[28] Fix | Delete

* @property \Stripe\Collection<\Stripe\TransferReversal> $reversals A list of reversals that have been applied to the transfer.

[29] Fix | Delete

* @property bool $reversed Whether the transfer has been fully reversed. If the transfer is only partially reversed, this attribute will still be false.

[30] Fix | Delete

* @property null|string|\Stripe\Charge $source_transaction ID of the charge or payment that was used to fund the transfer. If null, the transfer was funded from the available balance.

[31] Fix | Delete

* @property null|string $source_type The source balance this transfer came from. One of <code>card</code>, <code>fpx</code>, or <code>bank_account</code>.

[32] Fix | Delete

* @property null|string $transfer_group A string that identifies this transaction as part of a group. See the <a href="https://stripe.com/docs/connect/separate-charges-and-transfers#transfer-options">Connect documentation</a> for details.

[33] Fix | Delete

*/

[34] Fix | Delete

class Transfer extends ApiResource

[35] Fix | Delete

{

[36] Fix | Delete

const OBJECT_NAME = 'transfer';

[37] Fix | Delete

use ApiOperations\All;

[38] Fix | Delete

use ApiOperations\Create;

[39] Fix | Delete

use ApiOperations\NestedResource;

[40] Fix | Delete

use ApiOperations\Retrieve;

[41] Fix | Delete

use ApiOperations\Update;

[42] Fix | Delete

const SOURCE_TYPE_BANK_ACCOUNT = 'bank_account';

[43] Fix | Delete

const SOURCE_TYPE_CARD = 'card';

[44] Fix | Delete

const SOURCE_TYPE_FPX = 'fpx';

[45] Fix | Delete

const PATH_REVERSALS = '/reversals';

[46] Fix | Delete

/**

[47] Fix | Delete

* @param string $id the ID of the transfer on which to retrieve the transfer reversals

[48] Fix | Delete

* @param null|array $params

[49] Fix | Delete

* @param null|array|string $opts

[50] Fix | Delete

*

[51] Fix | Delete

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

[52] Fix | Delete

*

[53] Fix | Delete

* @return \Stripe\Collection<\Stripe\TransferReversal> the list of transfer reversals

[54] Fix | Delete

*/

[55] Fix | Delete

public static function allReversals($id, $params = null, $opts = null)

[56] Fix | Delete

{

[57] Fix | Delete

return self::_allNestedResources($id, static::PATH_REVERSALS, $params, $opts);

[58] Fix | Delete

}

[59] Fix | Delete

/**

[60] Fix | Delete

* @param string $id the ID of the transfer on which to create the transfer reversal

[61] Fix | Delete

* @param null|array $params

[62] Fix | Delete

* @param null|array|string $opts

[63] Fix | Delete

*

[64] Fix | Delete

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

[65] Fix | Delete

*

[66] Fix | Delete

* @return \Stripe\TransferReversal

[67] Fix | Delete

*/

[68] Fix | Delete

public static function createReversal($id, $params = null, $opts = null)

[69] Fix | Delete

{

[70] Fix | Delete

return self::_createNestedResource($id, static::PATH_REVERSALS, $params, $opts);

[71] Fix | Delete

}

[72] Fix | Delete

/**

[73] Fix | Delete

* @param string $id the ID of the transfer to which the transfer reversal belongs

[74] Fix | Delete

* @param string $reversalId the ID of the transfer reversal to retrieve

[75] Fix | Delete

* @param null|array $params

[76] Fix | Delete

* @param null|array|string $opts

[77] Fix | Delete

*

[78] Fix | Delete

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

[79] Fix | Delete

*

[80] Fix | Delete

* @return \Stripe\TransferReversal

[81] Fix | Delete

*/

[82] Fix | Delete

public static function retrieveReversal($id, $reversalId, $params = null, $opts = null)

[83] Fix | Delete

{

[84] Fix | Delete

return self::_retrieveNestedResource($id, static::PATH_REVERSALS, $reversalId, $params, $opts);

[85] Fix | Delete

}

[86] Fix | Delete

/**

[87] Fix | Delete

* @param string $id the ID of the transfer to which the transfer reversal belongs

[88] Fix | Delete

* @param string $reversalId the ID of the transfer reversal to update

[89] Fix | Delete

* @param null|array $params

[90] Fix | Delete

* @param null|array|string $opts

[91] Fix | Delete

*

[92] Fix | Delete

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

[93] Fix | Delete

*

[94] Fix | Delete

* @return \Stripe\TransferReversal

[95] Fix | Delete

*/

[96] Fix | Delete

public static function updateReversal($id, $reversalId, $params = null, $opts = null)

[97] Fix | Delete

{

[98] Fix | Delete

return self::_updateNestedResource($id, static::PATH_REVERSALS, $reversalId, $params, $opts);

[99] Fix | Delete

}

[100] Fix | Delete

}

[101] Fix | Delete

[102] Fix | Delete