Class FinancialAccountsResource

Index

Constructors

constructor

Methods

create retrieve update list close retrieveFeatures updateFeatures

Constructors

constructor

new FinancialAccountsResource(): FinancialAccountsResource
Returns FinancialAccountsResource

Methods

create

create(
params: Stripe.Treasury.FinancialAccountCreateParams,
options?: RequestOptions,
): Promise<Response<Stripe.Treasury.FinancialAccount>>
Creates a new FinancialAccount. Each connected account can have up to three FinancialAccounts by default.
Parameters
- params: Stripe.Treasury.FinancialAccountCreateParams
- Optionaloptions: RequestOptions
Returns Promise<Response<Stripe.Treasury.FinancialAccount>>
- Defined in node_modules/stripe/types/Treasury/FinancialAccountsResource.d.ts:654

retrieve

retrieve(
    id: string,
    params?: FinancialAccountRetrieveParams,
    options?: RequestOptions,
): Promise<Response<Stripe.Treasury.FinancialAccount>>
Retrieves the details of a FinancialAccount.
Parameters
- id: string
- Optionalparams: FinancialAccountRetrieveParams
- Optionaloptions: RequestOptions
Returns Promise<Response<Stripe.Treasury.FinancialAccount>>
- Defined in node_modules/stripe/types/Treasury/FinancialAccountsResource.d.ts:662
retrieve(
id: string,
options?: RequestOptions,
): Promise<Response<Stripe.Treasury.FinancialAccount>>
Retrieves the details of a FinancialAccount.
Parameters
- id: string
- Optionaloptions: RequestOptions
Returns Promise<Response<Stripe.Treasury.FinancialAccount>>
- Defined in node_modules/stripe/types/Treasury/FinancialAccountsResource.d.ts:667

update

update(
    id: string,
    params?: Stripe.Treasury.FinancialAccountUpdateParams,
    options?: RequestOptions,
): Promise<Response<Stripe.Treasury.FinancialAccount>>
Updates the details of a FinancialAccount.
Parameters
- id: string
- Optionalparams: Stripe.Treasury.FinancialAccountUpdateParams
- Optionaloptions: RequestOptions
Returns Promise<Response<Stripe.Treasury.FinancialAccount>>
- Defined in node_modules/stripe/types/Treasury/FinancialAccountsResource.d.ts:675

list

list(
params?: Stripe.Treasury.FinancialAccountListParams,
options?: RequestOptions,
): ApiListPromise<Stripe.Treasury.FinancialAccount>
Returns a list of FinancialAccounts.
Parameters
- Optionalparams: Stripe.Treasury.FinancialAccountListParams
- Optionaloptions: RequestOptions
Returns ApiListPromise<Stripe.Treasury.FinancialAccount>
- Defined in node_modules/stripe/types/Treasury/FinancialAccountsResource.d.ts:684
list(options?: RequestOptions): ApiListPromise<Stripe.Treasury.FinancialAccount>
Returns a list of FinancialAccounts.
Parameters
- Optionaloptions: RequestOptions
Returns ApiListPromise<Stripe.Treasury.FinancialAccount>
- Defined in node_modules/stripe/types/Treasury/FinancialAccountsResource.d.ts:688

close

close(
    id: string,
    params?: Stripe.Treasury.FinancialAccountCloseParams,
    options?: RequestOptions,
): Promise<Response<Stripe.Treasury.FinancialAccount>>
Closes a FinancialAccount. A FinancialAccount can only be closed if it has a zero balance, has no pending InboundTransfers, and has canceled all attached Issuing cards.
Parameters
- id: string
- Optionalparams: Stripe.Treasury.FinancialAccountCloseParams
- Optionaloptions: RequestOptions
Returns Promise<Response<Stripe.Treasury.FinancialAccount>>
- Defined in node_modules/stripe/types/Treasury/FinancialAccountsResource.d.ts:695
close(
id: string,
options?: RequestOptions,
): Promise<Response<Stripe.Treasury.FinancialAccount>>
Closes a FinancialAccount. A FinancialAccount can only be closed if it has a zero balance, has no pending InboundTransfers, and has canceled all attached Issuing cards.
Parameters
- id: string
- Optionaloptions: RequestOptions
Returns Promise<Response<Stripe.Treasury.FinancialAccount>>
- Defined in node_modules/stripe/types/Treasury/FinancialAccountsResource.d.ts:700

retrieveFeatures

retrieveFeatures(
    id: string,
    params?: FinancialAccountRetrieveFeaturesParams,
    options?: RequestOptions,
): Promise<Response<Stripe.Treasury.FinancialAccountFeatures>>
Retrieves Features information associated with the FinancialAccount.
Parameters
- id: string
- Optionalparams: FinancialAccountRetrieveFeaturesParams
- Optionaloptions: RequestOptions
Returns Promise<Response<Stripe.Treasury.FinancialAccountFeatures>>
- Defined in node_modules/stripe/types/Treasury/FinancialAccountsResource.d.ts:708
retrieveFeatures(
id: string,
options?: RequestOptions,
): Promise<Response<Stripe.Treasury.FinancialAccountFeatures>>
Retrieves Features information associated with the FinancialAccount.
Parameters
- id: string
- Optionaloptions: RequestOptions
Returns Promise<Response<Stripe.Treasury.FinancialAccountFeatures>>
- Defined in node_modules/stripe/types/Treasury/FinancialAccountsResource.d.ts:713

updateFeatures

updateFeatures(
    id: string,
    params?: Stripe.Treasury.FinancialAccountUpdateFeaturesParams,
    options?: RequestOptions,
): Promise<Response<Stripe.Treasury.FinancialAccountFeatures>>
Updates the Features associated with a FinancialAccount.
Parameters
- id: string
- Optionalparams: Stripe.Treasury.FinancialAccountUpdateFeaturesParams
- Optionaloptions: RequestOptions
Returns Promise<Response<Stripe.Treasury.FinancialAccountFeatures>>
- Defined in node_modules/stripe/types/Treasury/FinancialAccountsResource.d.ts:721
updateFeatures(
id: string,
options?: RequestOptions,
): Promise<Response<Stripe.Treasury.FinancialAccountFeatures>>
Updates the Features associated with a FinancialAccount.
Parameters
- id: string
- Optionaloptions: RequestOptions
Returns Promise<Response<Stripe.Treasury.FinancialAccountFeatures>>
- Defined in node_modules/stripe/types/Treasury/FinancialAccountsResource.d.ts:726

Class FinancialAccountsResource

Index

Constructors

Methods

Constructors

constructor

Returns FinancialAccountsResource

Methods

create

Parameters

Returns Promise<Response<Stripe.Treasury.FinancialAccount>>

retrieve

Parameters

Returns Promise<Response<Stripe.Treasury.FinancialAccount>>

Parameters

Returns Promise<Response<Stripe.Treasury.FinancialAccount>>

update

Parameters

Returns Promise<Response<Stripe.Treasury.FinancialAccount>>

list

Parameters

Returns ApiListPromise<Stripe.Treasury.FinancialAccount>

Parameters

Returns ApiListPromise<Stripe.Treasury.FinancialAccount>

close

Parameters

Returns Promise<Response<Stripe.Treasury.FinancialAccount>>

Parameters

Returns Promise<Response<Stripe.Treasury.FinancialAccount>>

retrieveFeatures

Parameters

Returns Promise<Response<Stripe.Treasury.FinancialAccountFeatures>>

Parameters

Returns Promise<Response<Stripe.Treasury.FinancialAccountFeatures>>

updateFeatures

Parameters

Returns Promise<Response<Stripe.Treasury.FinancialAccountFeatures>>

Parameters

Returns Promise<Response<Stripe.Treasury.FinancialAccountFeatures>>

Settings

On This Page