Class OutboundTransfersResource

Index

Constructors

Methods

update fail post returnOutboundTransfer

Constructors

constructor

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

Methods

update

update(
    id: string,
    params: Stripe.TestHelpers.Treasury.OutboundTransferUpdateParams,
    options?: RequestOptions,
): Promise<Response<Stripe.Treasury.OutboundTransfer>>
Updates a test mode created OutboundTransfer with tracking details. The OutboundTransfer must not be cancelable, and cannot be in the canceled or failed states.
Parameters
- id: string
- params: Stripe.TestHelpers.Treasury.OutboundTransferUpdateParams
- Optionaloptions: RequestOptions
Returns Promise<Response<Stripe.Treasury.OutboundTransfer>>
- Defined in node_modules/stripe/types/TestHelpers/Treasury/OutboundTransfersResource.d.ts:127

fail

fail(
    id: string,
    params?: OutboundTransferFailParams,
    options?: RequestOptions,
): Promise<Response<Stripe.Treasury.OutboundTransfer>>
Transitions a test mode created OutboundTransfer to the failed status. The OutboundTransfer must already be in the processing state.
Parameters
- id: string
- Optionalparams: OutboundTransferFailParams
- Optionaloptions: RequestOptions
Returns Promise<Response<Stripe.Treasury.OutboundTransfer>>
- Defined in node_modules/stripe/types/TestHelpers/Treasury/OutboundTransfersResource.d.ts:136
fail(
id: string,
options?: RequestOptions,
): Promise<Response<Stripe.Treasury.OutboundTransfer>>
Transitions a test mode created OutboundTransfer to the failed status. The OutboundTransfer must already be in the processing state.
Parameters
- id: string
- Optionaloptions: RequestOptions
Returns Promise<Response<Stripe.Treasury.OutboundTransfer>>
- Defined in node_modules/stripe/types/TestHelpers/Treasury/OutboundTransfersResource.d.ts:141

post

post(
    id: string,
    params?: OutboundTransferPostParams,
    options?: RequestOptions,
): Promise<Response<Stripe.Treasury.OutboundTransfer>>
Transitions a test mode created OutboundTransfer to the posted status. The OutboundTransfer must already be in the processing state.
Parameters
- id: string
- Optionalparams: OutboundTransferPostParams
- Optionaloptions: RequestOptions
Returns Promise<Response<Stripe.Treasury.OutboundTransfer>>
- Defined in node_modules/stripe/types/TestHelpers/Treasury/OutboundTransfersResource.d.ts:149
post(
id: string,
options?: RequestOptions,
): Promise<Response<Stripe.Treasury.OutboundTransfer>>
Transitions a test mode created OutboundTransfer to the posted status. The OutboundTransfer must already be in the processing state.
Parameters
- id: string
- Optionaloptions: RequestOptions
Returns Promise<Response<Stripe.Treasury.OutboundTransfer>>
- Defined in node_modules/stripe/types/TestHelpers/Treasury/OutboundTransfersResource.d.ts:154

returnOutboundTransfer

returnOutboundTransfer(
    id: string,
    params?: Stripe.TestHelpers.Treasury.OutboundTransferReturnOutboundTransferParams,
    options?: RequestOptions,
): Promise<Response<Stripe.Treasury.OutboundTransfer>>
Transitions a test mode created OutboundTransfer to the returned status. The OutboundTransfer must already be in the processing state.
Parameters
- id: string
- Optionalparams: Stripe.TestHelpers.Treasury.OutboundTransferReturnOutboundTransferParams
- Optionaloptions: RequestOptions
Returns Promise<Response<Stripe.Treasury.OutboundTransfer>>
- Defined in node_modules/stripe/types/TestHelpers/Treasury/OutboundTransfersResource.d.ts:162
returnOutboundTransfer(
id: string,
options?: RequestOptions,
): Promise<Response<Stripe.Treasury.OutboundTransfer>>
Transitions a test mode created OutboundTransfer to the returned status. The OutboundTransfer must already be in the processing state.
Parameters
- id: string
- Optionaloptions: RequestOptions
Returns Promise<Response<Stripe.Treasury.OutboundTransfer>>
- Defined in node_modules/stripe/types/TestHelpers/Treasury/OutboundTransfersResource.d.ts:167