{
  "opencollection": "1.0.0",
  "info": {
    "name": "SumUp REST Checkouts Readers API",
    "version": "1.0.0"
  },
  "items": [
    {
      "info": {
        "name": "Readers",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List Readers",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.sumup.com/v0.1/merchants/:merchant_code/readers",
            "params": [
              {
                "name": "merchant_code",
                "value": "",
                "type": "path",
                "description": "Short unique identifier for the merchant."
              }
            ]
          },
          "docs": "List all readers of the merchant."
        },
        {
          "info": {
            "name": "Create a Reader",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.sumup.com/v0.1/merchants/:merchant_code/readers",
            "params": [
              {
                "name": "merchant_code",
                "value": "",
                "type": "path",
                "description": "Short unique identifier for the merchant."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Create a new Reader for the merchant account."
        },
        {
          "info": {
            "name": "Retrieve a Reader",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.sumup.com/v0.1/merchants/:merchant_code/readers/:reader_id",
            "headers": [
              {
                "name": "If-Modified-Since",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "merchant_code",
                "value": "",
                "type": "path",
                "description": "Short unique identifier for the merchant."
              },
              {
                "name": "reader_id",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the reader."
              }
            ]
          },
          "docs": "Retrieve a Reader."
        },
        {
          "info": {
            "name": "Update a Reader",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "https://api.sumup.com/v0.1/merchants/:merchant_code/readers/:reader_id",
            "params": [
              {
                "name": "merchant_code",
                "value": "",
                "type": "path",
                "description": "Short unique identifier for the merchant."
              },
              {
                "name": "reader_id",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the reader."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Update a Reader."
        },
        {
          "info": {
            "name": "Delete a reader",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://api.sumup.com/v0.1/merchants/:merchant_code/readers/:reader_id",
            "params": [
              {
                "name": "merchant_code",
                "value": "",
                "type": "path",
                "description": "Short unique identifier for the merchant."
              },
              {
                "name": "reader_id",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the reader."
              }
            ]
          },
          "docs": "Delete a reader."
        },
        {
          "info": {
            "name": "Create a Reader Checkout",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.sumup.com/v0.1/merchants/:merchant_code/readers/:reader_id/checkout",
            "params": [
              {
                "name": "merchant_code",
                "value": "MC0X0ABC",
                "type": "path",
                "description": "Merchant Code"
              },
              {
                "name": "reader_id",
                "value": "rdr_3MSAFM23CK82VSTT4BN6RWSQ65",
                "type": "path",
                "description": "The unique identifier of the Reader"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Creates a Checkout for a Reader.\n\nThis process is asynchronous and the actual transaction may take some time to be started on the device.\n\n\nThere are some caveats when using this endpoint:\n* The target device must be online, otherwise checkout won't be accepted\n* 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.\n\n\n**Note**: If the target device is a Solo, it must be in ve"
        },
        {
          "info": {
            "name": "Get a Reader Status",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.sumup.com/v0.1/merchants/:merchant_code/readers/:reader_id/status",
            "params": [
              {
                "name": "merchant_code",
                "value": "MC0X0ABC",
                "type": "path",
                "description": "Merchant Code"
              },
              {
                "name": "reader_id",
                "value": "rdr_3MSAFM23CK82VSTT4BN6RWSQ65",
                "type": "path",
                "description": "The unique identifier of the Reader"
              }
            ]
          },
          "docs": "Provides the last known status for a Reader.\n\nThis endpoint allows you to retrieve updates from the connected card reader, including the current screen being displayed during the payment process and the device status (battery level, connectivity, and update state).\n\nSupported States\n\n* `IDLE` – Reader ready for next transaction\n* `SELECTING_TIP` – Waiting for tip input\n* `WAITING_FOR_CARD` – Awaiting card insert/tap\n* `WAITING_FOR_PIN` – Waiting for PIN entry\n* `WAITING_FOR_SIGNATURE` – Waiting "
        },
        {
          "info": {
            "name": "Terminate a Reader Checkout",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.sumup.com/v0.1/merchants/:merchant_code/readers/:reader_id/terminate",
            "params": [
              {
                "name": "merchant_code",
                "value": "MC0X0ABC",
                "type": "path",
                "description": "Merchant Code"
              },
              {
                "name": "reader_id",
                "value": "rdr_3MSAFM23CK82VSTT4BN6RWSQ65",
                "type": "path",
                "description": "The unique identifier of the Reader"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Terminate a Reader Checkout stops the current transaction on the target device.\n\nThis process is asynchronous and the actual termination may take some time to be performed on the device.\n\n\nThere are some caveats when using this endpoint:\n* The target device must be online, otherwise terminate won't be accepted\n* The action will succeed only if the device is waiting for cardholder action: e.g: waiting for card, waiting for PIN, etc.\n* There is no confirmation of the termination.\n\nIf a transaction"
        }
      ]
    }
  ],
  "bundled": true
}