Release NotesAnnouncementsBlogFAQSupport
API Reference

Get a signature

post
https://deviceIpOrHost:12346/connect/v1/device/read-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.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Message used to call to the display endpoint sends a text string.

boolean

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

string
enum

  • 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: "..."

  • 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]]]"

Allowed:
Headers
string
required

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

string
required

The Clover device to route the request to.

string
required

An identifier for the POS making the request.

integer
0 to 300

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.

string

The idempotency key transmitted during the request, if any.

Responses

Updated 2 months ago

Language
Credentials
Bearer
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 2 months ago