Checkout Integration - Overview
The EdfaPay Checkout Integration provides a robust and comprehensive suite of APIs designed to empower merchants with full control over the online payment experience. This integration ensures secure, seamless transactions while adhering to stringent compliance standards like PCI DSS and 3D Secure. It is ideal for platforms seeking to manage the entire payment lifecycle, from initiation to refunds and recurring payments.
Core Capabilities
EdfaPay's Checkout Integration covers the complete payment lifecycle, offering functionalities for:
- Initiating secure transactions
- Real-time transaction status checks
- Efficient refund processing
- Managing recurring payments and subscriptions
Explore Our API Categories
Initiate
The Initiate endpoint is the primary entry point for processing new transactions. Use it to start payments, provide essential order and customer details, and facilitate 3D Secure authentication. It supports secure hash authentication, tokenization, Apple Pay, and Buy Now, Pay Later (BNPL) options like Tamara.
Status
The Status API allows you to retrieve the real-time status of any transaction using its order or transaction ID. This is crucial for confirming payment results, validating successful transactions after customer redirection, and handling any delays in webhook notifications.
Refund
The Refund API enables you to return funds to customers for previously successful payments. It supports both full and partial refunds, accommodating same-day and delayed refund processes based on your merchant configuration.
Recurring
The Recurring API is designed for businesses with subscription or installment models, allowing you to charge customers repeatedly using a previously saved card token. This is perfect for managing subscriptions, scheduled payments, or any recurring billing.
Detailed API Endpoints
Initiate API
The Initiate API serves as the primary entry point for processing new payment transactions.
Key Uses:
- Start a new payment.
- Provide essential order and customer details.
- Facilitate 3D Secure authentication and redirection.
Features Supported:
- Secure hash authentication.
- Tokenization for saving card details.
- Alternative payment methods like Apple Pay and Buy Now, Pay Later (BNPL) options such as Tamara.
Status API
The Status API allows you to retrieve the real-time status of any transaction.
Key Uses:
- Confirm the final result of a payment using its order ID or transaction ID.
- Validate payment success after a customer has been redirected back to your site.
- Handle scenarios with potential delays in webhook notifications, ensuring transaction certainty.
Refund API
The Refund API is used to process refunds to customers for previously successful payments.
Key Features:
- Supports both full and partial refunds.
- Accommodates same-day and delayed refund processes, depending on your merchant configuration.
Recurring API
The Recurring API is specifically designed for businesses operating with subscription or installment payment models.
Key Uses:
- Charge customers repeatedly using a previously saved card token.
- Ideal for managing subscriptions, scheduled payments, or any form of recurring billing.
Key Features of EdfaPay Checkout Integration
- Secure Authentication: Robust hash-based mechanism ensures data integrity and security.
- 3D Secure Flow: Automatic redirection support for enhanced transaction security.
- Tokenization: Securely save card details for convenient and recurring payments.
- Webhook Notifications: Real-time updates on transaction statuses delivered directly to your backend.
- Sandbox Testing Environment: A dedicated environment for seamless integration and quality assurance.
- Fraud Prevention Mechanisms: Advanced tracking via IP, amount, and behavior patterns to minimize risks.
Important Considerations
- All API requests must include a valid client key and a secure hash for authentication.
- Proper webhook configuration is essential for receiving timely transaction updates on your backend.
- Always utilize the Sandbox environment for thorough testing before deploying to a live production environment.
- Specific payment methods like Apple Pay, Tamara, and Recurring payments may require special activation.
Security Best Practices
- Never expose your password or secret key in client-side code to prevent unauthorized access.
- Validate all webhook responses meticulously using the transaction ID and status to ensure data authenticity.
- Always use HTTPS for all environments (development, staging, production) to encrypt data in transit.
- Regularly monitor your callback endpoints for any failures or delays to ensure continuous service.