Importing the EdfaPay Postman Collection
This guide provides step-by-step instructions for importing and configuring the EdfaPay Postman Collection, enabling you to effectively test and integrate with EdfaPay APIs.
Step 1: Download the Collection File
Begin by downloading the latest EdfaPay Postman Collection. This collection is compatible with both Sandbox and Production environments.
| Environment | Download Link |
|---|---|
| Checkout Collection | Collection |
| Embedded Collection | Collection |
The same collection file is used for both Sandbox and Production environments. You will update the
base_urlvariable within Postman to switch between them.
Step 2: Open Postman and Initiate Import
Launch the Postman application on your computer. In the top-left menu, locate and click the Import button.
Step 3: Select the Collection File
In the Import window that appears, click Upload Files. Browse your local system and select the .json file you downloaded in Step 1.
Step 4: Verify Successful Import
Upon successful import, the EdfaPay API collection will be listed in the Collections panel on the left side of your Postman interface.
(Image: A screenshot showing the EdfaPay API collection listed in the Collections panel on the left.)
Step 5: Configure Environment Variables
Navigate to the Environments section in Postman. Create a new environment or edit an existing one, and then add the following essential variables:
| Variable | Description | Example Value |
|---|---|---|
client_key | Your unique EdfaPay client key. | xxxx-xxxxxx-xxxxxxxxx-xxxxx |
password | Your EdfaPay secret password. | *********-******-*******-****** |
base_url | The base URL for the EdfaPay API. | Sandbox: https://apidev.edfapay.comProduction: https://api.edfapay.com |
Step 6: Test an API Request
To ensure everything is configured correctly:
- Select the appropriate environment (Sandbox or Production) from the environment dropdown.
- Choose any request from the newly imported EdfaPay API collection.
- Click Send to execute the request and view the API response.
(Image: A screenshot showing an example API request being tested in Postman, with the response displayed.)
Important Security Note
Always protect your credentials. Never share yourclient_keyorpasswordin public Postman workspaces or repositories.
Prioritize Sandbox Testing
It is strongly recommended to test all API integrations thoroughly in the Sandbox environment (https://apidev.edfapay.com) before deploying to Production.