Class InboundTransfersResource

Index

Constructors

Methods

create retrieve list cancel

Constructors

constructor

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

Methods

create

create(
params: InboundTransferCreateParams,
options?: RequestOptions,
): Promise<Response<Stripe.Treasury.InboundTransfer>>
Creates an InboundTransfer.
Parameters
- params: InboundTransferCreateParams
- Optionaloptions: RequestOptions
Returns Promise<Response<Stripe.Treasury.InboundTransfer>>
- Defined in node_modules/stripe/types/Treasury/InboundTransfersResource.d.ts:87

retrieve

retrieve(
    id: string,
    params?: InboundTransferRetrieveParams,
    options?: RequestOptions,
): Promise<Response<Stripe.Treasury.InboundTransfer>>
Retrieves the details of an existing InboundTransfer.
Parameters
- id: string
- Optionalparams: InboundTransferRetrieveParams
- Optionaloptions: RequestOptions
Returns Promise<Response<Stripe.Treasury.InboundTransfer>>
- Defined in node_modules/stripe/types/Treasury/InboundTransfersResource.d.ts:95
retrieve(
id: string,
options?: RequestOptions,
): Promise<Response<Stripe.Treasury.InboundTransfer>>
Retrieves the details of an existing InboundTransfer.
Parameters
- id: string
- Optionaloptions: RequestOptions
Returns Promise<Response<Stripe.Treasury.InboundTransfer>>
- Defined in node_modules/stripe/types/Treasury/InboundTransfersResource.d.ts:100

list

list(
params: Stripe.Treasury.InboundTransferListParams,
options?: RequestOptions,
): ApiListPromise<Stripe.Treasury.InboundTransfer>
Returns a list of InboundTransfers sent from the specified FinancialAccount.
Parameters
- params: Stripe.Treasury.InboundTransferListParams
- Optionaloptions: RequestOptions
Returns ApiListPromise<Stripe.Treasury.InboundTransfer>
- Defined in node_modules/stripe/types/Treasury/InboundTransfersResource.d.ts:108

cancel

cancel(
    id: string,
    params?: InboundTransferCancelParams,
    options?: RequestOptions,
): Promise<Response<Stripe.Treasury.InboundTransfer>>
Cancels an InboundTransfer.
Parameters
- id: string
- Optionalparams: InboundTransferCancelParams
- Optionaloptions: RequestOptions
Returns Promise<Response<Stripe.Treasury.InboundTransfer>>
- Defined in node_modules/stripe/types/Treasury/InboundTransfersResource.d.ts:116
cancel(
id: string,
options?: RequestOptions,
): Promise<Response<Stripe.Treasury.InboundTransfer>>
Cancels an InboundTransfer.
Parameters
- id: string
- Optionaloptions: RequestOptions
Returns Promise<Response<Stripe.Treasury.InboundTransfer>>
- Defined in node_modules/stripe/types/Treasury/InboundTransfersResource.d.ts:121