The TransactionEntry object 

Attributes

  • idstring

    Unique identifier for the object.

  • objectstring

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

  • balance_impactobject

    The current impact of the TransactionEntry on the FinancialAccount’s balance.

  • createdtimestamp

    Time at which the object was created. Measured in seconds since the Unix epoch.

  • currencyenum

    Three-letter ISO currency code, in lowercase. Must be a supported currency.

  • effective_attimestamp

    When the TransactionEntry will impact the FinancialAccount’s balance.

  • financial_accountstring

    The FinancialAccount associated with this object.

  • flownullable string

    Token of the flow associated with the TransactionEntry.

  • flow_detailsnullable objectExpandable

    Details of the flow associated with the TransactionEntry.

  • flow_typeenum

    Type of the flow associated with the TransactionEntry.

    Possible enum values
    credit_reversal

    The Transaction is associated with a CreditReversal.

    debit_reversal

    The Transaction is associated with a DebitReversal.

    inbound_transfer

    The Transaction is associated with an InboundTransfer.

    issuing_authorization

    The Transaction is associated with an Issuing authorization.

    other

    The Transaction is associated with some other money movement not listed above.

    outbound_payment

    The Transaction is associated with an OutboundPayment.

    outbound_transfer

    The Transaction is associated with an OutboundTransfer.

    received_credit

    The Transaction is associated with a ReceivedCredit.

    received_debit

    The Transaction is associated with 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.

  • transactionstringExpandable

    The Transaction associated with this object.

  • typeenum

    The specific money movement that generated the TransactionEntry.

    Possible enum values
    credit_reversal

    The TransactionEntry was generated by a CreditReversal.

    credit_reversal_posting

    The TransactionEntry was generated by a posted CreditReversal.

    debit_reversal

    The TransactionEntry was generated by a DebitReversal.

    inbound_transfer

    The TransactionEntry was generated by an InboundTransfer.

    inbound_transfer_return

    The TransactionEntry was generated by an InboundTransferReturn.

    issuing_authorization_hold

    The TransactionEntry was generated by an Issuing authorization hold.

    issuing_authorization_release

    The TransactionEntry was generated by an Issuing authorization release.

    other

    The TransactionEntry was generated by some other money movement.

    outbound_payment

    The TransactionEntry was generated by an OutboundPayment.

    outbound_payment_cancellation

    The TransactionEntry was generated by a cancelled OutboundPayment.

    Show 10 more
The TransactionEntry object
{
"id": "trxne_1MtkgV2eZvKYlo2CmofEnIwJ",
"object": "treasury.transaction_entry",
"balance_impact": {
"cash": 0,
"inbound_pending": 0,
"outbound_pending": -1000
},
"created": 1680756271,
"currency": "usd",
"effective_at": 1680756271,
"financial_account": "fa_1MtkgV2eZvKYlo2CdxyvnHeQ",
"flow": "obt_1MtkgV2eZvKYlo2CCxhXVFLB",
"flow_type": "outbound_transfer",
"livemode": false,
"transaction": "trxn_1MtkgV2eZvKYlo2CRYxD7KLh",
"type": "outbound_transfer"
}

Retrieve a TransactionEntry 

Retrieves a TransactionEntry object.

Parameters

No parameters.

Returns

Returns a TransactionEntry object.

GET /v1/treasury/transaction_entries/:id
curl https://api.stripe.com/v1/treasury/transaction_entries/trxne_1MtkgV2eZvKYlo2CmofEnIwJ \
-u "sk_test_BQokikJ...2HlWgH4olfQ2sk_test_BQokikJOvBiI2HlWgH4olfQ2:"
Response
{
"id": "trxne_1MtkgV2eZvKYlo2CmofEnIwJ",
"object": "treasury.transaction_entry",
"balance_impact": {
"cash": 0,
"inbound_pending": 0,
"outbound_pending": -1000
},
"created": 1680756271,
"currency": "usd",
"effective_at": 1680756271,
"financial_account": "fa_1MtkgV2eZvKYlo2CdxyvnHeQ",
"flow": "obt_1MtkgV2eZvKYlo2CCxhXVFLB",
"flow_type": "outbound_transfer",
"livemode": false,
"transaction": "trxn_1MtkgV2eZvKYlo2CRYxD7KLh",
"type": "outbound_transfer"
}

List all TransactionEntries 

Retrieves a list of TransactionEntry objects.

Parameters

  • financial_accountstring

    Returns objects associated with this FinancialAccount.

  • createdobject

    Only return TransactionEntries that were created during the given date interval.

  • order_byenum

    The results are in reverse chronological order by created or effective_at. The default is created.

    Possible enum values
    created

    Timestamp describing when the TransactionEntry was created.

    effective_at

    Timestamp describing when the TransactionEntry was effective.

  • transactionstring

    Only return TransactionEntries associated with this Transaction.

More parameters

  • ending_beforestring

  • limitinteger

  • starting_afterstring

Returns

A dictionary with a data property that contains an array of up to limit TransactionEntries, starting after TransactionEntry starting_after. Each entry in the array is a separate TransactionEntry object. If no more TransactionEntries are available, the resulting array is empty.

GET /v1/treasury/transaction_entries
curl -G https://api.stripe.com/v1/treasury/transaction_entries \
-u "sk_test_BQokikJ...2HlWgH4olfQ2sk_test_BQokikJOvBiI2HlWgH4olfQ2:" \
-d financial_account=fa_1MtkgV2eZvKYlo2CdxyvnHeQ \
-d limit=3
Response
{
"object": "list",
"url": "/v1/treasury/transaction_entries",
"has_more": false,
"data": [
{
"id": "trxne_1MtkgV2eZvKYlo2CmofEnIwJ",
"object": "treasury.transaction_entry",
"balance_impact": {
"cash": 0,
"inbound_pending": 0,
"outbound_pending": -1000
},
"created": 1680756271,
"currency": "usd",
"effective_at": 1680756271,
"financial_account": "fa_1MtkgV2eZvKYlo2CdxyvnHeQ",
"flow": "obt_1MtkgV2eZvKYlo2CCxhXVFLB",
"flow_type": "outbound_transfer",
"livemode": false,
"transaction": "trxn_1MtkgV2eZvKYlo2CRYxD7KLh",
"type": "outbound_transfer"
}
]
}

Outbound Transfers 

Use OutboundTransfers to transfer funds from a FinancialAccount to a PaymentMethod belonging to the same entity. To send funds to a different party, use OutboundPayments instead. You can send funds over ACH rails or through a domestic wire transfer to a user’s own external bank account.

Simulate OutboundTransfer state changes with the /v1/test_helpers/treasury/outbound_transfers endpoints. These methods can only be called on test mode objects.

Related guide: Moving money with Treasury using OutboundTransfer objects

Outbound Payments