The Transaction object 

Attributes

• idstring

  Unique identifier for the object.

• objectstring, value is "v2.money_management.transaction"

  String representing the object’s type. Objects of the same type share the same value of the object field.

• amountobject

  The amount of the Transaction.

  Hide child attributes

  • amount.currencystring

    A lowercase alpha3 currency code like “usd”.

  • amount.valueinteger

    In minor units like 123 for 1.23 USD.

• balance_impactobject

  The delta to the FinancialAccount’s balance. The balance_impact for the Transaction is equal to sum of its TransactionEntries that have effective_ats in the past.

  Hide child attributes

  • balance_impact.availableobject

    Impact to the available balance.

    Hide child attributes

    • balance_impact.available.currencystring

      A lowercase alpha3 currency code like “usd”.

    • balance_impact.available.valueinteger

      In minor units like 123 for 1.23 USD.

  • balance_impact.inbound_pendingobject

    Impact to the inbound_pending balance.

    Hide child attributes

    • balance_impact.inbound_pending.currencystring

      A lowercase alpha3 currency code like “usd”.

    • balance_impact.inbound_pending.valueinteger

      In minor units like 123 for 1.23 USD.

  • balance_impact.outbound_pendingobject

    Impact to the outbound_pending balance.

    Hide child attributes

    • balance_impact.outbound_pending.currencystring

      A lowercase alpha3 currency code like “usd”.

    • balance_impact.outbound_pending.valueinteger

      In minor units like 123 for 1.23 USD.

• categoryenum

  A descriptive category used to classify the Transaction.

  Possible enum values

  adjustment This Transaction is the main Transaction for an Adjustment.

  inbound_transfer This Transaction is the main Transaction for an InboundTransfer.

  outbound_payment This Transaction is the main Transaction for an OutboundPayment.

  outbound_transfer This Transaction is the main Transaction for an OutboundTransfer.

  received_credit This Transaction is the main Transaction for a ReceivedCredit.

  received_debit This Transaction is the main Transaction for a ReceivedDebit.

  return This Transaction is for the return of funds, such as when an OutboundPayment is returned by the recipient’s bank.

  stripe_fee This Transaction is for a fee assessed by Stripe.

• createdtimestamp

  Time at which the object was created. Represented as a RFC 3339 date & time UTC value in millisecond precision, for example: 2022-09-18T13:22:18.123Z.

• financial_accountstring

  Indicates the FinancialAccount affected by this Transaction.

• flowobject

  Details about the Flow object that created the Transaction.

  Hide child attributes

  • flow.adjustmentnullable string

    If applicable, the ID of the Adjustment that created this Transaction.

  • flow.fee_transactionnullable string

    If applicable, the ID of the FeeTransaction that created this Transaction.

  • flow.inbound_transfernullable string

    If applicable, the ID of the InboundTransfer that created this Transaction.

  • flow.outbound_paymentnullable string

    If applicable, the ID of the OutboundPayment that created this Transaction.

  • flow.outbound_transfernullable string

    If applicable, the ID of the OutboundTransfer that created this Transaction.

  • flow.received_creditnullable string

    If applicable, the ID of the ReceivedCredit that created this Transaction.

  • flow.received_debitnullable string

    If applicable, the ID of the ReceivedDebit that created this Transaction.

  • flow.typeenum

    Type of the flow that created the Transaction. The field matching this value will contain the ID of the flow.

    Possible enum values

    adjustment This Transaction was created by an Adjustment.

    fee_transaction This Transaction was created by a FeeTransaction.

    inbound_transfer This Transaction was created by an InboundTransfer.

    outbound_payment This Transaction was created by an OutboundPayment.

    outbound_transfer This Transaction was created by an OutboundTransfer.

    received_credit This Transaction was created by a ReceivedCredit.

    received_debit This Transaction was created by a ReceivedDebit.

• livemodeboolean

  Has the value true if the object exists in live mode or the value false if the object exists in test mode.

• statusenum

  Current status of the Transaction. A Transaction is pending if either balance_impact.inbound_pending or balance_impact.outbound_pending is non-zero. A Transaction is posted if only balance_impact.available is non-zero. A Transaction is void if there is no balance impact. posted and void are terminal states, and no additional entries will be added to the Transaction.

  Possible enum values

  pending This Transaction’s balance impact is still pending (non-zero impact to either inbound_pending or outbound_pending). Further entries may still be added that move funds between availability states.

  posted This Transaction’s balance impact is fully posted (only cash will be non-zero). This status is final and no further entries will be added.

  void This Transaction’s balance impact has been voided (all values are zero). This status is final and no further entries will be added.

• status_transitionsobject

  Timestamps for when the Transaction transitioned to a particular status.

  Hide child attributes

  • status_transitions.posted_atnullable timestamp

    The time at which the Transaction became posted. Only present if status == posted.

  • status_transitions.void_atnullable timestamp

    The time at which the Transaction became void. Only present if status == void.