Class ReadersResource

Index

Constructors

Methods

create retrieve update list del cancelAction collectInputs collectPaymentMethod confirmPaymentIntent processPaymentIntent processSetupIntent refundPayment setReaderDisplay

Constructors

constructor

new ReadersResource(): Stripe.Terminal.ReadersResource
Returns Stripe.Terminal.ReadersResource

Methods

create

create(
params: ReaderCreateParams,
options?: RequestOptions,
): Promise<Response<Stripe.Terminal.Reader>>
Creates a new Reader object.
Parameters
- params: ReaderCreateParams
- Optionaloptions: RequestOptions
Returns Promise<Response<Stripe.Terminal.Reader>>
- Defined in node_modules/stripe/types/Terminal/ReadersResource.d.ts:520

retrieve

retrieve(
    id: string,
    params?: ReaderRetrieveParams,
    options?: RequestOptions,
): Promise<Response<Stripe.Terminal.Reader | DeletedReader>>
Retrieves a Reader object.
Parameters
- id: string
- Optionalparams: ReaderRetrieveParams
- Optionaloptions: RequestOptions
Returns Promise<Response<Stripe.Terminal.Reader | DeletedReader>>
- Defined in node_modules/stripe/types/Terminal/ReadersResource.d.ts:528
retrieve(
id: string,
options?: RequestOptions,
): Promise<Response<Stripe.Terminal.Reader | DeletedReader>>
Retrieves a Reader object.
Parameters
- id: string
- Optionaloptions: RequestOptions
Returns Promise<Response<Stripe.Terminal.Reader | DeletedReader>>
- Defined in node_modules/stripe/types/Terminal/ReadersResource.d.ts:537

update

update(
    id: string,
    params?: ReaderUpdateParams,
    options?: RequestOptions,
): Promise<Response<Stripe.Terminal.Reader | DeletedReader>>
Updates a Reader object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
Parameters
- id: string
- Optionalparams: ReaderUpdateParams
- Optionaloptions: RequestOptions
Returns Promise<Response<Stripe.Terminal.Reader | DeletedReader>>
- Defined in node_modules/stripe/types/Terminal/ReadersResource.d.ts:549

list

list(
params?: Stripe.Terminal.ReaderListParams,
options?: RequestOptions,
): ApiListPromise<Stripe.Terminal.Reader>
Returns a list of Reader objects.
Parameters
- Optionalparams: Stripe.Terminal.ReaderListParams
- Optionaloptions: RequestOptions
Returns ApiListPromise<Stripe.Terminal.Reader>
- Defined in node_modules/stripe/types/Terminal/ReadersResource.d.ts:562
list(options?: RequestOptions): ApiListPromise<Stripe.Terminal.Reader>
Returns a list of Reader objects.
Parameters
- Optionaloptions: RequestOptions
Returns ApiListPromise<Stripe.Terminal.Reader>
- Defined in node_modules/stripe/types/Terminal/ReadersResource.d.ts:566

del

del(
    id: string,
    params?: ReaderDeleteParams,
    options?: RequestOptions,
): Promise<Response<DeletedReader>>
Deletes a Reader object.
Parameters
- id: string
- Optionalparams: ReaderDeleteParams
- Optionaloptions: RequestOptions
Returns Promise<Response<DeletedReader>>
- Defined in node_modules/stripe/types/Terminal/ReadersResource.d.ts:571
del(id: string, options?: RequestOptions): Promise<Response<DeletedReader>>
Deletes a Reader object.
Parameters
- id: string
- Optionaloptions: RequestOptions
Returns Promise<Response<DeletedReader>>
- Defined in node_modules/stripe/types/Terminal/ReadersResource.d.ts:576

cancelAction

cancelAction(
    id: string,
    params?: ReaderCancelActionParams,
    options?: RequestOptions,
): Promise<Response<Stripe.Terminal.Reader>>
Cancels the current reader action. See Programmatic Cancellation for more details.
Parameters
- id: string
- Optionalparams: ReaderCancelActionParams
- Optionaloptions: RequestOptions
Returns Promise<Response<Stripe.Terminal.Reader>>
- Defined in node_modules/stripe/types/Terminal/ReadersResource.d.ts:584
cancelAction(
id: string,
options?: RequestOptions,
): Promise<Response<Stripe.Terminal.Reader>>
Cancels the current reader action. See Programmatic Cancellation for more details.
Parameters
- id: string
- Optionaloptions: RequestOptions
Returns Promise<Response<Stripe.Terminal.Reader>>
- Defined in node_modules/stripe/types/Terminal/ReadersResource.d.ts:589

collectInputs

collectInputs(
    id: string,
    params: Stripe.Terminal.ReaderCollectInputsParams,
    options?: RequestOptions,
): Promise<Response<Stripe.Terminal.Reader>>
Initiates an input collection flow on a Reader to display input forms and collect information from your customers.
Parameters
- id: string
- params: Stripe.Terminal.ReaderCollectInputsParams
- Optionaloptions: RequestOptions
Returns Promise<Response<Stripe.Terminal.Reader>>
- Defined in node_modules/stripe/types/Terminal/ReadersResource.d.ts:597

collectPaymentMethod

collectPaymentMethod(
    id: string,
    params: Stripe.Terminal.ReaderCollectPaymentMethodParams,
    options?: RequestOptions,
): Promise<Response<Stripe.Terminal.Reader>>
Initiates a payment flow on a Reader and updates the PaymentIntent with card details before manual confirmation. See Collecting a Payment method for more details.
Parameters
- id: string
- params: Stripe.Terminal.ReaderCollectPaymentMethodParams
- Optionaloptions: RequestOptions
Returns Promise<Response<Stripe.Terminal.Reader>>
- Defined in node_modules/stripe/types/Terminal/ReadersResource.d.ts:606

confirmPaymentIntent

confirmPaymentIntent(
    id: string,
    params: Stripe.Terminal.ReaderConfirmPaymentIntentParams,
    options?: RequestOptions,
): Promise<Response<Stripe.Terminal.Reader>>
Finalizes a payment on a Reader. See Confirming a Payment for more details.
Parameters
- id: string
- params: Stripe.Terminal.ReaderConfirmPaymentIntentParams
- Optionaloptions: RequestOptions
Returns Promise<Response<Stripe.Terminal.Reader>>
- Defined in node_modules/stripe/types/Terminal/ReadersResource.d.ts:615

processPaymentIntent

processPaymentIntent(
    id: string,
    params: Stripe.Terminal.ReaderProcessPaymentIntentParams,
    options?: RequestOptions,
): Promise<Response<Stripe.Terminal.Reader>>
Initiates a payment flow on a Reader. See process the payment for more details.
Parameters
- id: string
- params: Stripe.Terminal.ReaderProcessPaymentIntentParams
- Optionaloptions: RequestOptions
Returns Promise<Response<Stripe.Terminal.Reader>>
- Defined in node_modules/stripe/types/Terminal/ReadersResource.d.ts:624

processSetupIntent

processSetupIntent(
    id: string,
    params: Stripe.Terminal.ReaderProcessSetupIntentParams,
    options?: RequestOptions,
): Promise<Response<Stripe.Terminal.Reader>>
Initiates a SetupIntent flow on a Reader. See Save directly without charging for more details.
Parameters
- id: string
- params: Stripe.Terminal.ReaderProcessSetupIntentParams
- Optionaloptions: RequestOptions
Returns Promise<Response<Stripe.Terminal.Reader>>
- Defined in node_modules/stripe/types/Terminal/ReadersResource.d.ts:633

refundPayment

refundPayment(
    id: string,
    params?: Stripe.Terminal.ReaderRefundPaymentParams,
    options?: RequestOptions,
): Promise<Response<Stripe.Terminal.Reader>>
Initiates an in-person refund on a Reader. See Refund an Interac Payment for more details.
Parameters
- id: string
- Optionalparams: Stripe.Terminal.ReaderRefundPaymentParams
- Optionaloptions: RequestOptions
Returns Promise<Response<Stripe.Terminal.Reader>>
- Defined in node_modules/stripe/types/Terminal/ReadersResource.d.ts:642
refundPayment(
id: string,
options?: RequestOptions,
): Promise<Response<Stripe.Terminal.Reader>>
Initiates an in-person refund on a Reader. See Refund an Interac Payment for more details.
Parameters
- id: string
- Optionaloptions: RequestOptions
Returns Promise<Response<Stripe.Terminal.Reader>>
- Defined in node_modules/stripe/types/Terminal/ReadersResource.d.ts:647

setReaderDisplay

setReaderDisplay(
    id: string,
    params: Stripe.Terminal.ReaderSetReaderDisplayParams,
    options?: RequestOptions,
): Promise<Response<Stripe.Terminal.Reader>>
Sets the reader display to show cart details.
Parameters
- id: string
- params: Stripe.Terminal.ReaderSetReaderDisplayParams
- Optionaloptions: RequestOptions
Returns Promise<Response<Stripe.Terminal.Reader>>
- Defined in node_modules/stripe/types/Terminal/ReadersResource.d.ts:655

Class ReadersResource

Index

Constructors

Methods

Constructors

constructor

Returns Stripe.Terminal.ReadersResource

Methods

create

Parameters

Returns Promise<Response<Stripe.Terminal.Reader>>

retrieve

Parameters

Returns Promise<Response<Stripe.Terminal.Reader | DeletedReader>>

Parameters

Returns Promise<Response<Stripe.Terminal.Reader | DeletedReader>>

update

Parameters

Returns Promise<Response<Stripe.Terminal.Reader | DeletedReader>>

list

Parameters

Returns ApiListPromise<Stripe.Terminal.Reader>

Parameters

Returns ApiListPromise<Stripe.Terminal.Reader>

del

Parameters

Returns Promise<Response<DeletedReader>>

Parameters

Returns Promise<Response<DeletedReader>>

cancelAction

Parameters

Returns Promise<Response<Stripe.Terminal.Reader>>

Parameters

Returns Promise<Response<Stripe.Terminal.Reader>>

collectInputs

Parameters

Returns Promise<Response<Stripe.Terminal.Reader>>

collectPaymentMethod

Parameters

Returns Promise<Response<Stripe.Terminal.Reader>>

confirmPaymentIntent

Parameters

Returns Promise<Response<Stripe.Terminal.Reader>>

processPaymentIntent

Parameters

Returns Promise<Response<Stripe.Terminal.Reader>>

processSetupIntent

Parameters

Returns Promise<Response<Stripe.Terminal.Reader>>

refundPayment

Parameters

Returns Promise<Response<Stripe.Terminal.Reader>>

Parameters

Returns Promise<Response<Stripe.Terminal.Reader>>

setReaderDisplay

Parameters

Returns Promise<Response<Stripe.Terminal.Reader>>

Settings

On This Page