What you can build with our technology
Build solutions for all your banking needs. Use our sandbox to create and test everything from card creation to statements and more.
Interactive developer tools
From SDKs to libraries and encryption tools, we provide a wide range of helpful and interactive tools to help you create your next solution.
Easy to read documentation
Our easy to read documentation takes the guess work out of integrations. Get everything from error codes to API responses all in one package
Regular updates and releases
Our change log keeps you updated on new product releases and changes made to existing products
Easy launch and customization
Self managed configurations make it easy to launch and customize our products to fit your specific business needs
24/7 monitoring and support
Get personalized help while you set up your account or have us design an API product specifically for your issuing needs
Enrich transactions with transparency
With TSYS Transaction Enrichment, issuers can easily provide cardholders clear purchase information, reducing unintended fraud and disputes and increasing cardholder satisfaction.
Discover how we make digital banking easier
We brought together everything that's required to build the next generation of issuing technology applications. TSYS products power everything from cardholder accounts, security and fraud, installment plans and everything in between.
TSYS OpenAPIs
API packages and tools that will form the core of your business and power your issuer technology solutions.
Event Streaming
Event notifications that are delivered in near-real-time enabling enterprise efficiencies and enhanced cardholder personalized experiences.
What you can build with our technology
Explore some of the ways you can leverage TSYS products to provide the latest and greatest services in the financial industry. Keep your business ahead of the curve and revolutionize how you do digital banking.
Rewards & Incentive Programs
The cards platform processes and sends batch files to the Card Printing Service (CPS) which, in turn, prints the actual plastic card.
Overdraft Protection
The authorizations platform provides transaction details and manages, verifies and posts transactions to a cardholder account.
Fraud detection
The fraud platform comes with tracking, case management and reports to help prevent any unauthorized activity on an account
Data visualization
Empower your digital banks with data. Use our query editor and endless ways to visualize.
TSYS Merchant Solutions Documentation
Complete guides, API references, and integration resources to help you build powerful payment solutions.
Welcome to TSYS Merchant Solutions
Thank you for choosing TSYS Merchant Solutions as your payment processing partner. This comprehensive documentation will guide you through integrating our powerful payment gateway into your applications, websites, and mobile platforms. Whether you're a seasoned developer or just getting started, you'll find everything you need to build secure, scalable payment solutions.
Our platform supports a wide range of integration methods including Hosted Payment Pages, Direct API Integration, E-commerce Plugins, and Mobile SDKs for iOS and Android. With industry-leading security standards including PCI DSS Level 1 compliance, tokenization, and advanced fraud detection, you can process payments with confidence.
Getting Started
Follow these steps to begin your integration journey with TSYS Merchant Solutions.
1. Create Your Account
Sign up for a TSYS Merchant Solutions account through our developer portal. Complete the merchant application process and receive your account credentials including Merchant ID, API Key, and API Secret.
2. Access Sandbox Environment
Once approved, you'll receive access to our sandbox environment. This safe testing space allows you to explore all API endpoints and integration methods without processing real transactions.
3. Choose Integration Method
Select the integration approach that best fits your business needs: Hosted Payments for quick setup, Direct API for full control, Plugins for popular platforms, or Mobile SDKs for native apps.
4. Implement & Test
Follow our detailed integration guides to implement your chosen solution. Use our comprehensive test card numbers and sandbox environment to validate all payment scenarios before going live.
Integration Guides
Choose from multiple integration options designed to fit your technical requirements and business needs.
Hosted Payment Pages
Our Hosted Payment solution provides the quickest path to accepting payments. Simply redirect customers to our secure, customizable payment page. We handle all PCI compliance, security, and payment processing. Perfect for businesses that want to minimize development time while maintaining a professional payment experience.
- Quick 5-minute setup
- Fully customizable branding
- Automatic PCI compliance
- Mobile-responsive design
API Integration
For developers who need complete control over the payment experience, our RESTful API provides full access to all platform features. Build custom checkout flows, implement advanced fraud rules, and create seamless payment experiences directly within your application.
- Full control over UX/UI
- Real-time transaction processing
- Advanced fraud management
- Comprehensive webhook support
E-commerce Plugins
Pre-built plugins for popular e-commerce platforms including WooCommerce, Magento, Shopify, and PrestaShop. Install, configure your credentials, and start accepting payments within minutes. No coding required.
- One-click installation
- Automatic updates
- Platform-native experience
- 24/7 plugin support
Mobile SDKs
Native SDKs for iOS and Android enable secure in-app payments with built-in tokenization and encryption. Support for Apple Pay, Google Pay, and traditional card payments. Optimized for performance and security on mobile devices.
- iOS & Android support
- Apple Pay & Google Pay ready
- Built-in card scanning
- Biometric authentication
API Reference
Complete reference for the TSYS Merchant Solutions REST API. All requests use JSON format and require authentication via API keys.
Authentication
All API requests require authentication using your API Key and API Secret. Include these in the Authorization header using Basic Auth format:
Base URL
https://sandbox-api.tsysmerchantsolutions.com/v1
https://api.tsysmerchantsolutions.com/v1
Response Codes
- 200 - Success
- 201 - Created
- 400 - Bad Request
- 401 - Unauthorized
- 404 - Not Found
- 500 - Server Error
Core Endpoints
| Endpoint | Method | Description |
|---|---|---|
| /transactions | POST | Process a new payment |
| /transactions/{id} | GET | Retrieve transaction details |
| /transactions/{id}/refund | POST | Process a refund |
| /customers | POST | Create a customer profile |
| /tokens | POST | Tokenize a payment method |
Payments & Transactions
Understanding payment processing, transaction types, and management features.
Transaction Types
- Sale: Immediate charge to customer's card
- Authorization: Hold funds without charging
- Capture: Complete a previously authorized transaction
- Refund: Return funds to customer's card
- Void: Cancel a transaction before settlement
Payment Methods
- Credit & Debit Cards (Visa, Mastercard, Amex, Discover)
- Digital Wallets (Apple Pay, Google Pay)
- ACH Bank Transfers
- Buy Now Pay Later options
- Gift Cards & Store Credits
Transaction Lifecycle
Every transaction progresses through specific stages from initiation to completion:
- Initiated: Transaction request received
- Processing: Undergoing fraud checks and authorization
- Authorized: Approved by issuing bank
- Captured: Funds transferred to merchant
- Settled: Transaction complete, funds deposited
- Refunded/Voided: Transaction reversed if needed
Webhooks & Events
Real-time notifications for transaction events and account activities.
Webhook Setup
Configure webhook endpoints in your developer dashboard to receive real-time notifications. Each webhook includes a signature for verification and contains detailed event data in JSON format.
Event Types
- transaction.created
- transaction.approved
- transaction.declined
- transaction.captured
- transaction.refunded
- dispute.opened
- subscription.renewed
Webhook Payload Example
Security & Compliance
Industry-leading security standards and compliance certifications.
PCI DSS Compliance
TSYS Merchant Solutions maintains PCI DSS Level 1 certification, the highest level of security compliance in the payments industry. Our infrastructure undergoes annual audits and continuous security monitoring.
Tokenization
Replace sensitive card data with secure tokens that are useless if compromised. Our tokenization service ensures actual card numbers never touch your servers, reducing PCI scope and liability.
Encryption
All data transmission uses TLS 1.3 encryption. Sensitive data at rest is encrypted using AES-256. We employ end-to-end encryption for all payment flows to ensure maximum data protection.
Fraud Protection
Advanced fraud detection using machine learning, 3D Secure 2.0, address verification (AVS), and card verification value (CVV) checks. Customizable fraud rules and real-time risk scoring.
Testing & Sandbox
Comprehensive testing environment to validate your integration before going live.
Sandbox Environment
Our sandbox environment mirrors production functionality while using simulated data. Test all transaction types, webhooks, and error scenarios without processing real payments or incurring charges.
Test Card Numbers
| Card Number | Result |
|---|---|
| 4111111111111111 | Success |
| 4000000000000002 | Declined |
| 4000000000000127 | Insufficient Funds |
| 4000000000000069 | Expired Card |
Testing Scenarios
- Successful payments
- Declined transactions
- Refund processing
- Partial captures
- Webhook delivery
- Error handling
Going Live Checklist
- Switch to production API keys
- Update endpoint URLs
- Enable real-time notifications
- Configure fraud rules
- Test with small transactions
- Monitor dashboard closely
Support
We're here to help you succeed with your payment integration.
Developer Support
Technical support available for integration questions, API troubleshooting, and implementation guidance. Access our knowledge base, community forums, and direct developer support team.
- Email: developers@tsysmerchantsolutions.com
- Developer Portal: developers.tsysmerchantsolutions.com
- Response time: Within 24 hours
Merchant Support
24/7 support for transaction inquiries, account management, and operational questions. Phone and email support available for all merchant partners.
- Phone: 1-800-TSYS-HELP
- Email: support@tsysmerchantsolutions.com
- Available: 24/7/365
Resources
- API Status Page
- Developer Blog
- Integration Guides
- Code Samples & SDKs
- Video Tutorials
- Community Forum
Status & Updates
Stay informed about platform status, scheduled maintenance, and new feature releases. Subscribe to our developer newsletter for the latest updates and best practices.
- Status Page: status.tsysmerchantsolutions.com
- Subscribe to updates
- Follow @TSYSDev on Twitter