Class OutboundPaymentsResource

Index

Constructors

Methods

create retrieve list cancel

Constructors

constructor

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

Methods

create

create(
params: Stripe.Treasury.OutboundPaymentCreateParams,
options?: RequestOptions,
): Promise<Response<Stripe.Treasury.OutboundPayment>>
Creates an OutboundPayment.
Parameters
- params: Stripe.Treasury.OutboundPaymentCreateParams
- Optionaloptions: RequestOptions
Returns Promise<Response<Stripe.Treasury.OutboundPayment>>
- Defined in node_modules/stripe/types/Treasury/OutboundPaymentsResource.d.ts:244

retrieve

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

list

list(
params: Stripe.Treasury.OutboundPaymentListParams,
options?: RequestOptions,
): ApiListPromise<Stripe.Treasury.OutboundPayment>
Returns a list of OutboundPayments sent from the specified FinancialAccount.
Parameters
- params: Stripe.Treasury.OutboundPaymentListParams
- Optionaloptions: RequestOptions
Returns ApiListPromise<Stripe.Treasury.OutboundPayment>
- Defined in node_modules/stripe/types/Treasury/OutboundPaymentsResource.d.ts:265

cancel

cancel(
    id: string,
    params?: OutboundPaymentCancelParams,
    options?: RequestOptions,
): Promise<Response<Stripe.Treasury.OutboundPayment>>
Cancel an OutboundPayment.
Parameters
- id: string
- Optionalparams: OutboundPaymentCancelParams
- Optionaloptions: RequestOptions
Returns Promise<Response<Stripe.Treasury.OutboundPayment>>
- Defined in node_modules/stripe/types/Treasury/OutboundPaymentsResource.d.ts:273
cancel(
id: string,
options?: RequestOptions,
): Promise<Response<Stripe.Treasury.OutboundPayment>>
Cancel an OutboundPayment.
Parameters
- id: string
- Optionaloptions: RequestOptions
Returns Promise<Response<Stripe.Treasury.OutboundPayment>>
- Defined in node_modules/stripe/types/Treasury/OutboundPaymentsResource.d.ts:278