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
TransferReversal.php
80 lines
| 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 |