Sign in

v1

latestOpenAPI 3.0.12026-07-242871595.3 MB
DEVICE

Get a signature

Displays the signature entry screen so the user can acknowledge acceptance with their signatures. Apps do not need to call this endpoint to get a customer's signature for a payment. The signature screen will appear automatically if the merchant's settings are configured to require one for a given transaction.

post/v1/device/read-signature

Headers

User-Agentstring required

Identifies the application, operating system, vendor, and/or version of the requesting user agent. Format: <AppName>/<Version> <Comment>

X-Clover-Device-Idstring required

The Clover device to route the request to.

X-POS-Idstring required

An identifier for the POS making the request.

X-Clover-Timeoutinteger

The amount of time, in seconds, that this operation will process before timing out. A value of 0 indicates no timeout will be enforced by Remote Pay, although protocol specified timeouts may still apply.

Idempotency-Keystring

The idempotency key transmitted during the request, if any.

Request body

gzipboolean

A flag that indicates true if the data should be gzipped before performing the base64 encoding

signatureFormat'PNG' | 'JPG' | 'BMP' | 'SVG' | 'RAW'

  • PNG - The image data will be a PNG image in base-64 format. Example: "RXhhbXBsZSBpbWFnZQ=="

  • JPG - The image data will be a Jpeg image in base-64 format. Example: "RXhhbXBsZSBpbWFnZQ=="

  • BMP - The image data will be a Bitmap image in base-64 format. Example: "RXhhbXBsZSBpbWFnZQ=="

  • SVG - The image data will be the HTML representation of an SVG element. Example: "<svg>...</svg>"

  • RAW - The image data will be an array of array of points in JSON format. Example: "[[[10,0],[20,20],[0,20],[10,0]],[[20,0],[30,20],[40,0],[20,0]]]"

Example request

{
  "beep": true,
  "signatureFormat": "JPG",
  "text": "some text"
}

Response

Returns the signature image data in the specified format

Example response

{
  "signature": {
    "format": "BMP",
    "gzip": true,
    "response": "<base64-encoded, gzipped data>"
  }
}