| 1 |
<?php |
| 2 |
|
| 3 |
// File generated from our OpenAPI spec |
| 4 |
|
| 5 |
namespace Stripe\Treasury; |
| 6 |
|
| 7 |
/** |
| 8 |
* Use <a |
| 9 |
* href="https://stripe.com/docs/treasury/moving-money/financial-accounts/into/inbound-transfers">InboundTransfers</a> |
| 10 |
* to add funds to your <a |
| 11 |
* href="https://stripe.com/docs/api#financial_accounts">FinancialAccount</a> via a |
| 12 |
* PaymentMethod that is owned by you. The funds will be transferred via an ACH |
| 13 |
* debit. |
| 14 |
* |
| 15 |
* @property string $id Unique identifier for the object. |
| 16 |
* @property string $object String representing the object's type. Objects of the same type share the same value. |
| 17 |
* @property int $amount Amount (in cents) transferred. |
| 18 |
* @property bool $cancelable Returns <code>true</code> if the InboundTransfer is able to be canceled. |
| 19 |
* @property int $created Time at which the object was created. Measured in seconds since the Unix epoch. |
| 20 |
* @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>. |
| 21 |
* @property null|string $description An arbitrary string attached to the object. Often useful for displaying to users. |
| 22 |
* @property null|\Stripe\StripeObject $failure_details Details about this InboundTransfer's failure. Only set when status is <code>failed</code>. |
| 23 |
* @property string $financial_account The FinancialAccount that received the funds. |
| 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 \Stripe\StripeObject $linked_flows |
| 26 |
* @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. |
| 27 |
* @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. |
| 28 |
* @property string $origin_payment_method The origin payment method to be debited for an InboundTransfer. |
| 29 |
* @property null|\Stripe\StripeObject $origin_payment_method_details Details about the PaymentMethod for an InboundTransfer. |
| 30 |
* @property null|bool $returned Returns <code>true</code> if the funds for an InboundTransfer were returned after the InboundTransfer went to the <code>succeeded</code> state. |
| 31 |
* @property string $statement_descriptor Statement descriptor shown when funds are debited from the source. Not all payment networks support <code>statement_descriptor</code>. |
| 32 |
* @property string $status Status of the InboundTransfer: <code>processing</code>, <code>succeeded</code>, <code>failed</code>, and <code>canceled</code>. An InboundTransfer is <code>processing</code> if it is created and pending. The status changes to <code>succeeded</code> once the funds have been "confirmed" and a <code>transaction</code> is created and posted. The status changes to <code>failed</code> if the transfer fails. |
| 33 |
* @property \Stripe\StripeObject $status_transitions |
| 34 |
* @property null|string|\Stripe\Treasury\Transaction $transaction The Transaction associated with this object. |
| 35 |
*/ |
| 36 |
class InboundTransfer extends \Stripe\ApiResource |
| 37 |
{ |
| 38 |
const OBJECT_NAME = 'treasury.inbound_transfer'; |
| 39 |
|
| 40 |
use \Stripe\ApiOperations\All; |
| 41 |
use \Stripe\ApiOperations\Create; |
| 42 |
use \Stripe\ApiOperations\Retrieve; |
| 43 |
|
| 44 |
const STATUS_CANCELED = 'canceled'; |
| 45 |
const STATUS_FAILED = 'failed'; |
| 46 |
const STATUS_PROCESSING = 'processing'; |
| 47 |
const STATUS_SUCCEEDED = 'succeeded'; |
| 48 |
|
| 49 |
/** |
| 50 |
* @param null|array $params |
| 51 |
* @param null|array|string $opts |
| 52 |
* |
| 53 |
* @throws \Stripe\Exception\ApiErrorException if the request fails |
| 54 |
* |
| 55 |
* @return \Stripe\Treasury\InboundTransfer the canceled inbound transfer |
| 56 |
*/ |
| 57 |
public function cancel($params = null, $opts = null) |
| 58 |
{ |
| 59 |
$url = $this->instanceUrl() . '/cancel'; |
| 60 |
list($response, $opts) = $this->_request('post', $url, $params, $opts); |
| 61 |
$this->refreshFrom($response, $opts); |
| 62 |
|
| 63 |
return $this; |
| 64 |
} |
| 65 |
} |
| 66 |
|
