Transaction.php 3.5 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879
  1. <?php
  2. // File generated from our OpenAPI spec
  3. namespace Stripe\Treasury;
  4. /**
  5. * Transactions represent changes to a <a href="https://stripe.com/docs/api#financial_accounts">FinancialAccount's</a> balance.
  6. *
  7. * @property string $id Unique identifier for the object.
  8. * @property string $object String representing the object's type. Objects of the same type share the same value.
  9. * @property int $amount Amount (in cents) transferred.
  10. * @property \Stripe\StripeObject $balance_impact Change to a FinancialAccount's balance
  11. * @property int $created Time at which the object was created. Measured in seconds since the Unix epoch.
  12. * @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>.
  13. * @property string $description An arbitrary string attached to the object. Often useful for displaying to users.
  14. * @property null|\Stripe\Collection<\Stripe\Treasury\TransactionEntry> $entries A list of TransactionEntries that are part of this Transaction. This cannot be expanded in any list endpoints.
  15. * @property string $financial_account The FinancialAccount associated with this object.
  16. * @property null|string $flow ID of the flow that created the Transaction.
  17. * @property null|\Stripe\StripeObject $flow_details Details of the flow that created the Transaction.
  18. * @property string $flow_type Type of the flow that created the Transaction.
  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 string $status Status of the Transaction.
  21. * @property \Stripe\StripeObject $status_transitions
  22. */
  23. class Transaction extends \Stripe\ApiResource
  24. {
  25. const OBJECT_NAME = 'treasury.transaction';
  26. const FLOW_TYPE_CREDIT_REVERSAL = 'credit_reversal';
  27. const FLOW_TYPE_DEBIT_REVERSAL = 'debit_reversal';
  28. const FLOW_TYPE_INBOUND_TRANSFER = 'inbound_transfer';
  29. const FLOW_TYPE_ISSUING_AUTHORIZATION = 'issuing_authorization';
  30. const FLOW_TYPE_OTHER = 'other';
  31. const FLOW_TYPE_OUTBOUND_PAYMENT = 'outbound_payment';
  32. const FLOW_TYPE_OUTBOUND_TRANSFER = 'outbound_transfer';
  33. const FLOW_TYPE_RECEIVED_CREDIT = 'received_credit';
  34. const FLOW_TYPE_RECEIVED_DEBIT = 'received_debit';
  35. const STATUS_OPEN = 'open';
  36. const STATUS_POSTED = 'posted';
  37. const STATUS_VOID = 'void';
  38. /**
  39. * Retrieves a list of Transaction objects.
  40. *
  41. * @param null|array $params
  42. * @param null|array|string $opts
  43. *
  44. * @throws \Stripe\Exception\ApiErrorException if the request fails
  45. *
  46. * @return \Stripe\Collection<\Stripe\Treasury\Transaction> of ApiResources
  47. */
  48. public static function all($params = null, $opts = null)
  49. {
  50. $url = static::classUrl();
  51. return static::_requestPage($url, \Stripe\Collection::class, $params, $opts);
  52. }
  53. /**
  54. * Retrieves the details of an existing Transaction.
  55. *
  56. * @param array|string $id the ID of the API resource to retrieve, or an options array containing an `id` key
  57. * @param null|array|string $opts
  58. *
  59. * @throws \Stripe\Exception\ApiErrorException if the request fails
  60. *
  61. * @return \Stripe\Treasury\Transaction
  62. */
  63. public static function retrieve($id, $opts = null)
  64. {
  65. $opts = \Stripe\Util\RequestOptions::parse($opts);
  66. $instance = new static($id, $opts);
  67. $instance->refresh();
  68. return $instance;
  69. }
  70. }