API Reference

Overview

EdfaPay Payment Gateway Integration Guide: Overview

This comprehensive guide equips developers with the essential knowledge and resources for seamless and secure integration and operation of the EdfaPay Payment Gateway.


Key Integration Areas:

  • API Connectivity: Master the process of securely connecting and interacting with EdfaPay's robust APIs.
  • Enhanced Security: Implement industry-standard authentication protocols to safeguard all communication and transactions.
  • Thorough Validation: Leverage dedicated sandbox environments for comprehensive testing and validation of your integration.
  • Complete Transaction Lifecycle: Confidently manage payment initiation, processing, real-time updates (callbacks), and reconciliation.
  • Proactive Error Management: Understand common error codes and apply effective troubleshooting strategies for swift resolution.

Guide Structure: Core Components

SectionKey Focus
API AuthenticationSecurely authenticate all API requests using client_key, password, and hash to protect data integrity.
Payment WorkflowsDetailed walkthroughs for initiating, processing, and verifying payments, including advanced 3D Secure protocols.
Callback IntegrationComprehensive instructions for implementing server-to-server callbacks to efficiently handle real-time payment status updates.
Environment SetupGuidelines for distinguishing and configuring sandbox and production environments, along with best practices for seamless transitions.
Transaction ManagementProcedures for retrieving transaction statuses, managing refunds and voids, and ensuring accurate financial reconciliation.
Error HandlingAn exhaustive reference of error codes, their explanations, and practical troubleshooting guidance to minimize downtime.

Available Resources & Tools:

Leverage the following resources to accelerate your integration and development:

  • Postman Collections. Pre-configured collections to streamline API testing and development workflows.
  • Sample API Requests & Responses: Practical code examples provided in multiple programming languages for quick implementation.
  • Test Card Data: Essential data sets for validating sandbox integrations and simulating various payment scenarios.
  • Dashboard User Manuals: Comprehensive operational guides available in both English and Arabic.