ApiOperations
6 years ago
Checkout
6 years ago
Error
6 years ago
HttpClient
6 years ago
Issuing
6 years ago
Radar
6 years ago
Reporting
6 years ago
Sigma
6 years ago
Terminal
6 years ago
Util
6 years ago
Account.php
6 years ago
AccountLink.php
6 years ago
AlipayAccount.php
6 years ago
ApiRequestor.php
6 years ago
ApiResource.php
6 years ago
ApiResponse.php
6 years ago
ApplePayDomain.php
6 years ago
ApplicationFee.php
6 years ago
ApplicationFeeRefund.php
6 years ago
Balance.php
6 years ago
BalanceTransaction.php
6 years ago
BankAccount.php
6 years ago
BitcoinReceiver.php
6 years ago
BitcoinTransaction.php
6 years ago
Capability.php
6 years ago
Card.php
6 years ago
Charge.php
6 years ago
Collection.php
6 years ago
CountrySpec.php
6 years ago
Coupon.php
6 years ago
CreditNote.php
6 years ago
Customer.php
6 years ago
CustomerBalanceTransaction.php
6 years ago
Discount.php
6 years ago
Dispute.php
6 years ago
EphemeralKey.php
6 years ago
Event.php
6 years ago
ExchangeRate.php
6 years ago
File.php
6 years ago
FileLink.php
6 years ago
FileUpload.php
6 years ago
Invoice.php
6 years ago
InvoiceItem.php
6 years ago
InvoiceLineItem.php
6 years ago
IssuerFraudRecord.php
6 years ago
LoginLink.php
6 years ago
OAuth.php
6 years ago
Order.php
6 years ago
OrderItem.php
6 years ago
OrderReturn.php
6 years ago
PaymentIntent.php
6 years ago
PaymentMethod.php
6 years ago
Payout.php
6 years ago
Person.php
6 years ago
Plan.php
6 years ago
Product.php
6 years ago
Recipient.php
6 years ago
RecipientTransfer.php
6 years ago
Refund.php
6 years ago
RequestTelemetry.php
6 years ago
Review.php
6 years ago
SKU.php
6 years ago
SetupIntent.php
6 years ago
SingletonApiResource.php
6 years ago
Source.php
6 years ago
SourceTransaction.php
6 years ago
Stripe.php
6 years ago
StripeObject.php
6 years ago
Subscription.php
6 years ago
SubscriptionItem.php
6 years ago
SubscriptionSchedule.php
6 years ago
TaxId.php
6 years ago
TaxRate.php
6 years ago
ThreeDSecure.php
6 years ago
Token.php
6 years ago
Topup.php
6 years ago
Transfer.php
6 years ago
TransferReversal.php
6 years ago
UsageRecord.php
6 years ago
UsageRecordSummary.php
6 years ago
Webhook.php
6 years ago
WebhookEndpoint.php
6 years ago
WebhookSignature.php
6 years ago
Transfer.php
121 lines
| 1 | <?php |
| 2 | |
| 3 | namespace Stripe; |
| 4 | |
| 5 | /** |
| 6 | * Class Transfer |
| 7 | * |
| 8 | * @property string $id |
| 9 | * @property string $object |
| 10 | * @property int $amount |
| 11 | * @property int $amount_reversed |
| 12 | * @property string $balance_transaction |
| 13 | * @property int $created |
| 14 | * @property string $currency |
| 15 | * @property string $description |
| 16 | * @property string $destination |
| 17 | * @property string $destination_payment |
| 18 | * @property bool $livemode |
| 19 | * @property StripeObject $metadata |
| 20 | * @property Collection $reversals |
| 21 | * @property bool $reversed |
| 22 | * @property string $source_transaction |
| 23 | * @property string $source_type |
| 24 | * @property string $transfer_group |
| 25 | * |
| 26 | * @package Stripe |
| 27 | */ |
| 28 | class Transfer extends ApiResource |
| 29 | { |
| 30 | const OBJECT_NAME = "transfer"; |
| 31 | |
| 32 | use ApiOperations\All; |
| 33 | use ApiOperations\Create; |
| 34 | use ApiOperations\NestedResource; |
| 35 | use ApiOperations\Retrieve; |
| 36 | use ApiOperations\Update; |
| 37 | |
| 38 | const PATH_REVERSALS = '/reversals'; |
| 39 | |
| 40 | /** |
| 41 | * Possible string representations of the source type of the transfer. |
| 42 | * @link https://stripe.com/docs/api/transfers/object#transfer_object-source_type |
| 43 | */ |
| 44 | const SOURCE_TYPE_ALIPAY_ACCOUNT = 'alipay_account'; |
| 45 | const SOURCE_TYPE_BANK_ACCOUNT = 'bank_account'; |
| 46 | const SOURCE_TYPE_CARD = 'card'; |
| 47 | const SOURCE_TYPE_FINANCING = 'financing'; |
| 48 | |
| 49 | /** |
| 50 | * @return TransferReversal The created transfer reversal. |
| 51 | */ |
| 52 | public function reverse($params = null, $opts = null) |
| 53 | { |
| 54 | $url = $this->instanceUrl() . '/reversals'; |
| 55 | list($response, $opts) = $this->_request('post', $url, $params, $opts); |
| 56 | $this->refreshFrom($response, $opts); |
| 57 | return $this; |
| 58 | } |
| 59 | |
| 60 | /** |
| 61 | * @return Transfer The canceled transfer. |
| 62 | */ |
| 63 | public function cancel() |
| 64 | { |
| 65 | $url = $this->instanceUrl() . '/cancel'; |
| 66 | list($response, $opts) = $this->_request('post', $url); |
| 67 | $this->refreshFrom($response, $opts); |
| 68 | return $this; |
| 69 | } |
| 70 | |
| 71 | /** |
| 72 | * @param string|null $id The ID of the transfer on which to create the reversal. |
| 73 | * @param array|null $params |
| 74 | * @param array|string|null $opts |
| 75 | * |
| 76 | * @return 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|null $id The ID of the transfer to which the reversal belongs. |
| 85 | * @param array|null $reversalId The ID of the reversal to retrieve. |
| 86 | * @param array|null $params |
| 87 | * @param array|string|null $opts |
| 88 | * |
| 89 | * @return TransferReversal |
| 90 | */ |
| 91 | public static function retrieveReversal($id, $reversalId, $params = null, $opts = null) |
| 92 | { |
| 93 | return self::_retrieveNestedResource($id, static::PATH_REVERSALS, $reversalId, $params, $opts); |
| 94 | } |
| 95 | |
| 96 | /** |
| 97 | * @param string|null $id The ID of the transfer to which the reversal belongs. |
| 98 | * @param array|null $reversalId The ID of the reversal to update. |
| 99 | * @param array|null $params |
| 100 | * @param array|string|null $opts |
| 101 | * |
| 102 | * @return TransferReversal |
| 103 | */ |
| 104 | public static function updateReversal($id, $reversalId, $params = null, $opts = null) |
| 105 | { |
| 106 | return self::_updateNestedResource($id, static::PATH_REVERSALS, $reversalId, $params, $opts); |
| 107 | } |
| 108 | |
| 109 | /** |
| 110 | * @param string|null $id The ID of the transfer on which to retrieve the reversals. |
| 111 | * @param array|null $params |
| 112 | * @param array|string|null $opts |
| 113 | * |
| 114 | * @return Collection The list of reversals. |
| 115 | */ |
| 116 | public static function allReversals($id, $params = null, $opts = null) |
| 117 | { |
| 118 | return self::_allNestedResources($id, static::PATH_REVERSALS, $params, $opts); |
| 119 | } |
| 120 | } |
| 121 |