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
CreditReversal.php
86 lines
| 1 | <?php |
| 2 | |
| 3 | // File generated from our OpenAPI spec |
| 4 | namespace ProfilePressVendor\Stripe\Treasury; |
| 5 | |
| 6 | /** |
| 7 | * You can reverse some <a href="https://stripe.com/docs/api#received_credits">ReceivedCredits</a> depending on their network and source flow. Reversing a ReceivedCredit leads to the creation of a new object known as a CreditReversal. |
| 8 | * |
| 9 | * @property string $id Unique identifier for the object. |
| 10 | * @property string $object String representing the object's type. Objects of the same type share the same value. |
| 11 | * @property int $amount Amount (in cents) transferred. |
| 12 | * @property int $created Time at which the object was created. Measured in seconds since the Unix epoch. |
| 13 | * @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>. |
| 14 | * @property string $financial_account The FinancialAccount to reverse funds from. |
| 15 | * @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. |
| 16 | * @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. |
| 17 | * @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. |
| 18 | * @property string $network The rails used to reverse the funds. |
| 19 | * @property string $received_credit The ReceivedCredit being reversed. |
| 20 | * @property string $status Status of the CreditReversal |
| 21 | * @property \Stripe\StripeObject $status_transitions |
| 22 | * @property null|string|\Stripe\Treasury\Transaction $transaction The Transaction associated with this object. |
| 23 | */ |
| 24 | class CreditReversal extends \ProfilePressVendor\Stripe\ApiResource |
| 25 | { |
| 26 | const OBJECT_NAME = 'treasury.credit_reversal'; |
| 27 | const NETWORK_ACH = 'ach'; |
| 28 | const NETWORK_STRIPE = 'stripe'; |
| 29 | const STATUS_CANCELED = 'canceled'; |
| 30 | const STATUS_POSTED = 'posted'; |
| 31 | const STATUS_PROCESSING = 'processing'; |
| 32 | /** |
| 33 | * Reverses a ReceivedCredit and creates a CreditReversal object. |
| 34 | * |
| 35 | * @param null|array $params |
| 36 | * @param null|array|string $options |
| 37 | * |
| 38 | * @throws \Stripe\Exception\ApiErrorException if the request fails |
| 39 | * |
| 40 | * @return \Stripe\Treasury\CreditReversal the created resource |
| 41 | */ |
| 42 | public static function create($params = null, $options = null) |
| 43 | { |
| 44 | self::_validateParams($params); |
| 45 | $url = static::classUrl(); |
| 46 | list($response, $opts) = static::_staticRequest('post', $url, $params, $options); |
| 47 | $obj = \ProfilePressVendor\Stripe\Util\Util::convertToStripeObject($response->json, $opts); |
| 48 | $obj->setLastResponse($response); |
| 49 | return $obj; |
| 50 | } |
| 51 | /** |
| 52 | * Returns a list of CreditReversals. |
| 53 | * |
| 54 | * @param null|array $params |
| 55 | * @param null|array|string $opts |
| 56 | * |
| 57 | * @throws \Stripe\Exception\ApiErrorException if the request fails |
| 58 | * |
| 59 | * @return \Stripe\Collection<\Stripe\Treasury\CreditReversal> of ApiResources |
| 60 | */ |
| 61 | public static function all($params = null, $opts = null) |
| 62 | { |
| 63 | $url = static::classUrl(); |
| 64 | return static::_requestPage($url, \ProfilePressVendor\Stripe\Collection::class, $params, $opts); |
| 65 | } |
| 66 | /** |
| 67 | * Retrieves the details of an existing CreditReversal by passing the unique |
| 68 | * CreditReversal ID from either the CreditReversal creation request or |
| 69 | * CreditReversal list. |
| 70 | * |
| 71 | * @param array|string $id the ID of the API resource to retrieve, or an options array containing an `id` key |
| 72 | * @param null|array|string $opts |
| 73 | * |
| 74 | * @throws \Stripe\Exception\ApiErrorException if the request fails |
| 75 | * |
| 76 | * @return \Stripe\Treasury\CreditReversal |
| 77 | */ |
| 78 | public static function retrieve($id, $opts = null) |
| 79 | { |
| 80 | $opts = \ProfilePressVendor\Stripe\Util\RequestOptions::parse($opts); |
| 81 | $instance = new static($id, $opts); |
| 82 | $instance->refresh(); |
| 83 | return $instance; |
| 84 | } |
| 85 | } |
| 86 |