ApiOperations
2 years ago
BillingPortal
2 years ago
Checkout
2 years ago
Exception
4 years ago
FinancialConnections
2 years ago
HttpClient
2 years ago
Identity
2 years ago
Issuing
2 years ago
Radar
2 years ago
Reporting
4 years ago
Service
2 years ago
Sigma
4 years ago
Terminal
2 years ago
TestHelpers
2 years ago
Util
2 years ago
Account.php
2 years ago
AccountLink.php
4 years ago
AlipayAccount.php
4 years ago
ApiRequestor.php
2 years ago
ApiResource.php
2 years ago
ApiResponse.php
4 years ago
ApplePayDomain.php
4 years ago
ApplicationFee.php
2 years ago
ApplicationFeeRefund.php
4 years ago
Balance.php
4 years ago
BalanceTransaction.php
4 years ago
BankAccount.php
4 years ago
BaseStripeClient.php
2 years ago
BaseStripeClientInterface.php
4 years ago
BitcoinReceiver.php
2 years ago
BitcoinTransaction.php
4 years ago
Capability.php
4 years ago
Card.php
2 years ago
CashBalance.php
2 years ago
Charge.php
2 years ago
Collection.php
2 years ago
CountrySpec.php
4 years ago
Coupon.php
2 years ago
CreditNote.php
2 years ago
CreditNoteLineItem.php
4 years ago
Customer.php
2 years ago
CustomerBalanceTransaction.php
4 years ago
Discount.php
2 years ago
Dispute.php
4 years ago
EphemeralKey.php
4 years ago
ErrorObject.php
4 years ago
Event.php
2 years ago
ExchangeRate.php
4 years ago
File.php
2 years ago
FileLink.php
4 years ago
FundingInstructions.php
2 years ago
Invoice.php
2 years ago
InvoiceItem.php
2 years ago
InvoiceLineItem.php
2 years ago
LineItem.php
4 years ago
LoginLink.php
4 years ago
Mandate.php
4 years ago
OAuth.php
4 years ago
OAuthErrorObject.php
4 years ago
Order.php
2 years ago
OrderItem.php
4 years ago
OrderReturn.php
4 years ago
PaymentIntent.php
2 years ago
PaymentLink.php
2 years ago
PaymentMethod.php
2 years ago
Payout.php
4 years ago
Person.php
2 years ago
Plan.php
2 years ago
Price.php
2 years ago
Product.php
2 years ago
PromotionCode.php
2 years ago
Quote.php
2 years ago
Recipient.php
2 years ago
RecipientTransfer.php
4 years ago
Refund.php
2 years ago
RequestTelemetry.php
4 years ago
Review.php
4 years ago
SKU.php
2 years ago
SearchResult.php
2 years ago
SetupAttempt.php
4 years ago
SetupIntent.php
2 years ago
ShippingRate.php
2 years ago
SingletonApiResource.php
2 years ago
Source.php
4 years ago
SourceTransaction.php
4 years ago
Stripe.php
2 years ago
StripeClient.php
2 years ago
StripeClientInterface.php
4 years ago
StripeObject.php
2 years ago
StripeStreamingClientInterface.php
4 years ago
Subscription.php
2 years ago
SubscriptionItem.php
2 years ago
SubscriptionSchedule.php
2 years ago
TaxCode.php
2 years ago
TaxId.php
2 years ago
TaxRate.php
4 years ago
ThreeDSecure.php
4 years ago
Token.php
4 years ago
Topup.php
4 years ago
Transfer.php
2 years ago
TransferReversal.php
4 years ago
UsageRecord.php
4 years ago
UsageRecordSummary.php
4 years ago
Webhook.php
4 years ago
WebhookEndpoint.php
4 years ago
WebhookSignature.php
4 years ago
Transfer.php
131 lines
| 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 null|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_ALIPAY_ACCOUNT = 'alipay_account'; |
| 50 | const SOURCE_TYPE_BANK_ACCOUNT = 'bank_account'; |
| 51 | const SOURCE_TYPE_CARD = 'card'; |
| 52 | const SOURCE_TYPE_FINANCING = 'financing'; |
| 53 | |
| 54 | /** |
| 55 | * @param null|array $params |
| 56 | * @param null|array|string $opts |
| 57 | * |
| 58 | * @throws \Stripe\Exception\ApiErrorException if the request fails |
| 59 | * |
| 60 | * @return \Stripe\Transfer the canceled transfer |
| 61 | */ |
| 62 | public function cancel($params = null, $opts = null) |
| 63 | { |
| 64 | $url = $this->instanceUrl() . '/cancel'; |
| 65 | list($response, $opts) = $this->_request('post', $url, $params, $opts); |
| 66 | $this->refreshFrom($response, $opts); |
| 67 | |
| 68 | return $this; |
| 69 | } |
| 70 | |
| 71 | const PATH_REVERSALS = '/reversals'; |
| 72 | |
| 73 | /** |
| 74 | * @param string $id the ID of the transfer on which to retrieve the transfer reversals |
| 75 | * @param null|array $params |
| 76 | * @param null|array|string $opts |
| 77 | * |
| 78 | * @throws \Stripe\Exception\ApiErrorException if the request fails |
| 79 | * |
| 80 | * @return \Stripe\Collection<\Stripe\TransferReversal> the list of transfer reversals |
| 81 | */ |
| 82 | public static function allReversals($id, $params = null, $opts = null) |
| 83 | { |
| 84 | return self::_allNestedResources($id, static::PATH_REVERSALS, $params, $opts); |
| 85 | } |
| 86 | |
| 87 | /** |
| 88 | * @param string $id the ID of the transfer on which to create the transfer reversal |
| 89 | * @param null|array $params |
| 90 | * @param null|array|string $opts |
| 91 | * |
| 92 | * @throws \Stripe\Exception\ApiErrorException if the request fails |
| 93 | * |
| 94 | * @return \Stripe\TransferReversal |
| 95 | */ |
| 96 | public static function createReversal($id, $params = null, $opts = null) |
| 97 | { |
| 98 | return self::_createNestedResource($id, static::PATH_REVERSALS, $params, $opts); |
| 99 | } |
| 100 | |
| 101 | /** |
| 102 | * @param string $id the ID of the transfer to which the transfer reversal belongs |
| 103 | * @param string $reversalId the ID of the transfer reversal to retrieve |
| 104 | * @param null|array $params |
| 105 | * @param null|array|string $opts |
| 106 | * |
| 107 | * @throws \Stripe\Exception\ApiErrorException if the request fails |
| 108 | * |
| 109 | * @return \Stripe\TransferReversal |
| 110 | */ |
| 111 | public static function retrieveReversal($id, $reversalId, $params = null, $opts = null) |
| 112 | { |
| 113 | return self::_retrieveNestedResource($id, static::PATH_REVERSALS, $reversalId, $params, $opts); |
| 114 | } |
| 115 | |
| 116 | /** |
| 117 | * @param string $id the ID of the transfer to which the transfer reversal belongs |
| 118 | * @param string $reversalId the ID of the transfer reversal to update |
| 119 | * @param null|array $params |
| 120 | * @param null|array|string $opts |
| 121 | * |
| 122 | * @throws \Stripe\Exception\ApiErrorException if the request fails |
| 123 | * |
| 124 | * @return \Stripe\TransferReversal |
| 125 | */ |
| 126 | public static function updateReversal($id, $reversalId, $params = null, $opts = null) |
| 127 | { |
| 128 | return self::_updateNestedResource($id, static::PATH_REVERSALS, $reversalId, $params, $opts); |
| 129 | } |
| 130 | } |
| 131 |