/ 
Net-API-Stripe-v2.0.6
River stage one • 1 direct dependent • 1 total dependent
/ Net::API::Stripe::Treasury::Transaction

NAME

Net::API::Stripe::Treasury::Transaction - The Transaction object

SYNOPSIS

VERSION

v0.1.0

DESCRIPTION

Transactions represent changes to a FinancialAccount's balance.

METHODS

id string

Unique identifier for the object.

object string

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

amount integer

Amount (in cents) transferred.

balance_impact hash

The change made to each of the FinancialAccount's sub-balances by the Transaction.

It has the following properties:

cash integer

The change made to funds the user can spend right now.

inbound_pending integer

The change made to funds that are not spendable yet, but will become available at a later time.

outbound_pending integer

The change made to funds in the account, but not spendable because they are being held for pending outbound flows.

created timestamp

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

currency currency

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

description string

An arbitrary string attached to the object. Often useful for displaying to users.

entries object

A list of TransactionEntries that are part of this Transaction. This cannot be expanded in any list endpoints.

This is a Net::API::Stripe::List object.

financial_account string

The FinancialAccount associated with this object.

flow string

ID of the flow that created the Transaction.

flow_details hash

Details of the flow that created the Transaction.

It has the following properties:

credit_reversal hash

The CreditReversal object associated with the Transaction. Set if type=credit_reversal.

When expanded, this is a Net::API::Stripe::Treasury::CreditReversal object.

debit_reversal hash

The DebitReversal object associated with the Transaction. Set if type=debit_reversal.

When expanded, this is a Net::API::Stripe::Treasury::DebitReversal object.

inbound_transfer hash

The InboundTransfer object associated with the Transaction. Set if type=inbound_transfer.

When expanded, this is a Net::API::Stripe::Treasury::InboundTransfer object.

issuing_authorization hash

The Issuing authorization object associated with the Transaction. Set if type=issuing_authorization.

outbound_payment hash

The OutboundPayment object associated with the Transaction. Set if type=outbound_payment.

When expanded, this is a Net::API::Stripe::Treasury::OutboundPayment object.

outbound_transfer hash

The OutboundTransfer object associated with the Transaction. Set if type=outbound_transfer.

When expanded, this is a Net::API::Stripe::Treasury::OutboundTransfer object.

received_credit hash

The ReceivedCredit object associated with the Transaction. Set if type=received_credit.

When expanded, this is a Net::API::Stripe::Treasury::ReceivedCredit object.

received_debit hash

The ReceivedDebit object associated with the Transaction. Set if type=received_debit.

When expanded, this is a Net::API::Stripe::Treasury::ReceivedDebit object.

type string

Type of the flow that created the Transaction. Set to the same value as flow_type.

flow_type string

Type of the flow that created the Transaction.

livemode boolean

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

status string

Status of the Transaction.

status_transitions hash

Hash containing timestamps of when the object transitioned to a particular status.

It has the following properties:

posted_at timestamp

Timestamp describing when the Transaction changed status to posted.

void_at timestamp

Timestamp describing when the Transaction changed status to void.

API SAMPLE

[ { "amount" : "-100", "balance_impact" : { "cash" : "-100", "inbound_pending" : "0", "outbound_pending" : "100" }, "created" : "1662261085", "currency" : "usd", "description" : "Jane Austen (6789) | Outbound transfer | transfer", "financial_account" : "fa_1Le9F32eZvKYlo2CjbQcDQUE", "flow" : "obt_1Le9F32eZvKYlo2CPQD5jo2F", "flow_type" : "outbound_transfer", "id" : "trxn_1Le9F32eZvKYlo2C2dtkse82", "livemode" : 0, "object" : "treasury.transaction", "status" : "open", "status_transitions" : { "posted_at" : null, "void_at" : null } } ]

HISTORY

v0.1.0

Initial version

AUTHOR

Jacques Deguest <jack@deguest.jp>

SEE ALSO

Stripe API documentation

COPYRIGHT & LICENSE

Copyright (c) 2019-2022 DEGUEST Pte. Ltd.

You can use, copy, modify and redistribute this package and associated files under the same terms as Perl itself.