Class Readers

Hierarchy

APIResource
- Readers

Index

Constructors

Properties

Methods

create createCheckout deleteReader get list terminateCheckout update

Constructors

constructor

new Readers(client: SumUp): SumUp.Readers
Parameters
- client: SumUp
Returns SumUp.Readers
Inherited from Core.APIResource.constructor
- Defined in core.ts:8

Properties

`Protected`_client

_client: SumUp

Methods

create

create(
    merchantCode: string,
    body: CreateReaderParams,
    params?: FetchParams,
): APIPromise<Reader>
Create a Reader
Parameters
- merchantCode: string
- body: CreateReaderParams
- Optionalparams: FetchParams
Returns APIPromise<Reader>
- Defined in resources/readers/index.ts:239

createCheckout

createCheckout(
    merchantCode: string,
    id: string,
    body: CreateReaderCheckout,
    params?: FetchParams,
): APIPromise<void>
Create a Reader Checkout
Parameters
- merchantCode: string
- id: string
- body: CreateReaderCheckout
- Optionalparams: FetchParams
Returns APIPromise<void>
- Defined in resources/readers/index.ts:199

deleteReader

deleteReader(
    merchantCode: string,
    id: string,
    params?: FetchParams,
): APIPromise<void>
Delete a reader
Parameters
- merchantCode: string
- id: string
- Optionalparams: FetchParams
Returns APIPromise<void>
- Defined in resources/readers/index.ts:268

get

get(merchantCode: string, id: string, params?: FetchParams): APIPromise<Reader>
Retrieve a Reader
Parameters
- merchantCode: string
- id: string
- Optionalparams: FetchParams
Returns APIPromise<Reader>
- Defined in resources/readers/index.ts:254

list

list(merchantCode: string, params?: FetchParams): APIPromise<void>
List Readers
Parameters
- merchantCode: string
- Optionalparams: FetchParams
Returns APIPromise<void>
- Defined in resources/readers/index.ts:229

terminateCheckout

terminateCheckout(
    merchantCode: string,
    id: string,
    params?: FetchParams,
): APIPromise<void>
Create a Reader Terminate action
Parameters
- merchantCode: string
- id: string
- Optionalparams: FetchParams
Returns APIPromise<void>
- Defined in resources/readers/index.ts:215

update

update(
    merchantCode: string,
    id: string,
    body: UpdateReaderParams,
    params?: FetchParams,
): APIPromise<Reader>
Update a Reader
Parameters
- merchantCode: string
- id: string
- body: UpdateReaderParams
- Optionalparams: FetchParams
Returns APIPromise<Reader>
- Defined in resources/readers/index.ts:282