CreditReversal.php
2 months ago
DebitReversal.php
2 months ago
FinancialAccount.php
2 months ago
FinancialAccountFeatures.php
2 months ago
InboundTransfer.php
2 months ago
OutboundPayment.php
2 months ago
OutboundTransfer.php
2 months ago
ReceivedCredit.php
2 months ago
ReceivedDebit.php
2 months ago
Transaction.php
2 months ago
TransactionEntry.php
2 months ago
OutboundTransfer.php
111 lines
| 1 | <?php |
| 2 | |
| 3 | // File generated from our OpenAPI spec |
| 4 | namespace ProfilePressVendor\Stripe\Treasury; |
| 5 | |
| 6 | /** |
| 7 | * Use <a href="https://docs.stripe.com/docs/treasury/moving-money/financial-accounts/out-of/outbound-transfers">OutboundTransfers</a> to transfer funds from a <a href="https://stripe.com/docs/api#financial_accounts">FinancialAccount</a> to a PaymentMethod belonging to the same entity. To send funds to a different party, use <a href="https://stripe.com/docs/api#outbound_payments">OutboundPayments</a> instead. You can send funds over ACH rails or through a domestic wire transfer to a user's own external bank account. |
| 8 | * |
| 9 | * Simulate OutboundTransfer state changes with the <code>/v1/test_helpers/treasury/outbound_transfers</code> endpoints. These methods can only be called on test mode objects. |
| 10 | * |
| 11 | * Related guide: <a href="https://docs.stripe.com/docs/treasury/moving-money/financial-accounts/out-of/outbound-transfers">Moving money with Treasury using OutboundTransfer objects</a> |
| 12 | * |
| 13 | * @property string $id Unique identifier for the object. |
| 14 | * @property string $object String representing the object's type. Objects of the same type share the same value. |
| 15 | * @property int $amount Amount (in cents) transferred. |
| 16 | * @property bool $cancelable Returns <code>true</code> if the object can be canceled, and <code>false</code> otherwise. |
| 17 | * @property int $created Time at which the object was created. Measured in seconds since the Unix epoch. |
| 18 | * @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>. |
| 19 | * @property null|string $description An arbitrary string attached to the object. Often useful for displaying to users. |
| 20 | * @property null|string $destination_payment_method The PaymentMethod used as the payment instrument for an OutboundTransfer. |
| 21 | * @property \Stripe\StripeObject $destination_payment_method_details |
| 22 | * @property int $expected_arrival_date The date when funds are expected to arrive in the destination account. |
| 23 | * @property string $financial_account The FinancialAccount that funds were pulled from. |
| 24 | * @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. |
| 25 | * @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. |
| 26 | * @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. |
| 27 | * @property null|\Stripe\StripeObject $returned_details Details about a returned OutboundTransfer. Only set when the status is <code>returned</code>. |
| 28 | * @property string $statement_descriptor Information about the OutboundTransfer to be sent to the recipient account. |
| 29 | * @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>. |
| 30 | * @property \Stripe\StripeObject $status_transitions |
| 31 | * @property null|\Stripe\StripeObject $tracking_details Details about network-specific tracking information if available. |
| 32 | * @property string|\Stripe\Treasury\Transaction $transaction The Transaction associated with this object. |
| 33 | */ |
| 34 | class OutboundTransfer extends \ProfilePressVendor\Stripe\ApiResource |
| 35 | { |
| 36 | const OBJECT_NAME = 'treasury.outbound_transfer'; |
| 37 | const STATUS_CANCELED = 'canceled'; |
| 38 | const STATUS_FAILED = 'failed'; |
| 39 | const STATUS_POSTED = 'posted'; |
| 40 | const STATUS_PROCESSING = 'processing'; |
| 41 | const STATUS_RETURNED = 'returned'; |
| 42 | /** |
| 43 | * Creates an OutboundTransfer. |
| 44 | * |
| 45 | * @param null|array $params |
| 46 | * @param null|array|string $options |
| 47 | * |
| 48 | * @throws \Stripe\Exception\ApiErrorException if the request fails |
| 49 | * |
| 50 | * @return \Stripe\Treasury\OutboundTransfer the created resource |
| 51 | */ |
| 52 | public static function create($params = null, $options = null) |
| 53 | { |
| 54 | self::_validateParams($params); |
| 55 | $url = static::classUrl(); |
| 56 | list($response, $opts) = static::_staticRequest('post', $url, $params, $options); |
| 57 | $obj = \ProfilePressVendor\Stripe\Util\Util::convertToStripeObject($response->json, $opts); |
| 58 | $obj->setLastResponse($response); |
| 59 | return $obj; |
| 60 | } |
| 61 | /** |
| 62 | * Returns a list of OutboundTransfers sent from the specified FinancialAccount. |
| 63 | * |
| 64 | * @param null|array $params |
| 65 | * @param null|array|string $opts |
| 66 | * |
| 67 | * @throws \Stripe\Exception\ApiErrorException if the request fails |
| 68 | * |
| 69 | * @return \Stripe\Collection<\Stripe\Treasury\OutboundTransfer> of ApiResources |
| 70 | */ |
| 71 | public static function all($params = null, $opts = null) |
| 72 | { |
| 73 | $url = static::classUrl(); |
| 74 | return static::_requestPage($url, \ProfilePressVendor\Stripe\Collection::class, $params, $opts); |
| 75 | } |
| 76 | /** |
| 77 | * Retrieves the details of an existing OutboundTransfer by passing the unique |
| 78 | * OutboundTransfer ID from either the OutboundTransfer creation request or |
| 79 | * OutboundTransfer list. |
| 80 | * |
| 81 | * @param array|string $id the ID of the API resource to retrieve, or an options array containing an `id` key |
| 82 | * @param null|array|string $opts |
| 83 | * |
| 84 | * @throws \Stripe\Exception\ApiErrorException if the request fails |
| 85 | * |
| 86 | * @return \Stripe\Treasury\OutboundTransfer |
| 87 | */ |
| 88 | public static function retrieve($id, $opts = null) |
| 89 | { |
| 90 | $opts = \ProfilePressVendor\Stripe\Util\RequestOptions::parse($opts); |
| 91 | $instance = new static($id, $opts); |
| 92 | $instance->refresh(); |
| 93 | return $instance; |
| 94 | } |
| 95 | /** |
| 96 | * @param null|array $params |
| 97 | * @param null|array|string $opts |
| 98 | * |
| 99 | * @throws \Stripe\Exception\ApiErrorException if the request fails |
| 100 | * |
| 101 | * @return \Stripe\Treasury\OutboundTransfer the canceled outbound transfer |
| 102 | */ |
| 103 | public function cancel($params = null, $opts = null) |
| 104 | { |
| 105 | $url = $this->instanceUrl() . '/cancel'; |
| 106 | list($response, $opts) = $this->_request('post', $url, $params, $opts); |
| 107 | $this->refreshFrom($response, $opts); |
| 108 | return $this; |
| 109 | } |
| 110 | } |
| 111 |