📘

NOTE

For more information about REST Pay Display API or the Clover Connect partner program, contact a Clover Connect specialist.

You can use the following list of contents or the side navigation to view available information for REST Pay Display APIs.

Before you begin

• REST Pay Display API introduction
• REST Pay Display FAQs
• Get started using REST Pay Display API
  • Create a sandbox app
  • Get an OAuth token
  • Use Postman with the REST Pay Display API
• Device Connection Options
  • Configure a cloud connection
  • Configure a local connection
• Security
• REST Pay Display architecture

Workflows and best practices

• Transaction types
• REST Pay Display payment flows
• Interoperability with Ecommerce API
• Track transactions with idempotency keys
• Payment reconciliation and recovery

Issues and errors

• Handle issues and errors
  • Check for duplicate payments
  • Handle offline payments
  • Handle partial payments
  • Handle signature issues
• Handle communication issues
• Status codes and errors references

API tutorials

• REST Pay Display API tutorials

Device tutorials

• Verify connectivity
• Display a message to the customer
• Display the welcome screen
• Display the thank you screen
• Cancel the current action
• Get a signature
• Get customer confirmation
• Get customer input
• Request a tip
• Print a receipt
• Open the cash drawer
• Reset the device

Payment tutorials

• Make a sale
• Authorize and capture a tip-adjusted payment on paper
• Authorize and capture a payment with tip on screen
• Capture pre-auth payments
• Refund a charge
• Issue a credit

Card tutorials

• Create and use a card token
• Get a customer's card data

App review and approval

• Create a production app
• Test REST Pay Display flows (US)
• Test REST Pay Display flows (Canada)

API references

Card endpoints

• Read a card's track data using a Clover device
• Create a card token to use with subsequent payments

Credits endpoints

• Send a credit request to the Clover device
• Get a credit
• Refund a payment
• Void a payment

Device endpoints

• Cancel any in-flight operations
• Retrieve a list of cash drawers
• Open the specified cash drawer
• Display a message
• Verify connectivity
• Get the status of a print job
• Print an image
• Print text
• Retrieve a list of printers
• Get a user confirmation response
• Get a text response
• Get a signature
• Get a tip
• Get the device status
• Display a thank you screen
• Display the welcome screen
• Reset the device and cancel any in-flight operations

Payments endpoints

• Send a payment request to a Clover device
• Get a payment by externalPaymentId
• Get a payment
• Capture a pre-auth payment
• Increment an authorization (pre-auth)
• Tip adjust a payment

Receipts endpoints

• Display receipt options
• Deliver a credit receipt
• Deliver a payment receipt
• Deliver a refund receipt
• Deliver a void receipt