Class OutboundPaymentsResource

Index

Constructors

Methods

update fail post returnOutboundPayment

Constructors

constructor

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

Methods

update

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

fail

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

post

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

returnOutboundPayment

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