Class CreditReversalsResource

Index

Constructors

Methods

create retrieve list

Constructors

constructor

new CreditReversalsResource(): CreditReversalsResource
Returns CreditReversalsResource

Methods

create

create(
params: CreditReversalCreateParams,
options?: RequestOptions,
): Promise<Response<Stripe.Treasury.CreditReversal>>
Reverses a ReceivedCredit and creates a CreditReversal object.
Parameters
- params: CreditReversalCreateParams
- Optionaloptions: RequestOptions
Returns Promise<Response<Stripe.Treasury.CreditReversal>>
- Defined in node_modules/stripe/types/Treasury/CreditReversalsResource.d.ts:60

retrieve

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

list

list(
params: Stripe.Treasury.CreditReversalListParams,
options?: RequestOptions,
): ApiListPromise<Stripe.Treasury.CreditReversal>
Returns a list of CreditReversals.
Parameters
- params: Stripe.Treasury.CreditReversalListParams
- Optionaloptions: RequestOptions
Returns ApiListPromise<Stripe.Treasury.CreditReversal>
- Defined in node_modules/stripe/types/Treasury/CreditReversalsResource.d.ts:81