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
OutboundPayment.php
113 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-payments">OutboundPayments</a> to send funds to another party's external bank account or <a href="https://stripe.com/docs/api#financial_accounts">FinancialAccount</a>. To send money to an account belonging to the same user, use an <a href="https://stripe.com/docs/api#outbound_transfers">OutboundTransfer</a>. |
| 8 | * |
| 9 | * Simulate OutboundPayment state changes with the <code>/v1/test_helpers/treasury/outbound_payments</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-payments">Moving money with Treasury using OutboundPayment 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 $customer ID of the <a href="https://stripe.com/docs/api/customers">customer</a> to whom an OutboundPayment is sent. |
| 20 | * @property null|string $description An arbitrary string attached to the object. Often useful for displaying to users. |
| 21 | * @property null|string $destination_payment_method The PaymentMethod via which an OutboundPayment is sent. This field can be empty if the OutboundPayment was created using <code>destination_payment_method_data</code>. |
| 22 | * @property null|\Stripe\StripeObject $destination_payment_method_details Details about the PaymentMethod for an OutboundPayment. |
| 23 | * @property null|\Stripe\StripeObject $end_user_details Details about the end user. |
| 24 | * @property int $expected_arrival_date The date when funds are expected to arrive in the destination account. |
| 25 | * @property string $financial_account The FinancialAccount that funds were pulled from. |
| 26 | * @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. |
| 27 | * @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. |
| 28 | * @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. |
| 29 | * @property null|\Stripe\StripeObject $returned_details Details about a returned OutboundPayment. Only set when the status is <code>returned</code>. |
| 30 | * @property string $statement_descriptor The description that appears on the receiving end for an OutboundPayment (for example, bank statement for external bank transfer). |
| 31 | * @property string $status Current status of the OutboundPayment: <code>processing</code>, <code>failed</code>, <code>posted</code>, <code>returned</code>, <code>canceled</code>. An OutboundPayment is <code>processing</code> if it has been created and is pending. The status changes to <code>posted</code> once the OutboundPayment has been "confirmed" and funds have left the account, or to <code>failed</code> or <code>canceled</code>. If an OutboundPayment fails to arrive at its destination, its status will change to <code>returned</code>. |
| 32 | * @property \Stripe\StripeObject $status_transitions |
| 33 | * @property null|\Stripe\StripeObject $tracking_details Details about network-specific tracking information if available. |
| 34 | * @property string|\Stripe\Treasury\Transaction $transaction The Transaction associated with this object. |
| 35 | */ |
| 36 | class OutboundPayment extends \ProfilePressVendor\Stripe\ApiResource |
| 37 | { |
| 38 | const OBJECT_NAME = 'treasury.outbound_payment'; |
| 39 | const STATUS_CANCELED = 'canceled'; |
| 40 | const STATUS_FAILED = 'failed'; |
| 41 | const STATUS_POSTED = 'posted'; |
| 42 | const STATUS_PROCESSING = 'processing'; |
| 43 | const STATUS_RETURNED = 'returned'; |
| 44 | /** |
| 45 | * Creates an OutboundPayment. |
| 46 | * |
| 47 | * @param null|array $params |
| 48 | * @param null|array|string $options |
| 49 | * |
| 50 | * @throws \Stripe\Exception\ApiErrorException if the request fails |
| 51 | * |
| 52 | * @return \Stripe\Treasury\OutboundPayment the created resource |
| 53 | */ |
| 54 | public static function create($params = null, $options = null) |
| 55 | { |
| 56 | self::_validateParams($params); |
| 57 | $url = static::classUrl(); |
| 58 | list($response, $opts) = static::_staticRequest('post', $url, $params, $options); |
| 59 | $obj = \ProfilePressVendor\Stripe\Util\Util::convertToStripeObject($response->json, $opts); |
| 60 | $obj->setLastResponse($response); |
| 61 | return $obj; |
| 62 | } |
| 63 | /** |
| 64 | * Returns a list of OutboundPayments sent from the specified FinancialAccount. |
| 65 | * |
| 66 | * @param null|array $params |
| 67 | * @param null|array|string $opts |
| 68 | * |
| 69 | * @throws \Stripe\Exception\ApiErrorException if the request fails |
| 70 | * |
| 71 | * @return \Stripe\Collection<\Stripe\Treasury\OutboundPayment> of ApiResources |
| 72 | */ |
| 73 | public static function all($params = null, $opts = null) |
| 74 | { |
| 75 | $url = static::classUrl(); |
| 76 | return static::_requestPage($url, \ProfilePressVendor\Stripe\Collection::class, $params, $opts); |
| 77 | } |
| 78 | /** |
| 79 | * Retrieves the details of an existing OutboundPayment by passing the unique |
| 80 | * OutboundPayment ID from either the OutboundPayment creation request or |
| 81 | * OutboundPayment list. |
| 82 | * |
| 83 | * @param array|string $id the ID of the API resource to retrieve, or an options array containing an `id` key |
| 84 | * @param null|array|string $opts |
| 85 | * |
| 86 | * @throws \Stripe\Exception\ApiErrorException if the request fails |
| 87 | * |
| 88 | * @return \Stripe\Treasury\OutboundPayment |
| 89 | */ |
| 90 | public static function retrieve($id, $opts = null) |
| 91 | { |
| 92 | $opts = \ProfilePressVendor\Stripe\Util\RequestOptions::parse($opts); |
| 93 | $instance = new static($id, $opts); |
| 94 | $instance->refresh(); |
| 95 | return $instance; |
| 96 | } |
| 97 | /** |
| 98 | * @param null|array $params |
| 99 | * @param null|array|string $opts |
| 100 | * |
| 101 | * @throws \Stripe\Exception\ApiErrorException if the request fails |
| 102 | * |
| 103 | * @return \Stripe\Treasury\OutboundPayment the canceled outbound payment |
| 104 | */ |
| 105 | public function cancel($params = null, $opts = null) |
| 106 | { |
| 107 | $url = $this->instanceUrl() . '/cancel'; |
| 108 | list($response, $opts) = $this->_request('post', $url, $params, $opts); |
| 109 | $this->refreshFrom($response, $opts); |
| 110 | return $this; |
| 111 | } |
| 112 | } |
| 113 |