| name file | size | edit | permission | action |
|---|---|---|---|---|
| .env | 2733 KB | December 22 2024 06:20:07 | 0644 | |
| 404.html | 58370 KB | November 20 2024 15:32:22 | 0644 | |
| 502.html | 58368 KB | November 20 2024 15:32:22 | 0644 | |
| Modules | - | December 11 2024 21:02:56 | 0755 | |
| README.md | 4158 KB | February 14 2023 12:31:56 | 0644 | |
| app | - | December 11 2024 17:57:48 | 0755 | |
| artisan | 1686 KB | February 14 2023 12:31:56 | 0644 | |
| bootstrap | - | December 11 2024 20:23:36 | 0755 | |
| composer.json | 3761 KB | December 11 2024 22:15:00 | 0644 | |
| composer.lock | 512048 KB | December 11 2024 22:13:28 | 0644 | |
| config | - | June 15 2025 02:09:36 | 0755 | |
| database | - | December 05 2024 20:18:12 | 0755 | |
| dfsdf dfds fd fds findex.html | 1420 KB | November 20 2024 15:32:24 | 0644 | |
| error_log | 19153511 KB | July 18 2025 20:11:53 | 0644 | |
| firoz | - | December 23 2024 13:24:46 | 0755 | |
| index.php | 1667 KB | December 14 2024 05:20:36 | 0644 | |
| lang | - | December 11 2024 21:02:48 | 0755 | |
| modules_statuses.json | 472 KB | November 20 2024 15:32:24 | 0644 | |
| mpos | - | March 31 2025 02:36:31 | 0755 | |
| package.json | 226 KB | February 14 2023 12:31:56 | 0644 | |
| phpunit.xml | 1146 KB | February 14 2023 12:31:56 | 0644 | |
| public | - | March 31 2025 02:36:31 | 0755 | |
| resources | - | December 11 2024 21:10:22 | 0755 | |
| routes | - | June 15 2025 02:09:31 | 0755 | |
| storage | - | December 11 2024 21:12:44 | 0755 | |
| tests | - | December 05 2024 20:18:12 | 0755 | |
| vendor | - | December 11 2024 22:13:30 | 0755 | |
| vite.config.js | 263 KB | February 14 2023 12:31:56 | 0644 |
true if the payout is created by an automated payout schedule and false if it's requested manually.
* @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 ISO currency code, in lowercase. Must be a supported currency.
* @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 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 list of failure codes.
* @property null|string $failure_message Message that provides the reason for a payout failure, if available.
* @property bool $livemode Has the value true if the object exists in live mode or the value false if the object exists in test mode.
* @property null|\Stripe\StripeObject $metadata Set of key-value pairs 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 standard or instant. instant is supported for payouts to debit cards and bank accounts in certain countries. Learn more about bank support for Instant Payouts.
* @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 completed, you can use the Balance Transactions API 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: card, fpx, or bank_account.
* @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: paid, pending, in_transit, canceled or failed. A payout is pending until it's submitted to the bank, when it becomes in_transit. The status changes to paid if the transaction succeeds, or to failed or canceled (within 5 business days). Some payouts that fail might initially show as paid, then change to failed.
* @property null|\Stripe\StripeObject $trace_id A value that generates from the beneficiary's bank that allows users to track payouts with their bank. Banks might call this a "reference number" or something similar.
* @property string $type Can be bank_account or card.
*/
class Payout extends ApiResource
{
const OBJECT_NAME = 'payout';
use ApiOperations\Update;
const METHOD_INSTANT = 'instant';
const METHOD_STANDARD = 'standard';
const RECONCILIATION_STATUS_COMPLETED = 'completed';
const RECONCILIATION_STATUS_IN_PROGRESS = 'in_progress';
const RECONCILIATION_STATUS_NOT_APPLICABLE = 'not_applicable';
const STATUS_CANCELED = 'canceled';
const STATUS_FAILED = 'failed';
const STATUS_IN_TRANSIT = 'in_transit';
const STATUS_PAID = 'paid';
const STATUS_PENDING = 'pending';
const TYPE_BANK_ACCOUNT = 'bank_account';
const TYPE_CARD = 'card';
/**
* To send funds to your own bank account, create a new payout object. Your Stripe balance 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 every
* other action occurs as if you’re in live mode.
*
* 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 balance object details available and
* pending amounts by source type.
*
* @param null|array $params
* @param null|array|string $options
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
*
* @return \Stripe\Payout the created resource
*/
public static function create($params = null, $options = null)
{
self::_validateParams($params);
$url = static::classUrl();
list($response, $opts) = static::_staticRequest('post', $url, $params, $options);
$obj = \Stripe\Util\Util::convertToStripeObject($response->json, $opts);
$obj->setLastResponse($response);
return $obj;
}
/**
* 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
* @param null|array|string $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
*
* @return \Stripe\Collection<\Stripe\Payout> of ApiResources
*/
public static function all($params = null, $opts = null)
{
$url = static::classUrl();
return static::_requestPage($url, \Stripe\Collection::class, $params, $opts);
}
/**
* Retrieves the details of an existing payout. Supply the unique payout ID from
* either a payout creation request or the payout list. Stripe returns the
* corresponding payout information.
*
* @param array|string $id the ID of the API resource to retrieve, or an options array containing an `id` key
* @param null|array|string $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
*
* @return \Stripe\Payout
*/
public static function retrieve($id, $opts = null)
{
$opts = \Stripe\Util\RequestOptions::parse($opts);
$instance = new static($id, $opts);
$instance->refresh();
return $instance;
}
/**
* 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 the ID of the resource to update
* @param null|array $params
* @param null|array|string $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
*
* @return \Stripe\Payout the updated resource
*/
public static function update($id, $params = null, $opts = null)
{
self::_validateParams($params);
$url = static::resourceUrl($id);
list($response, $opts) = static::_staticRequest('post', $url, $params, $opts);
$obj = \Stripe\Util\Util::convertToStripeObject($response->json, $opts);
$obj->setLastResponse($response);
return $obj;
}
const FAILURE_ACCOUNT_CLOSED = 'account_closed';
const FAILURE_ACCOUNT_FROZEN = 'account_frozen';
const FAILURE_BANK_ACCOUNT_RESTRICTED = 'bank_account_restricted';
const FAILURE_BANK_OWNERSHIP_CHANGED = 'bank_ownership_changed';
const FAILURE_COULD_NOT_PROCESS = 'could_not_process';
const FAILURE_DEBIT_NOT_AUTHORIZED = 'debit_not_authorized';
const FAILURE_DECLINED = 'declined';
const FAILURE_INCORRECT_ACCOUNT_HOLDER_ADDRESS = 'incorrect_account_holder_address';
const FAILURE_INCORRECT_ACCOUNT_HOLDER_NAME = 'incorrect_account_holder_name';
const FAILURE_INCORRECT_ACCOUNT_HOLDER_TAX_ID = 'incorrect_account_holder_tax_id';
const FAILURE_INSUFFICIENT_FUNDS = 'insufficient_funds';
const FAILURE_INVALID_ACCOUNT_NUMBER = 'invalid_account_number';
const FAILURE_INVALID_CURRENCY = 'invalid_currency';
const FAILURE_NO_ACCOUNT = 'no_account';
const FAILURE_UNSUPPORTED_CARD = 'unsupported_card';
/**
* @param null|array $params
* @param null|array|string $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
*
* @return \Stripe\Payout the canceled payout
*/
public function cancel($params = null, $opts = null)
{
$url = $this->instanceUrl() . '/cancel';
list($response, $opts) = $this->_request('post', $url, $params, $opts);
$this->refreshFrom($response, $opts);
return $this;
}
/**
* @param null|array $params
* @param null|array|string $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
*
* @return \Stripe\Payout the reversed payout
*/
public function reverse($params = null, $opts = null)
{
$url = $this->instanceUrl() . '/reverse';
list($response, $opts) = $this->_request('post', $url, $params, $opts);
$this->refreshFrom($response, $opts);
return $this;
}
}