Class SourcesResource

Index

Constructors

Methods

create retrieve update listSourceTransactions verify

Constructors

constructor

new SourcesResource(): SourcesResource
Returns SourcesResource

Methods

create

create(
params?: Stripe.SourceCreateParams,
options?: RequestOptions,
): Promise<Response<Stripe.Source>>
Creates a new source object.
Parameters
- Optionalparams: Stripe.SourceCreateParams
- Optionaloptions: RequestOptions
Returns Promise<Response<Stripe.Source>>
- Defined in node_modules/stripe/types/SourcesResource.d.ts:558
create(options?: RequestOptions): Promise<Response<Stripe.Source>>
Creates a new source object.
Parameters
- Optionaloptions: RequestOptions
Returns Promise<Response<Stripe.Source>>
- Defined in node_modules/stripe/types/SourcesResource.d.ts:562

retrieve

retrieve(
    id: string,
    params?: SourceRetrieveParams,
    options?: RequestOptions,
): Promise<Response<Stripe.Source>>
Retrieves an existing source object. Supply the unique source ID from a source creation request and Stripe will return the corresponding up-to-date source object information.
Parameters
- id: string
- Optionalparams: SourceRetrieveParams
- Optionaloptions: RequestOptions
Returns Promise<Response<Stripe.Source>>
- Defined in node_modules/stripe/types/SourcesResource.d.ts:567
retrieve(id: string, options?: RequestOptions): Promise<Response<Stripe.Source>>
Retrieves an existing source object. Supply the unique source ID from a source creation request and Stripe will return the corresponding up-to-date source object information.
Parameters
- id: string
- Optionaloptions: RequestOptions
Returns Promise<Response<Stripe.Source>>
- Defined in node_modules/stripe/types/SourcesResource.d.ts:572

update

update(
    id: string,
    params?: Stripe.SourceUpdateParams,
    options?: RequestOptions,
): Promise<Response<Stripe.Source>>
Updates the specified source by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

This request accepts the metadata and owner as arguments. It is also possible to update type specific information for selected payment methods. Please refer to our payment method guides for more detail.
Parameters
- id: string
- Optionalparams: Stripe.SourceUpdateParams
- Optionaloptions: RequestOptions
Returns Promise<Response<Stripe.Source>>
- Defined in node_modules/stripe/types/SourcesResource.d.ts:582

listSourceTransactions

listSourceTransactions(
    id: string,
    params?: SourceListSourceTransactionsParams,
    options?: RequestOptions,
): ApiListPromise<Stripe.SourceTransaction>
List source transactions for a given source.
Parameters
- id: string
- Optionalparams: SourceListSourceTransactionsParams
- Optionaloptions: RequestOptions
Returns ApiListPromise<Stripe.SourceTransaction>
- Defined in node_modules/stripe/types/SourcesResource.d.ts:591
listSourceTransactions(
id: string,
options?: RequestOptions,
): ApiListPromise<Stripe.SourceTransaction>
List source transactions for a given source.
Parameters
- id: string
- Optionaloptions: RequestOptions
Returns ApiListPromise<Stripe.SourceTransaction>
- Defined in node_modules/stripe/types/SourcesResource.d.ts:596

verify

verify(
    id: string,
    params: SourceVerifyParams,
    options?: RequestOptions,
): Promise<Response<Stripe.Source>>
Verify a given source.
Parameters
- id: string
- params: SourceVerifyParams
- Optionaloptions: RequestOptions
Returns Promise<Response<Stripe.Source>>
- Defined in node_modules/stripe/types/SourcesResource.d.ts:604