TransactionEntries represent individual units of money movements within a single Transaction.
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 valuescredit_
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 valuefalse
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 valuescredit_
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
{ "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"}
Retrieves a TransactionEntry object.
Parameters
No parameters.
Returns
Returns a 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"}
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
oreffective_
. The default isat created
.Possible enum valuescreated
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_
. Each entry in the array is a separate TransactionEntry object. If no more TransactionEntries are available, the resulting array is empty.
{ "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" } ]}
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_
endpoints. These methods can only be called on test mode objects.
Related guide: Moving money with Treasury using OutboundTransfer objects
- POST/