NAME
Net::API::Stripe::Treasury::FinancialAccount - The FinancialAccount object
SYNOPSIS
VERSION
v0.1.0DESCRIPTION
Stripe Treasury provides users with a container for money called a FinancialAccount that is separate from their Payments balance. FinancialAccounts serve as the source and destination of Treasury’s money movement APIs.
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.
active_features array
The array of paths to active Features in the Features hash.
balance hash
The single multi-currency balance of the FinancialAccount. Positive values represent money that belongs to the user while negative values represent funds the user owes. Currently, FinancialAccounts can only carry balances in USD.
It has the following properties:
cashhash-
Funds the user can spend right now.
inbound_pendinghash-
Funds not spendable yet, but will become available at a later time.
outbound_pendinghash-
Funds in the account, but not spendable because they are being held for pending outbound flows.
country string
Two-letter country code (ISO 3166-1 alpha-2.
created timestamp
Time at which the object was created. Measured in seconds since the Unix epoch.
features hash
The features and their statuses for this FinancialAccount.
It has the following properties:
card_issuinghash-
Contains a Feature encoding the FinancialAccount's ability to be used with the Issuing product, including attaching cards to and drawing funds from.
When expanded, this is a Net::API::Stripe::Connect::Account::Capability object.
deposit_insurancehash-
Represents whether this FinancialAccount is eligible for deposit insurance. Various factors determine the insurance amount.
When expanded, this is a Net::API::Stripe::Connect::Account::Capability object.
financial_addresseshash-
Contains Features that add FinancialAddresses to the FinancialAccount.
abahash-
Adds an ABA FinancialAddress to the FinancialAccount.
When expanded, this is a Net::API::Stripe::Connect::Account::Capability object.
inbound_transfershash-
Contains settings related to adding funds to a FinancialAccount from another Account with the same owner.
achhash-
Enables ACH Debits via the InboundTransfers API.
When expanded, this is a Net::API::Stripe::Connect::Account::Capability object.
intra_stripe_flowshash-
Represents the ability for this FinancialAccount to send money to, or receive money from other FinancialAccounts (for example, via OutboundPayment).
When expanded, this is a Net::API::Stripe::Connect::Account::Capability object.
objectstring-
String representing the object's type. Objects of the same type share the same value.
outbound_paymentshash-
Contains Features related to initiating money movement out of the FinancialAccount to someone else's bucket of money.
achhash-
Enables ACH transfers via the OutboundPayments API.
When expanded, this is a Net::API::Stripe::Connect::Account::Capability object.
us_domestic_wirehash-
Enables US domestic wire tranfers via the OutboundPayments API.
When expanded, this is a Net::API::Stripe::Connect::Account::Capability object.
outbound_transfershash-
Contains a Feature and settings related to moving money out of the FinancialAccount into another Account with the same owner.
achhash-
Enables ACH transfers via the OutboundTransfers API.
When expanded, this is a Net::API::Stripe::Connect::Account::Capability object.
us_domestic_wirehash-
Enables US domestic wire tranfers via the OutboundTransfers API.
When expanded, this is a Net::API::Stripe::Connect::Account::Capability object.
financial_addresses array of hash
The set of credentials that resolve to a FinancialAccount.
It has the following properties:
abahash-
Identifying information for the ABA address
When expanded, this is a Net::API::Stripe::Connect::ExternalAccount::Bank object.
supported_networksarray-
The list of networks that the address supports
typestring-
The type of financial address
livemode boolean
Has the value true if the object exists in live mode or the value false if the object exists in test mode.
metadata hash
Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
pending_features array
The array of paths to pending Features in the Features hash.
platform_restrictions hash
The set of functionalities that the platform can restrict on the FinancialAccount.
It has the following properties:
inbound_flowsstring-
Restricts all inbound money movement.
outbound_flowsstring-
Restricts all outbound money movement.
restricted_features array
The array of paths to restricted Features in the Features hash.
status string
The enum specifying what state the account is in.
status_details object
Details related to the status of this FinancialAccount.
This is a Net::API::Stripe::Billing::Invoice object.
supported_currencies array
The currencies the FinancialAccount can hold a balance in. Three-letter ISO currency code, in lowercase.
API SAMPLE
[ { "active_features" : [ "financial_addresses.aba", "outbound_payments.ach", "outbound_payments.us_domestic_wire" ], "balance" : { "cash" : { "usd" : "0" }, "inbound_pending" : { "usd" : "0" }, "outbound_pending" : { "usd" : "0" } }, "country" : "US", "created" : "1662261085", "financial_addresses" : [ { "aba" : { "account_holder_name" : "Jenny Rosen", "account_number_last4" : "7890", "bank_name" : "STRIPE TEST BANK", "routing_number" : "0000000001" }, "supported_networks" : [ "ach", "us_domestic_wire" ], "type" : "aba" } ], "id" : "fa_1Le9F32eZvKYlo2CjbQcDQUE", "livemode" : 1, "metadata" : null, "object" : "treasury.financial_account", "pending_features" : [], "restricted_features" : [], "status" : "open", "status_details" : { "closed" : null }, "supported_currencies" : [ "usd" ] } ]
HISTORY
v0.1.0
Initial version
AUTHOR
Jacques Deguest <jack@deguest.jp>
SEE ALSO
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.