/ 
Net-API-Stripe-v2.0.5
River stage one • 1 direct dependent • 1 total dependent
/ Net::API::Stripe::Financial::Connections::Account

NAME

Net::API::Stripe::Financial::Connections::Account - The Account object

SYNOPSIS

VERSION

v0.1.0

DESCRIPTION

A Financial Connections Account represents an account that exists outside of Stripe, to which you have been granted some degree of access.

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.

account_holder object

The account holder that this account belongs to.

This is a Net::API::Stripe::Payment::Source object.

balance hash

The most recent information about the account's balance.

It has the following properties:

as_of timestamp

The time that the external institution calculated this balance. Measured in seconds since the Unix epoch.

cash hash

Information on a cash balance. Only set if balance.type is cash.

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

credit hash

Information on a credit balance. Only set if balance.type is credit.

When expanded, this is a Net::API::Stripe::Payment::Source object.

current hash

The balances owed to (or by) the account holder.

Each key is a three-letter ISO currency code, in lowercase.

Each value is a integer amount. A positive amount indicates money owed to the account holder. A negative amount indicates money owed by the account holder.

type string

The type of the balance. An additional hash is included on the balance with a name matching this value.

balance_refresh hash

The state of the most recent attempt to refresh the account balance.

It has the following properties:

last_attempted_at timestamp

The time at which the last refresh attempt was initiated. Measured in seconds since the Unix epoch.

status string

The status of the last refresh attempt.

category string

The type of the account. Account category is further divided in subcategory.

created timestamp

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

display_name string

A human-readable name that has been assigned to this account, either by the account holder or by the institution.

institution_name string

The name of the institution that holds this account.

last4 string

The last 4 digits of the account number. If present, this will be 4 numeric characters.

livemode boolean

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

ownership expandable

The most recent information about the account's owners.

When expanded this is an Net::API::Stripe::Financial::Connections::AccountOwnership object.

ownership_refresh hash

The state of the most recent attempt to refresh the account owners.

It has the following properties:

last_attempted_at timestamp

The time at which the last refresh attempt was initiated. Measured in seconds since the Unix epoch.

status string

The status of the last refresh attempt.

permissions array

The list of permissions granted by this account.

status string

The status of the link to the account.

subcategory string

If category is cash, one of:

- checking
- savings
- other

If category is credit, one of:

- mortgage
- line_of_credit
- credit_card
- other

If category is investment or other, this will be other.

supported_payment_method_types array

The PaymentMethod type(s) that can be created from this account.

transaction_refresh object

The state of the most recent attempt to refresh the account transactions.

This is a Net::API::Stripe::Balance::Transaction object.

API SAMPLE

[ { "accountholder" : { "customer" : "cus_AJ78ZaALpqgiuZ", "type" : "customer" }, "balance" : null, "balance_refresh" : null, "category" : "cash", "created" : "1662261086", "display_name" : "Sample Checking Account", "id" : "fca_1Le9F42eZvKYlo2Cboplw3LC", "institution_name" : "StripeBank", "last4" : "6789", "livemode" : 0, "object" : "linked_account", "ownership" : null, "ownership_refresh" : null, "permissions" : [], "status" : "active", "subcategory" : "checking", "supported_payment_method_types" : [ "us_bank_account" ], "transaction_refresh" : 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.