Skip to content

Commit

Permalink
Update generated code for v551
Browse files Browse the repository at this point in the history
  • Loading branch information
stripe-openapi[bot] committed Sep 25, 2023
1 parent e292740 commit a87c72f
Show file tree
Hide file tree
Showing 3 changed files with 38 additions and 38 deletions.
2 changes: 1 addition & 1 deletion OPENAPI_VERSION
Original file line number Diff line number Diff line change
@@ -1 +1 @@
v550
v551
28 changes: 14 additions & 14 deletions lib/Payout.php
Original file line number Diff line number Diff line change
Expand Up @@ -8,34 +8,34 @@
* A <code>Payout</code> object is created when you receive funds from Stripe, or when you
* initiate a payout to either a bank account or debit card of a <a href="/docs/connect/bank-debit-card-payouts">connected
* Stripe account</a>. You can retrieve individual payouts,
* as well as list all payouts. Payouts are made on <a href="/docs/connect/manage-payout-schedule">varying
* and list all payouts. Payouts are made on <a href="/docs/connect/manage-payout-schedule">varying
* schedules</a>, depending on your country and
* industry.
*
* Related guide: <a href="https://stripe.com/docs/payouts">Receiving payouts</a>
*
* @property string $id Unique identifier for the object.
* @property string $object String representing the object's type. Objects of the same type share the same value.
* @property int $amount Amount (in cents (or local equivalent)) to be transferred to your bank account or debit card.
* @property int $arrival_date Date the payout is expected to arrive in the bank. This factors in delays like weekends or bank holidays.
* @property bool $automatic Returns <code>true</code> if the payout was created by an <a href="https://stripe.com/docs/payouts#payout-schedule">automated payout schedule</a>, and <code>false</code> if it was <a href="https://stripe.com/docs/payouts#manual-payouts">requested manually</a>.
* @property int $amount The amount (in cents (or local equivalent)) that transfers to your bank account or debit card.
* @property int $arrival_date Date that you can expect the payout to arrive in the bank. This factors in delays to account for weekends or bank holidays.
* @property bool $automatic Returns <code>true</code> if the payout is created by an <a href="https://stripe.com/docs/payouts#payout-schedule">automated payout schedule</a> and <code>false</code> if it's <a href="https://stripe.com/docs/payouts#manual-payouts">requested manually</a>.
* @property null|string|\Stripe\BalanceTransaction $balance_transaction ID of the balance transaction that describes the impact of this payout on your account balance.
* @property int $created Time at which the object was created. Measured in seconds since the Unix epoch.
* @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>.
* @property null|string $description An arbitrary string attached to the object. Often useful for displaying to users.
* @property null|string|\Stripe\BankAccount|\Stripe\Card $destination ID of the bank account or card the payout was sent to.
* @property null|string|\Stripe\BalanceTransaction $failure_balance_transaction If the payout failed or was canceled, this will be the ID of the balance transaction that reversed the initial balance transaction, and puts the funds from the failed payout back in your balance.
* @property null|string $failure_code Error code explaining reason for payout failure if available. See <a href="https://stripe.com/docs/api#payout_failures">Types of payout failures</a> for a list of failure codes.
* @property null|string $failure_message Message to user further explaining reason for payout failure if available.
* @property null|string|\Stripe\BankAccount|\Stripe\Card $destination ID of the bank account or card the payout is sent to.
* @property null|string|\Stripe\BalanceTransaction $failure_balance_transaction If the payout fails or cancels, this is the ID of the balance transaction that reverses the initial balance transaction and returns the funds from the failed payout back in your balance.
* @property null|string $failure_code Error code that provides a reason for a payout failure, if available. View our <a href="https://stripe.com/docs/api#payout_failures">list of failure codes</a>.
* @property null|string $failure_message Message that provides the reason for a payout failure, if available.
* @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.
* @property null|\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.
* @property string $method The method used to send this payout, which can be <code>standard</code> or <code>instant</code>. <code>instant</code> is supported for payouts to debit cards and bank accounts in certain countries. (See <a href="https://stripe.com/docs/payouts/instant-payouts-banks">Bank support for Instant Payouts</a> for more information.)
* @property string $method The method used to send this payout, which can be <code>standard</code> or <code>instant</code>. <code>instant</code> is supported for payouts to debit cards and bank accounts in certain countries. Learn more about <a href="https://stripe.com/docs/payouts/instant-payouts-banks">bank support for Instant Payouts</a>.
* @property null|string|\Stripe\Payout $original_payout If the payout reverses another, this is the ID of the original payout.
* @property string $reconciliation_status If <code>completed</code>, the <a href="https://stripe.com/docs/api/balance_transactions/list#balance_transaction_list-payout">Balance Transactions API</a> may be used to list all Balance Transactions that were paid out in this payout.
* @property null|string|\Stripe\Payout $reversed_by If the payout was reversed, this is the ID of the payout that reverses this payout.
* @property string $source_type The source balance this payout came from. One of <code>card</code>, <code>fpx</code>, or <code>bank_account</code>.
* @property null|string $statement_descriptor Extra information about a payout to be displayed on the user's bank statement.
* @property string $status Current status of the payout: <code>paid</code>, <code>pending</code>, <code>in_transit</code>, <code>canceled</code> or <code>failed</code>. A payout is <code>pending</code> until it is submitted to the bank, when it becomes <code>in_transit</code>. The status then changes to <code>paid</code> if the transaction goes through, or to <code>failed</code> or <code>canceled</code> (within 5 business days). Some failed payouts may initially show as <code>paid</code> but then change to <code>failed</code>.
* @property string $reconciliation_status If <code>completed</code>, you can use the <a href="https://stripe.com/docs/api/balance_transactions/list#balance_transaction_list-payout">Balance Transactions API</a> to list all balance transactions that are paid out in this payout.
* @property null|string|\Stripe\Payout $reversed_by If the payout reverses, this is the ID of the payout that reverses this payout.
* @property string $source_type The source balance this payout came from, which can be one of the following: <code>card</code>, <code>fpx</code>, or <code>bank_account</code>.
* @property null|string $statement_descriptor Extra information about a payout that displays on the user's bank statement.
* @property string $status Current status of the payout: <code>paid</code>, <code>pending</code>, <code>in_transit</code>, <code>canceled</code> or <code>failed</code>. A payout is <code>pending</code> until it's submitted to the bank, when it becomes <code>in_transit</code>. The status changes to <code>paid</code> if the transaction succeeds, or to <code>failed</code> or <code>canceled</code> (within 5 business days). Some payouts that fail might initially show as <code>paid</code>, then change to <code>failed</code>.
* @property string $type Can be <code>bank_account</code> or <code>card</code>.
*/
class Payout extends ApiResource
Expand Down
46 changes: 23 additions & 23 deletions lib/Service/PayoutService.php
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,8 @@
class PayoutService extends \Stripe\Service\AbstractService
{
/**
* Returns a list of existing payouts sent to third-party bank accounts or that
* Stripe has sent you. The payouts are returned in sorted order, with the most
* Returns a list of existing payouts sent to third-party bank accounts or payouts
* that Stripe sent to you. The payouts return in sorted order, with the most
* recently created payouts appearing first.
*
* @param null|array $params
Expand All @@ -24,8 +24,8 @@ public function all($params = null, $opts = null)
}

/**
* A previously created payout can be canceled if it has not yet been paid out.
* Funds will be refunded to your available balance. You may not cancel automatic
* You can cancel a previously created payout if it hasn’t been paid out yet.
* Stripe refunds the funds to your available balance. You can’t cancel automatic
* Stripe payouts.
*
* @param string $id
Expand All @@ -42,17 +42,17 @@ public function cancel($id, $params = null, $opts = null)
}

/**
* To send funds to your own bank account, you create a new payout object. Your <a
* href="#balance">Stripe balance</a> must be able to cover the payout amount, or
* you’ll receive an “Insufficient Funds” error.
* To send funds to your own bank account, create a new payout object. Your <a
* href="#balance">Stripe balance</a> must cover the payout amount. If it doesn’t,
* you receive an “Insufficient Funds” error.
*
* If your API key is in test mode, money won’t actually be sent, though everything
* else will occur as if in live mode.
* If your API key is in test mode, money won’t actually be sent, though every
* other action occurs as if you’re in live mode.
*
* If you are creating a manual payout on a Stripe account that uses multiple
* payment source types, you’ll need to specify the source type balance that the
* payout should draw from. The <a href="#balance_object">balance object</a>
* details available and pending amounts by source type.
* If you create a manual payout on a Stripe account that uses multiple payment
* source types, you need to specify the source type balance that the payout draws
* from. The <a href="#balance_object">balance object</a> details available and
* pending amounts by source type.
*
* @param null|array $params
* @param null|array|\Stripe\Util\RequestOptions $opts
Expand All @@ -68,7 +68,7 @@ public function create($params = null, $opts = null)

/**
* Retrieves the details of an existing payout. Supply the unique payout ID from
* either a payout creation request or the payout list, and Stripe will return the
* either a payout creation request or the payout list. Stripe returns the
* corresponding payout information.
*
* @param string $id
Expand All @@ -85,14 +85,14 @@ public function retrieve($id, $params = null, $opts = null)
}

/**
* Reverses a payout by debiting the destination bank account. Only payouts for
* connected accounts to US bank accounts may be reversed at this time. If the
* payout is in the <code>pending</code> status,
* <code>/v1/payouts/:id/cancel</code> should be used instead.
* Reverses a payout by debiting the destination bank account. At this time, you
* can only reverse payouts for connected accounts to US bank accounts. If the
* payout is in the <code>pending</code> status, use
* <code>/v1/payouts/:id/cancel</code> instead.
*
* By requesting a reversal via <code>/v1/payouts/:id/reverse</code>, you confirm
* that the authorized signatory of the selected bank account has authorized the
* debit on the bank account and that no other authorization is required.
* By requesting a reversal through <code>/v1/payouts/:id/reverse</code>, you
* confirm that the authorized signatory of the selected bank account authorizes
* the debit on the bank account and that no other authorization is required.
*
* @param string $id
* @param null|array $params
Expand All @@ -108,8 +108,8 @@ public function reverse($id, $params = null, $opts = null)
}

/**
* Updates the specified payout by setting the values of the parameters passed. Any
* parameters not provided will be left unchanged. This request accepts only the
* Updates the specified payout by setting the values of the parameters you pass.
* We don’t change parameters that you don’t provide. This request only accepts the
* metadata as arguments.
*
* @param string $id
Expand Down

0 comments on commit a87c72f

Please sign in to comment.