Resources/Stripe/Stripe/Payout.php

<?php declare(strict_types=1);

// File generated from our OpenAPI spec

namespace Stripe;

/**
 * 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 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 %s) 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 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 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 only supported for payouts to debit cards. (See <a href="https://stripe.com/blog/instant-payouts-for-marketplaces">Instant payouts for marketplaces</a> for more information.)
 * @property null|string|\Stripe\Payout                   $original_payout             If the payout reverses another, this is the ID of the original 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                                       $type                        Can be <code>bank_account</code> or <code>card</code>.
 */
class Payout extends ApiResource
{
    public const OBJECT_NAME = 'payout';

    use ApiOperations\All;
    use ApiOperations\Create;
    use ApiOperations\Retrieve;
    use ApiOperations\Update;

    public const FAILURE_ACCOUNT_CLOSED = 'account_closed';

    public const FAILURE_ACCOUNT_FROZEN = 'account_frozen';

    public const FAILURE_BANK_ACCOUNT_RESTRICTED = 'bank_account_restricted';

    public const FAILURE_BANK_OWNERSHIP_CHANGED = 'bank_ownership_changed';

    public const FAILURE_COULD_NOT_PROCESS = 'could_not_process';

    public const FAILURE_DEBIT_NOT_AUTHORIZED = 'debit_not_authorized';

    public const FAILURE_DECLINED = 'declined';

    public const FAILURE_INCORRECT_ACCOUNT_HOLDER_ADDRESS = 'incorrect_account_holder_address';

    public const FAILURE_INCORRECT_ACCOUNT_HOLDER_NAME = 'incorrect_account_holder_name';

    public const FAILURE_INCORRECT_ACCOUNT_HOLDER_TAX_ID = 'incorrect_account_holder_tax_id';

    public const FAILURE_INSUFFICIENT_FUNDS = 'insufficient_funds';

    public const FAILURE_INVALID_ACCOUNT_NUMBER = 'invalid_account_number';

    public const FAILURE_INVALID_CURRENCY = 'invalid_currency';

    public const FAILURE_NO_ACCOUNT = 'no_account';

    public const FAILURE_UNSUPPORTED_CARD = 'unsupported_card';

    public const METHOD_INSTANT = 'instant';

    public const METHOD_STANDARD = 'standard';

    public const STATUS_CANCELED = 'canceled';

    public const STATUS_FAILED = 'failed';

    public const STATUS_IN_TRANSIT = 'in_transit';

    public const STATUS_PAID = 'paid';

    public const STATUS_PENDING = 'pending';

    public const TYPE_BANK_ACCOUNT = 'bank_account';

    public const TYPE_CARD = '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;
    }
}