CreditReversal.php
6 months ago
DebitReversal.php
6 months ago
FinancialAccount.php
6 months ago
FinancialAccountFeatures.php
6 months ago
InboundTransfer.php
6 months ago
OutboundPayment.php
6 months ago
OutboundTransfer.php
6 months ago
ReceivedCredit.php
6 months ago
ReceivedDebit.php
6 months ago
Transaction.php
6 months ago
TransactionEntry.php
6 months ago
ReceivedCredit.php
81 lines
| 1 | <?php |
| 2 | |
| 3 | // File generated from our OpenAPI spec |
| 4 | |
| 5 | namespace AmeliaVendor\Stripe\Treasury; |
| 6 | |
| 7 | /** |
| 8 | * ReceivedCredits represent funds sent to a <a href="https://stripe.com/docs/api#financial_accounts">FinancialAccount</a> (for example, via ACH or wire). These money movements are not initiated from the FinancialAccount. |
| 9 | * |
| 10 | * @property string $id Unique identifier for the object. |
| 11 | * @property string $object String representing the object's type. Objects of the same type share the same value. |
| 12 | * @property int $amount Amount (in cents) transferred. |
| 13 | * @property int $created Time at which the object was created. Measured in seconds since the Unix epoch. |
| 14 | * @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>. |
| 15 | * @property string $description An arbitrary string attached to the object. Often useful for displaying to users. |
| 16 | * @property null|string $failure_code Reason for the failure. A ReceivedCredit might fail because the receiving FinancialAccount is closed or frozen. |
| 17 | * @property null|string $financial_account The FinancialAccount that received the funds. |
| 18 | * @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. |
| 19 | * @property (object{balance?: string, billing_details: (object{address: (object{city: null|string, country: null|string, line1: null|string, line2: null|string, postal_code: null|string, state: null|string}&\AmeliaVendor\Stripe\StripeObject), email: null|string, name: null|string}&\AmeliaVendor\Stripe\StripeObject), financial_account?: (object{id: string, network: string}&\AmeliaVendor\Stripe\StripeObject), issuing_card?: string, type: string, us_bank_account?: (object{bank_name: null|string, last4: null|string, routing_number: null|string}&\AmeliaVendor\Stripe\StripeObject)}&\AmeliaVendor\Stripe\StripeObject) $initiating_payment_method_details |
| 20 | * @property (object{credit_reversal: null|string, issuing_authorization: null|string, issuing_transaction: null|string, source_flow: null|string, source_flow_details?: null|(object{credit_reversal?: CreditReversal, outbound_payment?: OutboundPayment, outbound_transfer?: OutboundTransfer, payout?: \AmeliaVendor\Stripe\Payout, type: string}&\AmeliaVendor\Stripe\StripeObject), source_flow_type: null|string}&\AmeliaVendor\Stripe\StripeObject) $linked_flows |
| 21 | * @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. |
| 22 | * @property string $network The rails used to send the funds. |
| 23 | * @property null|(object{deadline: null|int, restricted_reason: null|string}&\AmeliaVendor\Stripe\StripeObject) $reversal_details Details describing when a ReceivedCredit may be reversed. |
| 24 | * @property string $status Status of the ReceivedCredit. ReceivedCredits are created either <code>succeeded</code> (approved) or <code>failed</code> (declined). If a ReceivedCredit is declined, the failure reason can be found in the <code>failure_code</code> field. |
| 25 | * @property null|string|Transaction $transaction The Transaction associated with this object. |
| 26 | */ |
| 27 | class ReceivedCredit extends \AmeliaVendor\Stripe\ApiResource |
| 28 | { |
| 29 | const OBJECT_NAME = 'treasury.received_credit'; |
| 30 | |
| 31 | const FAILURE_CODE_ACCOUNT_CLOSED = 'account_closed'; |
| 32 | const FAILURE_CODE_ACCOUNT_FROZEN = 'account_frozen'; |
| 33 | const FAILURE_CODE_INTERNATIONAL_TRANSACTION = 'international_transaction'; |
| 34 | const FAILURE_CODE_OTHER = 'other'; |
| 35 | |
| 36 | const NETWORK_ACH = 'ach'; |
| 37 | const NETWORK_CARD = 'card'; |
| 38 | const NETWORK_STRIPE = 'stripe'; |
| 39 | const NETWORK_US_DOMESTIC_WIRE = 'us_domestic_wire'; |
| 40 | |
| 41 | const STATUS_FAILED = 'failed'; |
| 42 | const STATUS_SUCCEEDED = 'succeeded'; |
| 43 | |
| 44 | /** |
| 45 | * Returns a list of ReceivedCredits. |
| 46 | * |
| 47 | * @param null|array{ending_before?: string, expand?: string[], financial_account: string, limit?: int, linked_flows?: array{source_flow_type: string}, starting_after?: string, status?: string} $params |
| 48 | * @param null|array|string $opts |
| 49 | * |
| 50 | * @return \AmeliaVendor\Stripe\Collection<ReceivedCredit> of ApiResources |
| 51 | * |
| 52 | * @throws \AmeliaVendor\Stripe\Exception\ApiErrorException if the request fails |
| 53 | */ |
| 54 | public static function all($params = null, $opts = null) |
| 55 | { |
| 56 | $url = static::classUrl(); |
| 57 | |
| 58 | return static::_requestPage($url, \AmeliaVendor\Stripe\Collection::class, $params, $opts); |
| 59 | } |
| 60 | |
| 61 | /** |
| 62 | * Retrieves the details of an existing ReceivedCredit by passing the unique |
| 63 | * ReceivedCredit ID from the ReceivedCredit list. |
| 64 | * |
| 65 | * @param array|string $id the ID of the API resource to retrieve, or an options array containing an `id` key |
| 66 | * @param null|array|string $opts |
| 67 | * |
| 68 | * @return ReceivedCredit |
| 69 | * |
| 70 | * @throws \AmeliaVendor\Stripe\Exception\ApiErrorException if the request fails |
| 71 | */ |
| 72 | public static function retrieve($id, $opts = null) |
| 73 | { |
| 74 | $opts = \AmeliaVendor\Stripe\Util\RequestOptions::parse($opts); |
| 75 | $instance = new static($id, $opts); |
| 76 | $instance->refresh(); |
| 77 | |
| 78 | return $instance; |
| 79 | } |
| 80 | } |
| 81 |