HomeGuidesAPI Reference
API Reference

Sandbox Checkout Integration Testing

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.


Integration Workflow

This section provides a step-by-step guide for integrating EdfaPay’s Checkout Solution.

1. Create Checkout
Send a POST request with order details and API Key.

2. Get Response
Extract the redirectURL or handle errors.

3. Redirect Customer
Send user to EdfaPay checkout page.

4. Payment Process
EdfaPay handles the payment and bank communication.

6. Webhook
Receive final status and update your system.

5. Handle Result
User is redirected back (successUrl / failureUrl).


Explore API Categories

Initiate Payment Link — Create and start a payment by sending order and customer details, with support for 3D Secure, tokenization, Apple Pay, and BNPL.

Get Transaction Status — Retrieve payment results and current transaction state.

Recurring Payment — Charge customers repeatedly using saved card tokens.


Key Features of EdfaPay Checkout Integration

FeatureDescription
Secure AuthenticationUses API key to ensure request integrity and merchant authenticity
3D Secure FlowSupports automatic redirection for enhanced transaction security
TokenizationSecurely stores card details for recurring and future payments
Webhook NotificationsSends real-time transaction updates to your backend
Sandbox Testing EnvironmentProvides a dedicated environment for testing and validation
Fraud Prevention MechanismsDetects and prevents fraud using IP, amount, and behavior analysis

Important Considerations

All API requests must include the API key in the header using the key X-API-KEY 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 API 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.