@sumup/sdk
    Preparing search index...

    Class Readers

    Hierarchy

    • APIResource
      • Readers
    Index

    Constructors

    Properties

    _client: SumUp

    Methods

    • Creates a Checkout for a Reader.

      This process is asynchronous and the actual transaction may take some time to be stared on the device.

      There are some caveats when using this endpoint:

      • The target device must be online, otherwise checkout won't be accepted
      • After the checkout is accepted, the system has 60 seconds to start the payment on the target device. During this time, any other checkout for the same device will be rejected.

      Note: If the target device is a Solo, it must be in version 3.3.24.3 or higher.

      Parameters

      Returns APIPromise<CreateReaderCheckoutResponse>

    • Delete a reader.

      Parameters

      • merchantCode: string
      • id: string
      • Optionalparams: FetchParams

      Returns APIPromise<void>

    • Retrieve a Reader.

      Parameters

      • merchantCode: string
      • id: string
      • Optionalparams: FetchParams

      Returns APIPromise<Reader>

    • List all readers of the merchant.

      Parameters

      • merchantCode: string
      • Optionalparams: FetchParams

      Returns APIPromise<ListReadersResponse>

    • Terminate a Reader Checkout stops the current transaction on the target device.

      This process is asynchronous and the actual termination may take some time to be performed on the device.

      There are some caveats when using this endpoint:

      • The target device must be online, otherwise terminate won't be accepted
      • The action will succeed only if the device is waiting for cardholder action: e.g: waiting for card, waiting for PIN, etc.
      • There is no confirmation of the termination.

      If a transaction is successfully terminated and return_url was provided on Checkout, the transaction status will be sent as failed to the provided URL.

      Note: If the target device is a Solo, it must be in version 3.3.28.0 or higher.

      Parameters

      Returns APIPromise<void>