| 1 |
<?php |
| 2 |
|
| 3 |
// File generated from our OpenAPI spec |
| 4 |
|
| 5 |
namespace Stripe\Treasury; |
| 6 |
|
| 7 |
/** |
| 8 |
* Use OutboundTransfers to transfer funds from a <a |
| 9 |
* href="https://stripe.com/docs/api#financial_accounts">FinancialAccount</a> to a |
| 10 |
* PaymentMethod belonging to the same entity. To send funds to a different party, |
| 11 |
* use <a href="https://stripe.com/docs/api#outbound_payments">OutboundPayments</a> |
| 12 |
* instead. You can send funds over ACH rails or through a domestic wire transfer |
| 13 |
* to a user's own external bank account. |
| 14 |
* |
| 15 |
* Simulate OutboundTransfer state changes with the |
| 16 |
* <code>/v1/test_helpers/treasury/outbound_transfers</code> endpoints. These |
| 17 |
* methods can only be called on test mode objects. |
| 18 |
* |
| 19 |
* @property string $id Unique identifier for the object. |
| 20 |
* @property string $object String representing the object's type. Objects of the same type share the same value. |
| 21 |
* @property int $amount Amount (in cents) transferred. |
| 22 |
* @property bool $cancelable Returns <code>true</code> if the object can be canceled, and <code>false</code> otherwise. |
| 23 |
* @property int $created Time at which the object was created. Measured in seconds since the Unix epoch. |
| 24 |
* @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>. |
| 25 |
* @property null|string $description An arbitrary string attached to the object. Often useful for displaying to users. |
| 26 |
* @property string $destination_payment_method The PaymentMethod used as the payment instrument for an OutboundTransfer. |
| 27 |
* @property \Stripe\StripeObject $destination_payment_method_details |
| 28 |
* @property int $expected_arrival_date The date when funds are expected to arrive in the destination account. |
| 29 |
* @property string $financial_account The FinancialAccount that funds were pulled from. |
| 30 |
* @property null|string $hosted_regulatory_receipt_url A <a href="https://stripe.com/docs/treasury/moving-money/regulatory-receipts">hosted transaction receipt</a> URL that is provided when money movement is considered regulated under Stripe's money transmission licenses. |
| 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 null|\Stripe\StripeObject $returned_details Details about a returned OutboundTransfer. Only set when the status is <code>returned</code>. |
| 34 |
* @property string $statement_descriptor Information about the OutboundTransfer to be sent to the recipient account. |
| 35 |
* @property string $status Current status of the OutboundTransfer: <code>processing</code>, <code>failed</code>, <code>canceled</code>, <code>posted</code>, <code>returned</code>. An OutboundTransfer is <code>processing</code> if it has been created and is pending. The status changes to <code>posted</code> once the OutboundTransfer has been "confirmed" and funds have left the account, or to <code>failed</code> or <code>canceled</code>. If an OutboundTransfer fails to arrive at its destination, its status will change to <code>returned</code>. |
| 36 |
* @property \Stripe\StripeObject $status_transitions |
| 37 |
* @property string|\Stripe\Treasury\Transaction $transaction The Transaction associated with this object. |
| 38 |
*/ |
| 39 |
class OutboundTransfer extends \Stripe\ApiResource |
| 40 |
{ |
| 41 |
const OBJECT_NAME = 'treasury.outbound_transfer'; |
| 42 |
|
| 43 |
use \Stripe\ApiOperations\All; |
| 44 |
use \Stripe\ApiOperations\Create; |
| 45 |
use \Stripe\ApiOperations\Retrieve; |
| 46 |
|
| 47 |
const STATUS_CANCELED = 'canceled'; |
| 48 |
const STATUS_FAILED = 'failed'; |
| 49 |
const STATUS_POSTED = 'posted'; |
| 50 |
const STATUS_PROCESSING = 'processing'; |
| 51 |
const STATUS_RETURNED = 'returned'; |
| 52 |
|
| 53 |
/** |
| 54 |
* @param null|array $params |
| 55 |
* @param null|array|string $opts |
| 56 |
* |
| 57 |
* @throws \Stripe\Exception\ApiErrorException if the request fails |
| 58 |
* |
| 59 |
* @return \Stripe\Treasury\OutboundTransfer the canceled outbound transfer |
| 60 |
*/ |
| 61 |
public function cancel($params = null, $opts = null) |
| 62 |
{ |
| 63 |
$url = $this->instanceUrl() . '/cancel'; |
| 64 |
list($response, $opts) = $this->_request('post', $url, $params, $opts); |
| 65 |
$this->refreshFrom($response, $opts); |
| 66 |
|
| 67 |
return $this; |
| 68 |
} |
| 69 |
} |
| 70 |
|
