Payment Link Entity
A payment link in the Connect API represents:- Shareable Payment URL: Secure link that enables payment collection without authentication requirements
- Payment Context: Pre-configured payment information including amount, description, and customer details
- Distribution Channel: Links distributed via email, SMS, QR codes, or embedded in communications
- Expiration Management: Time-limited links with configurable expiration and usage policies
Key Capabilities
Link Generation
Generate secure, shareable payment links for any payment scenario or
customer interaction.
Multi-Channel Distribution
Distribute payment links through email, SMS, QR codes, and customer
communications.
Payment Tracking
Monitor payment link usage, completion rates, and transaction success
metrics.
Flexible Configuration
Configure payment amounts, descriptions, customer information, and
expiration policies.
Common Use Cases
Invoice Collection
Send payment links for outstanding invoices and billing statements via email
or SMS.
Remote Checkout
Enable order completion for customers without requiring account login or
registration.
Customer Support
Provide payment links during customer service interactions for immediate
payment resolution.
Marketing Campaigns
Include payment links in promotional communications and marketing materials.
Related Resources
Payment Link entities integrate with other Connect API resources:- Payment Sessions: Payment links redirect to hosted payment sessions for secure processing
- Payments: Track payments collected through payment link interactions
- Invoices: Generate payment links for specific invoices and billing statements
- Orders: Create payment links for order completion and checkout processes
- Customers: Associate payment links with customer accounts for tracking and management
- Payment Profiles: Enable payment profile creation through payment link completions