<?php
// File generated from our OpenAPI spec
namespace Stripe\StripeTaxForWooCommerce\SDK\lib;
/**
* Refund objects allow you to refund a previously created charge that isn't
* refunded yet. Funds are refunded to the credit or debit card that's
* initially charged.
*
* Related guide: <a href="https://stripe.com/docs/refunds">Refunds</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).
* @property null|string|\Stripe\StripeTaxForWooCommerce\SDK\lib\BalanceTransaction $balance_transaction Balance transaction that describes the impact on your account balance.
* @property null|string|\Stripe\StripeTaxForWooCommerce\SDK\lib\Charge $charge ID of the charge that's refunded.
* @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. You can use this for displaying to users (available on non-card refunds only).
* @property null|\Stripe\StripeTaxForWooCommerce\SDK\lib\StripeObject $destination_details
* @property null|string|\Stripe\StripeTaxForWooCommerce\SDK\lib\BalanceTransaction $failure_balance_transaction After the refund fails, this balance transaction describes the adjustment made on your account balance that reverses the initial balance transaction.
* @property null|string $failure_reason Provides the reason for the refund failure. Possible values are: <code>lost_or_stolen_card</code>, <code>expired_or_canceled_card</code>, <code>charge_for_pending_refund_disputed</code>, <code>insufficient_funds</code>, <code>declined</code>, <code>merchant_request</code>, or <code>unknown</code>.
* @property null|string $instructions_email For payment methods without native refund support (for example, Konbini, PromptPay), provide an email address for the customer to receive refund instructions.
* @property null|\Stripe\StripeTaxForWooCommerce\SDK\lib\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 null|\Stripe\StripeTaxForWooCommerce\SDK\lib\StripeObject $next_action
* @property null|string|\Stripe\StripeTaxForWooCommerce\SDK\lib\PaymentIntent $payment_intent ID of the PaymentIntent that's refunded.
* @property null|string $reason Reason for the refund, which is either user-provided (<code>duplicate</code>, <code>fraudulent</code>, or <code>requested_by_customer</code>) or generated by Stripe\StripeTaxForWooCommerce\SDK\lib internally (<code>expired_uncaptured_charge</code>).
* @property null|string $receipt_number This is the transaction number that appears on email receipts sent for this refund.
* @property null|string|\Stripe\StripeTaxForWooCommerce\SDK\lib\TransferReversal $source_transfer_reversal The transfer reversal that's associated with the refund. Only present if the charge came from another Stripe\StripeTaxForWooCommerce\SDK\lib account.
* @property null|string $status Status of the refund. This can be <code>pending</code>, <code>requires_action</code>, <code>succeeded</code>, <code>failed</code>, or <code>canceled</code>. Learn more about <a href="https://stripe.com/docs/refunds#failed-refunds">failed refunds</a>.
* @property null|string|\Stripe\StripeTaxForWooCommerce\SDK\lib\TransferReversal $transfer_reversal This refers to the transfer reversal object if the accompanying transfer reverses. This is only applicable if the charge was created using the destination parameter.
*/
class Refund extends ApiResource {
const OBJECT_NAME = 'refund';
use ApiOperations\All;
use ApiOperations\Create;
use ApiOperations\Retrieve;
use ApiOperations\Update;
const FAILURE_REASON_EXPIRED_OR_CANCELED_CARD = 'expired_or_canceled_card';
const FAILURE_REASON_LOST_OR_STOLEN_CARD = 'lost_or_stolen_card';
const FAILURE_REASON_UNKNOWN = 'unknown';
const REASON_DUPLICATE = 'duplicate';
const REASON_EXPIRED_UNCAPTURED_CHARGE = 'expired_uncaptured_charge';
const REASON_FRAUDULENT = 'fraudulent';
const REASON_REQUESTED_BY_CUSTOMER = 'requested_by_customer';
const STATUS_CANCELED = 'canceled';
const STATUS_FAILED = 'failed';
const STATUS_PENDING = 'pending';
const STATUS_REQUIRES_ACTION = 'requires_action';
const STATUS_SUCCEEDED = 'succeeded';
/**
* @param null|array $params
* @param null|array|string $opts
*
* @return \Stripe\StripeTaxForWooCommerce\SDK\lib\Refund the canceled refund
* @throws \Stripe\StripeTaxForWooCommerce\SDK\lib\Exception\ApiErrorException if the request fails
*/
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;
}
}