charitable / vendor / stripe / stripe-php / lib / Transfer.php

Transfer.php in Charitable – Donation & Fundraising Platform (Donation Forms, Recurring Donations & Fundraising Campaigns) 1.8.13, at vendor/stripe/stripe-php/lib/Transfer.php

113 lines 5.7 KB

Raw Download Zip

1	<?php
2
3	// File generated from our OpenAPI spec
4
5	namespace Stripe;
6
7	/**
8	* A <code>Transfer</code> object is created when you move funds between Stripe
9	* accounts as part of Connect.
10	*
11	* Before April 6, 2017, transfers also represented movement of funds from a Stripe
12	* account to a card or bank account. This behavior has since been split out into a
13	* <a href="https://stripe.com/docs/api#payout_object">Payout</a> object, with
14	* corresponding payout endpoints. For more information, read about the <a
15	* href="https://stripe.com/docs/transfer-payout-split">transfer/payout split</a>.
16	*
17	* Related guide: <a
18	* href="https://stripe.com/docs/connect/charges-transfers">Creating Separate
19	* Charges and 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 %s to be transferred.
24	* @property int $amount_reversed Amount in %s reversed (can be less than the amount attribute on the transfer if a partial reversal was issued).
25	* @property null\|string\|\Stripe\BalanceTransaction $balance_transaction Balance transaction that describes the impact of this transfer on your account balance.
26	* @property int $created Time that this record of the transfer was first created.
27	* @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>.
28	* @property null\|string $description An arbitrary string attached to the object. Often useful for displaying to users.
29	* @property null\|string\|\Stripe\Account $destination ID of the Stripe account the transfer was sent to.
30	* @property 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.
31	* @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.
32	* @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.
33	* @property \Stripe\Collection<\Stripe\TransferReversal> $reversals A list of reversals that have been applied to the transfer.
34	* @property bool $reversed Whether the transfer has been fully reversed. If the transfer is only partially reversed, this attribute will still be false.
35	* @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.
36	* @property string $source_type The source balance this transfer came from. One of <code>card</code>, <code>fpx</code>, or <code>bank_account</code>.
37	* @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/charges-transfers#transfer-options">Connect documentation</a> for details.
38	*/
39	class Transfer extends ApiResource
40	{
41	const OBJECT_NAME = 'transfer';
42
43	use ApiOperations\All;
44	use ApiOperations\Create;
45	use ApiOperations\NestedResource;
46	use ApiOperations\Retrieve;
47	use ApiOperations\Update;
48
49	const SOURCE_TYPE_BANK_ACCOUNT = 'bank_account';
50	const SOURCE_TYPE_CARD = 'card';
51	const SOURCE_TYPE_FPX = 'fpx';
52
53	const PATH_REVERSALS = '/reversals';
54
55	/**
56	* @param string $id the ID of the transfer on which to retrieve the transfer reversals
57	* @param null\|array $params
58	* @param null\|array\|string $opts
59	*
60	* @throws \Stripe\Exception\ApiErrorException if the request fails
61	*
62	* @return \Stripe\Collection<\Stripe\TransferReversal> the list of transfer reversals
63	*/
64	public static function allReversals($id, $params = null, $opts = null)
65	{
66	return self::_allNestedResources($id, static::PATH_REVERSALS, $params, $opts);
67	}
68
69	/**
70	* @param string $id the ID of the transfer on which to create the transfer reversal
71	* @param null\|array $params
72	* @param null\|array\|string $opts
73	*
74	* @throws \Stripe\Exception\ApiErrorException if the request fails
75	*
76	* @return \Stripe\TransferReversal
77	*/
78	public static function createReversal($id, $params = null, $opts = null)
79	{
80	return self::_createNestedResource($id, static::PATH_REVERSALS, $params, $opts);
81	}
82
83	/**
84	* @param string $id the ID of the transfer to which the transfer reversal belongs
85	* @param string $reversalId the ID of the transfer reversal to retrieve
86	* @param null\|array $params
87	* @param null\|array\|string $opts
88	*
89	* @throws \Stripe\Exception\ApiErrorException if the request fails
90	*
91	* @return \Stripe\TransferReversal
92	*/
93	public static function retrieveReversal($id, $reversalId, $params = null, $opts = null)
94	{
95	return self::_retrieveNestedResource($id, static::PATH_REVERSALS, $reversalId, $params, $opts);
96	}
97
98	/**
99	* @param string $id the ID of the transfer to which the transfer reversal belongs
100	* @param string $reversalId the ID of the transfer reversal to update
101	* @param null\|array $params
102	* @param null\|array\|string $opts
103	*
104	* @throws \Stripe\Exception\ApiErrorException if the request fails
105	*
106	* @return \Stripe\TransferReversal
107	*/
108	public static function updateReversal($id, $reversalId, $params = null, $opts = null)
109	{
110	return self::_updateNestedResource($id, static::PATH_REVERSALS, $reversalId, $params, $opts);
111	}
112	}
113