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.

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 from Postman Collection. Both the desktop application and the web version are supported.
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 techsupport@edfapay.com.
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. The collection will appear in your left sidebar under Collections.
Configure environment variables — Navigate to the Environments tab and select the EdfaPay environment included with the collection. Update the variable values with your merchant credentials. Refer to the Environment Variables Reference section below.
Select the active environment — Using the environment selector in the top-right corner of Postman, ensure the EdfaPay environment is set as active before sending any requests.
Send a test request — Begin with the Sale (S2S) request using one of the provided test card numbers to verify your setup is working correctly.

Environment Variables Reference

The following variables must be configured in your Postman environment before making API requests. All fields are required unless noted otherwise.

Variable	Description	Example Value
`base_url`	The API base URL for the target environment. See Environments below.	`https://revamp.edfapay.com`
`client_key`	Your unique merchant client key, issued upon registration.	`your_client_key_here`
`password`	Your merchant secret hash password, used for generating the authentication hash.	`your_secret_password`
`payer_email`	Email address used in hash generation during test requests.	`test@example.com`
`order_id`	A unique identifier for each test order. May be auto-generated or manually set.	`TEST-ORDER-001`
`order_amount`	The transaction amount for test requests, expressed as a decimal value.	`10.00`
`order_currency`	ISO 4217 three-letter currency code.	`SAR`

🔒
Security Notice:
Never expose your password or client_key in shared collections or version-controlled files. Use Postman's Secret variable type to mask sensitive values and prevent accidental exposure.

Environments

EdfaPay provides two separate environments. All development and integration testing must be performed in the Sandbox environment. The Production environment is reserved for live transactions only.

Environment	Purpose	Base URL
Sandbox	Integration testing and development	`https://revamp.edfapay.com`
Production	Live transactions only	`https://app.edfapay.com`

To switch between environments, update the base_url variable in your active Postman environment. No other changes to the collection are required. Ensure your credentials are also updated to match the target environment.

⚠️
Note:
Apple Pay cannot be tested in the Sandbox environment. A Production environment with a valid Apple Merchant ID is required for Apple Pay testing.

What to Test

We recommend validating the following operations before proceeding to a production integration. Each corresponds to a pre-configured request within the collection.

Operation	Description	Collection Folder
Sale (S2S)	Server-to-server payment authorization and capture in a single step.	Payments / Sale
Auth & Capture	Two-step flow: authorize a hold on the card, then capture the funds.	Payments / Auth, Capture
Refund	Full or partial reversal of a completed transaction.	Payments / Refund
Recurring	Subsequent charge against a previously tokenized card.	Payments / Recurring
Webhook Callback	Confirm that your notification endpoint correctly receives and validates EdfaPay webhook events.	Webhooks
Decline Handling	Test error scenarios using decline-triggering test cards to verify your error handling logic.	Testing / Decline Codes

📘
Test Cards:
Use EdfaPay-provided test card numbers to simulate specific payment outcomes in the Sandbox. Refer to the Test Cards documentation for a full list of available card numbers and their associated scenarios. Test cards will not trigger real financial transactions.

Troubleshooting

Issue	Likely Cause	Resolution
`AUTH_HASH_INVALID`	Incorrect hash generation — wrong fields, ordering, or password.	Review the Authentication guide and regenerate the hash using the correct formula.
`INVALID_CLIENT_KEY`	Incorrect or missing `client_key` environment variable.	Verify the value in your Postman environment matches the key issued by EdfaPay.
`UNSECURE_CONNECTION`	Request sent over HTTP instead of HTTPS.	Confirm the `base_url` variable uses `https://`.
No response/timeout	Postman is configured to use a proxy, or there is a network connectivity issue.	Check Postman proxy settings under Settings > Proxy and disable if not required.
Environment variables not resolved	No active environment selected in Postman.	Ensure the EdfaPay environment is selected from the top-right environment dropdown.

Related Resources

Authentication — Understand the hash-based authentication mechanism used in all API requests.
Test Cards — Full list of test card numbers for simulating payment outcomes in the Sandbox.
Sandbox Environment — Details on the Sandbox setup and configuration.
Webhook Validation — Learn how to validate incoming webhook notifications from EdfaPay.
Go Live Checklist — Steps to complete before transitioning to the Production environment.

💬
Need help?
Contact the EdfaPay integrations support team at support@edfapay.com.