Accelerate your EdfaPay integration using our official Postman Collection. Pre-configured with all available API endpoints, environment variables, and example payloads — so you can begin testing immediately.
🚀 Access the Postman Collection
Start Testing Instantly
Open the official EdfaPay Postman Collection to explore all APIs with ready-made requests and environments.
Overview
The EdfaPay Postman Collection provides a fully structured, ready-to-use workspace for exploring and testing the EdfaPay Payment Gateway API. It includes pre-built request templates for all major operations, environment variable support for seamless credential management, and detailed example responses that reflect real-world transaction scenarios.
| Feature | Description |
|---|---|
| All Endpoints Included | Sale, Auth, Capture, Refund, Recurring, and more — all pre-configured. |
| Environment Variables | Manage Sandbox and Production credentials independently with a single toggle. |
| Example Payloads | Sample request bodies and expected responses for every endpoint. |
| Webhook Testing | Includes webhook simulation flows for validating your notification handling. |
Prerequisites
Before importing the EdfaPay Postman Collection, ensure the following requirements are met:
-
Install Postman — Download and install the latest version of Postman (desktop or web version).
-
Obtain your sandbox credentials — Ensure you have received your Sandbox Merchant Key and Merchant Password from EdfaPay. If you have not yet received these, contact [email protected].
-
Request the collection file — The EdfaPay Postman Collection JSON file is distributed directly by the EdfaPay integrations team. Contact your account representative or EdfaPay Support to receive the latest version.
Setting Up the Collection
Follow these steps to import and configure the EdfaPay Postman Collection:
-
Import the collection — Open Postman and select Import from the top navigation. Choose the JSON file provided by EdfaPay and confirm the import.
-
Configure environment variables — Navigate to the Environments tab and update variables with your merchant credentials.
-
Select the active environment — Ensure the correct environment is selected before sending requests.
-
Send a test request — Start with a sample request (e.g., Sale API) using test cards.
Environment Variables Reference
| Variable | Description | Example Value |
|---|---|---|
base_url | The API base URL for the target environment | https://demo-api.edfapay.com |
client_key | Your unique merchant client key | your_client_key_here |
password | Merchant secret used for authentication hash | your_secret_password |
payer_email | Email used in test requests | [email protected] |
order_id | Unique identifier for each order | TEST-ORDER-001 |
order_amount | Transaction amount | 10.00 |
order_currency | ISO currency code | SAR |
Security Notice
Never expose your credentials in shared collections. Use Postman's secret variables.
Environments
| Environment | Purpose | Base URL |
|---|---|---|
| Sandbox | Testing and development | https://demo-api.edfapay.com |
| Production | Live transactions | https://app-api.edfapay.com |
Apple Pay cannot be tested in Sandbox. Production setup is required.
What to Test
| Operation | Description |
|---|---|
| Sale (S2S) | Complete payment in one step |
| Auth & Capture | Two-step payment flow |
| Refund | Reverse transactions |
| Recurring | Charge saved cards |
| Webhook Callback | Validate webhook handling |
| Decline Handling | Test error scenarios |
Troubleshooting
| Issue | Cause | Solution |
|---|---|---|
| AUTH_HASH_INVALID | Wrong hash | Recalculate correctly |
| INVALID_CLIENT_KEY | Wrong API key | Verify credentials |
| Timeout | Network / proxy issue | Check Postman settings |
Related Resources
- Authentication
- Test Cards
- Sandbox Environment
- Webhook Validation
- Go Live Checklist