Skip to content

CloudLink API Documentation

Welcome to the CloudLink API documentation. This API provides a comprehensive solution for integrating with payment devices through either webhooks or polling for updates. Please take this into consideration before starting the implementation process.

Getting Started

API Flows

Terminal Responses

Merchant Configuration

Additional Information

🔍 Key Features

Multi-Tenant Merchant Configuration

  • Multiple Merchants per Device - 4 dentists can share one payment device
  • Independent Configurations - Each merchant has unique ID, currency, and settings
  • Multi-Currency Support - Handle EUR, USD, GBP, and other currencies
  • Cost Efficiency - Multiple businesses share hardware costs

Enhanced Sale Requests

  • Merchant Selection - Choose which merchant profile to use
  • Tip Amount Support - Add tips to transactions
  • Voucher Code Processing - Mastercard voucher redemption
  • Whitelist Filtering - Control AIDs and BINs

Comprehensive Terminal Responses

  • 50+ Response Fields - Complete transaction visibility
  • Enhanced Features - Tip, voucher, and wallet information
  • Security Details - CVM results, signature data, and verification
  • Location & Timing - Terminal coordinates and timestamps
  • Card Information - Detailed card type and issuer data

Advanced Receipt Formatting

  • Rich Text Support - Font sizes (Small, Normal, Big)
  • Multiple Alignments - Left, Right, Center, Split, QR code
  • Text Styling - Normal, Bold, Italic, Underline
  • Special Elements - QR codes, barcodes, logos, empty lines
  • Professional Receipts - Consistent formatting for display and printing

Flexible Integration Patterns

  • Webhook Support - Real-time callback notifications
  • Polling Support - Request-based response retrieval
  • Rate Limiting - Controlled API usage