CustomerCashBalanceTransaction.php 2.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142
  1. <?php
  2. // File generated from our OpenAPI spec
  3. namespace Stripe;
  4. /**
  5. * Customers with certain payments enabled have a cash balance, representing funds that were paid
  6. * by the customer to a merchant, but have not yet been allocated to a payment. Cash Balance Transactions
  7. * represent when funds are moved into or out of this balance. This includes funding by the customer, allocation
  8. * to payments, and refunds to the customer.
  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 null|\Stripe\StripeObject $adjusted_for_overdraft
  13. * @property null|\Stripe\StripeObject $applied_to_payment
  14. * @property int $created Time at which the object was created. Measured in seconds since the Unix epoch.
  15. * @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>.
  16. * @property string|\Stripe\Customer $customer The customer whose available cash balance changed as a result of this transaction.
  17. * @property int $ending_balance The total available cash balance for the specified currency after this transaction was applied. Represented in the <a href="https://stripe.com/docs/currencies#zero-decimal">smallest currency unit</a>.
  18. * @property null|\Stripe\StripeObject $funded
  19. * @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.
  20. * @property int $net_amount The amount by which the cash balance changed, represented in the <a href="https://stripe.com/docs/currencies#zero-decimal">smallest currency unit</a>. A positive value represents funds being added to the cash balance, a negative value represents funds being removed from the cash balance.
  21. * @property null|\Stripe\StripeObject $refunded_from_payment
  22. * @property null|\Stripe\StripeObject $transferred_to_balance
  23. * @property string $type The type of the cash balance transaction. New types may be added in future. See <a href="https://stripe.com/docs/payments/customer-balance#types">Customer Balance</a> to learn more about these types.
  24. * @property null|\Stripe\StripeObject $unapplied_from_payment
  25. */
  26. class CustomerCashBalanceTransaction extends ApiResource
  27. {
  28. const OBJECT_NAME = 'customer_cash_balance_transaction';
  29. const TYPE_ADJUSTED_FOR_OVERDRAFT = 'adjusted_for_overdraft';
  30. const TYPE_APPLIED_TO_PAYMENT = 'applied_to_payment';
  31. const TYPE_FUNDED = 'funded';
  32. const TYPE_FUNDING_REVERSED = 'funding_reversed';
  33. const TYPE_REFUNDED_FROM_PAYMENT = 'refunded_from_payment';
  34. const TYPE_RETURN_CANCELED = 'return_canceled';
  35. const TYPE_RETURN_INITIATED = 'return_initiated';
  36. const TYPE_TRANSFERRED_TO_BALANCE = 'transferred_to_balance';
  37. const TYPE_UNAPPLIED_FROM_PAYMENT = 'unapplied_from_payment';
  38. }