Class OutboundTransfersResource

Index

Constructors

Methods

create retrieve list cancel

Constructors

constructor

new OutboundTransfersResource(): Stripe.Treasury.OutboundTransfersResource
Returns Stripe.Treasury.OutboundTransfersResource

Methods

create

create(
params: Stripe.Treasury.OutboundTransferCreateParams,
options?: RequestOptions,
): Promise<Response<Stripe.Treasury.OutboundTransfer>>
Creates an OutboundTransfer.
Parameters
- params: Stripe.Treasury.OutboundTransferCreateParams
- Optionaloptions: RequestOptions
Returns Promise<Response<Stripe.Treasury.OutboundTransfer>>
- Defined in node_modules/stripe/types/Treasury/OutboundTransfersResource.d.ts:138

retrieve

retrieve(
    id: string,
    params?: OutboundTransferRetrieveParams,
    options?: RequestOptions,
): Promise<Response<Stripe.Treasury.OutboundTransfer>>
Retrieves the details of an existing OutboundTransfer by passing the unique OutboundTransfer ID from either the OutboundTransfer creation request or OutboundTransfer list.
Parameters
- id: string
- Optionalparams: OutboundTransferRetrieveParams
- Optionaloptions: RequestOptions
Returns Promise<Response<Stripe.Treasury.OutboundTransfer>>
- Defined in node_modules/stripe/types/Treasury/OutboundTransfersResource.d.ts:146
retrieve(
id: string,
options?: RequestOptions,
): Promise<Response<Stripe.Treasury.OutboundTransfer>>
Retrieves the details of an existing OutboundTransfer by passing the unique OutboundTransfer ID from either the OutboundTransfer creation request or OutboundTransfer list.
Parameters
- id: string
- Optionaloptions: RequestOptions
Returns Promise<Response<Stripe.Treasury.OutboundTransfer>>
- Defined in node_modules/stripe/types/Treasury/OutboundTransfersResource.d.ts:151

list

list(
params: Stripe.Treasury.OutboundTransferListParams,
options?: RequestOptions,
): ApiListPromise<Stripe.Treasury.OutboundTransfer>
Returns a list of OutboundTransfers sent from the specified FinancialAccount.
Parameters
- params: Stripe.Treasury.OutboundTransferListParams
- Optionaloptions: RequestOptions
Returns ApiListPromise<Stripe.Treasury.OutboundTransfer>
- Defined in node_modules/stripe/types/Treasury/OutboundTransfersResource.d.ts:159

cancel

cancel(
    id: string,
    params?: OutboundTransferCancelParams,
    options?: RequestOptions,
): Promise<Response<Stripe.Treasury.OutboundTransfer>>
An OutboundTransfer can be canceled if the funds have not yet been paid out.
Parameters
- id: string
- Optionalparams: OutboundTransferCancelParams
- Optionaloptions: RequestOptions
Returns Promise<Response<Stripe.Treasury.OutboundTransfer>>
- Defined in node_modules/stripe/types/Treasury/OutboundTransfersResource.d.ts:167
cancel(
id: string,
options?: RequestOptions,
): Promise<Response<Stripe.Treasury.OutboundTransfer>>
An OutboundTransfer can be canceled if the funds have not yet been paid out.
Parameters
- id: string
- Optionaloptions: RequestOptions
Returns Promise<Response<Stripe.Treasury.OutboundTransfer>>
- Defined in node_modules/stripe/types/Treasury/OutboundTransfersResource.d.ts:172