Getting a signature

A merchant may need the customer's signature to acknowledge receipt of an item or indicate their approval to a question. To capture a signature, use the /v1/device/read-signature endpoint.

📘

NOTE

Signatures for payments are captured automatically during the payment flow based on the verification rules set by the card brands.

Prerequisites

  • The POS is connected to the device using a network or cloud connection
  • The Clover device is in an idle state (that is, no payment is being taken)

Getting signature data

The signature data returned by this endpoint can be a Base64-encoded BMP, JPG, PNG, SVG.

To capture a signature on the device, do the following.

  1. Construct a request with the signatureFormat you want to receive in response.
{
  "signatureFormat": "SVG"
}
  1. Send a POST request to the /v1/device/read-signature endpoint. Be sure to include the required headers for the request you are making.

The signature screen is shown on the device. When the customer signs and accepts the signature, a message is returned that contains the signature data.

{
    "signature": {
        "data": "PHN2ZyB2ZXJzaW9uPSIxLjEiIHhtbG5zPSJodHRwOi8vd3d3LnczLm9yZy8yMDAwL3N2ZyIgYmFzZVByb2ZpbGU9ImZ1bGwiIHdpZHRoPSI1MjQiIGhlaWdodD0iOTgiPjxwb2x5bGluZSBwb2ludHM9IjAgOTUgNiA5NyAxMSA5NSAxNyA5MiAyNSA4NSAzNSA3MiA0NiA1NSA1NiAzOCA2NSAyMiA2OSAxMyA3MyA2IDc3IDAgNzkgMCA4NCA5IDkzIDIyIDEwNCAzNSAxMTYgNDggMTM0IDU2IDE1NCA2MiAxNzkgNjIgMjA2IDU3IDIzNCA0NyAyNjQgMzYgMjkyIDI2IDMxNiAxOSAzMzYgMTUgMzUzIDE3IDM2MyAyMiAzNzMgMzAgMzg1IDQ0IDM5NiA1NSA0MDggNjIgNDI0IDY3IDQ0NCA2OCA0NjcgNjMgNTAxIDU2IDUyMyA1MSIgc3Ryb2tlPSJibGFjayIgZmlsbD0idHJhbnNwYXJlbnQiIHN0cm9rZS13aWR0aD0iMiIvPjwvc3ZnPg==",
        "format": "SVG",
        "gzip": false
    }
}

See Showing the welcome screen for instructions on displaying the default idle screen, or take the action that is appropriate for your situation.


Did this page help you?