GET Remote Reader API
Get Website
  1. Schemas
GET Remote Reader API
  • Basic Information
  • General
    • Get the configuration of the device
      GET
    • Cancel an active job
      GET
  • Status
    • Get the status of an asynchronous display operation on the device's screen (UI related)
    • Get the status of an asynchronous NFC tag interaction (NFC related)
  • POS
    • Start a job for a purchase
    • Initiate a refund job for a specific purchase
  • Ticketing
    • Start a job to swap a ticket to a NFC-tag
  • Display
    • Start a job to show information and interactive buttons on the device's UI
  • TagInfo
    • Start a job that prompts the end-user to scan an NFC tag
  • Schemas
    • Schemas
      • ApiBaseResponseApiDeviceConfigResponse
      • ApiErrorResponse
      • ApiDeviceConfigResponse
      • ApiPaymentType
      • ApiBaseResponseDisplayOnUiStatusResponse
      • DisplayOnUiResult
      • DisplayOnUiStatusResponse
      • ApiBaseResponseApiRequestStatusResponse
      • ApiBooleanField
      • ApiIntegerField
      • ApiNfcTagFields
      • ApiRequestStatusResponse
      • ApiWalletSnapshot
      • ApiBaseResponseApiJobStartedResponse
      • ApiJobStartedResponse
      • ApiJwtTicketingRequest
      • ApiDirectPurchaseRequest
      • ApiDirectPurchaseRequestCartItem
      • ApiRequestReference
      • ApiRefundRequest
      • Button
      • ApiTicketingRequest
      • DisplayOnUiRequest
      • TagInfoRequest
Get Website
  1. Schemas

ApiRefundRequest

Request object for a refund

{
    "externalId": "123e4567-e89b-12d3-a456-426614174000",
    "allowUserCancel": true
}
Built with