Class InboundTransfersResource

Index

Constructors

Methods

fail returnInboundTransfer succeed

Constructors

constructor

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

Methods

fail

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

returnInboundTransfer

returnInboundTransfer(
    id: string,
    params?: InboundTransferReturnInboundTransferParams,
    options?: RequestOptions,
): Promise<Response<Stripe.Treasury.InboundTransfer>>
Marks the test mode InboundTransfer object as returned and links the InboundTransfer to a ReceivedDebit. The InboundTransfer must already be in the succeeded state.
Parameters
- id: string
- Optionalparams: InboundTransferReturnInboundTransferParams
- Optionaloptions: RequestOptions
Returns Promise<Response<Stripe.Treasury.InboundTransfer>>
- Defined in node_modules/stripe/types/TestHelpers/Treasury/InboundTransfersResource.d.ts:82
returnInboundTransfer(
id: string,
options?: RequestOptions,
): Promise<Response<Stripe.Treasury.InboundTransfer>>
Marks the test mode InboundTransfer object as returned and links the InboundTransfer to a ReceivedDebit. The InboundTransfer must already be in the succeeded state.
Parameters
- id: string
- Optionaloptions: RequestOptions
Returns Promise<Response<Stripe.Treasury.InboundTransfer>>
- Defined in node_modules/stripe/types/TestHelpers/Treasury/InboundTransfersResource.d.ts:87

succeed

succeed(
    id: string,
    params?: InboundTransferSucceedParams,
    options?: RequestOptions,
): Promise<Response<Stripe.Treasury.InboundTransfer>>
Transitions a test mode created InboundTransfer to the succeeded status. The InboundTransfer must already be in the processing state.
Parameters
- id: string
- Optionalparams: InboundTransferSucceedParams
- Optionaloptions: RequestOptions
Returns Promise<Response<Stripe.Treasury.InboundTransfer>>
- Defined in node_modules/stripe/types/TestHelpers/Treasury/InboundTransfersResource.d.ts:95
succeed(
id: string,
options?: RequestOptions,
): Promise<Response<Stripe.Treasury.InboundTransfer>>
Transitions a test mode created InboundTransfer to the succeeded status. The InboundTransfer must already be in the processing state.
Parameters
- id: string
- Optionaloptions: RequestOptions
Returns Promise<Response<Stripe.Treasury.InboundTransfer>>
- Defined in node_modules/stripe/types/TestHelpers/Treasury/InboundTransfersResource.d.ts:100