Class ReadersResource

Index

Constructors

Methods

presentPaymentMethod succeedInputCollection timeoutInputCollection

Constructors

constructor

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

Methods

presentPaymentMethod

presentPaymentMethod(
    id: string,
    params?: Stripe.TestHelpers.Terminal.ReaderPresentPaymentMethodParams,
    options?: RequestOptions,
): Promise<Response<Stripe.Terminal.Reader>>
Presents a payment method on a simulated reader. Can be used to simulate accepting a payment, saving a card or refunding a transaction.
Parameters
- id: string
- Optionalparams: Stripe.TestHelpers.Terminal.ReaderPresentPaymentMethodParams
- Optionaloptions: RequestOptions
Returns Promise<Response<Stripe.Terminal.Reader>>
- Defined in node_modules/stripe/types/TestHelpers/Terminal/ReadersResource.d.ts:112
presentPaymentMethod(
id: string,
options?: RequestOptions,
): Promise<Response<Stripe.Terminal.Reader>>
Presents a payment method on a simulated reader. Can be used to simulate accepting a payment, saving a card or refunding a transaction.
Parameters
- id: string
- Optionaloptions: RequestOptions
Returns Promise<Response<Stripe.Terminal.Reader>>
- Defined in node_modules/stripe/types/TestHelpers/Terminal/ReadersResource.d.ts:117

succeedInputCollection

succeedInputCollection(
    id: string,
    params?: Stripe.TestHelpers.Terminal.ReaderSucceedInputCollectionParams,
    options?: RequestOptions,
): Promise<Response<Stripe.Terminal.Reader>>
Use this endpoint to trigger a successful input collection on a simulated reader.
Parameters
- id: string
- Optionalparams: Stripe.TestHelpers.Terminal.ReaderSucceedInputCollectionParams
- Optionaloptions: RequestOptions
Returns Promise<Response<Stripe.Terminal.Reader>>
- Defined in node_modules/stripe/types/TestHelpers/Terminal/ReadersResource.d.ts:125
succeedInputCollection(
id: string,
options?: RequestOptions,
): Promise<Response<Stripe.Terminal.Reader>>
Use this endpoint to trigger a successful input collection on a simulated reader.
Parameters
- id: string
- Optionaloptions: RequestOptions
Returns Promise<Response<Stripe.Terminal.Reader>>
- Defined in node_modules/stripe/types/TestHelpers/Terminal/ReadersResource.d.ts:130

timeoutInputCollection

timeoutInputCollection(
    id: string,
    params?: ReaderTimeoutInputCollectionParams,
    options?: RequestOptions,
): Promise<Response<Stripe.Terminal.Reader>>
Use this endpoint to complete an input collection with a timeout error on a simulated reader.
Parameters
- id: string
- Optionalparams: ReaderTimeoutInputCollectionParams
- Optionaloptions: RequestOptions
Returns Promise<Response<Stripe.Terminal.Reader>>
- Defined in node_modules/stripe/types/TestHelpers/Terminal/ReadersResource.d.ts:138
timeoutInputCollection(
id: string,
options?: RequestOptions,
): Promise<Response<Stripe.Terminal.Reader>>
Use this endpoint to complete an input collection with a timeout error on a simulated reader.
Parameters
- id: string
- Optionaloptions: RequestOptions
Returns Promise<Response<Stripe.Terminal.Reader>>
- Defined in node_modules/stripe/types/TestHelpers/Terminal/ReadersResource.d.ts:143