Use the GET /api/v1/signature/{laneId} endpoint to display text to the card holder and require them to sign. The signature endpoint supports two different forms: simple
and contract. The simple form contains only a signature box. The contract form contains a header, sub-header, text area, and signature box.
The simple signature form prompts the cardholder for their signature. This screen will remain on the Pinpad until the customer completes the signature and clicks "OK". Clicking "Cancel or Clear" will refresh the form, for the customer to reenter a signature until "OK" is clicked. An idle call will not cancel the Signature endpoint. A call to the signature endpoint is typically followed by a transaction (eg. a sale) or a call to the idle endpoint.
For example, selecting "OK" or "Cancel' will send triPOS the appropriate message indicator and the system screen will wait for the next command to proceed.
Example simple signature request:
GET http://localhost:8080/api/v1/signature/1?form=simple
The contract signature form prompts the cardholder for their signature and displays text in a scrolling text area. This screen will remain on the Pinpad until the customer completes the signature and clicks "OK". Clicking "Cancel or Clear" will refresh the form, for the customer to reenter a signature until "OK" is clicked. An idle call will not cancel the Signature endpoint. A call to the signature endpoint is typically followed by a transaction (eg. a sale) or a call to the idle endpoint.
The maximum number of characters for the contract signature form is 8,135 text characters.
Example contract signature request:
GET http://localhost:8080/api/v1/signature/1?form=contract&header=The%20Header&subHeader=The%20Subheader&text=A%20large%20text%20area