Creating an API Key
With a company and account configured, create an API Key to link your integration components.
Go to the API Key Menu --> 🗝
- Select your Account from the dropdown
- Enter your callback URL for HTTP POST notifications. --> Click on the Request button to complete
The system generates a unique API key.
important
Reach out to the iPay Team either directly, or via business@i-pay.io to activate your API key.
When you do, also provide your redirect URL — the page on your site where the customer should land after completing the payment (e.g. your deposit-success or dashboard page). The iPay team registers it together with your API key.
Callback URL vs. redirect URL
| Callback URL (IPN) | Redirect URL | |
|---|---|---|
| Who calls it | iPay server → your server (HTTP POST, JSON) | The customer's browser, after the payment is completed |
| Purpose | Credit the deposit in your system | Close the customer journey — show a confirmation page |
| Trust it for crediting? | Yes — this is the source of truth | No — a page load can be reached without a completed payment |
| Where it is set | Dashboard, when requesting the API key | Registered by the iPay team when activating the key |
Your redirect page should simply thank the customer and show the pending/credited status from your own records — the credit itself must come from the HTTP POST callback.