Set up your account
Before you create your first payment, you need a few values from ePay Backoffice.
This page shows you what you need and where to find it.
What you need
To create a payment, you usually need:
| Value | What it is used for |
|---|---|
| API key | Used by your backend to authenticate requests to ePay |
| Point of Sale ID | Identifies which webshop, sales channel or system the payment belongs to |
| Amount | The amount the customer should pay |
| Currency | The currency of the payment |
| Reference | Your own order or payment reference |
| Notification URL | The URL where ePay sends the payment result |
| Success URL | Where the customer is sent after a successful payment |
| Failure URL | Where the customer is sent after a failed payment |
If you use a plugin, some of these values are added in your webshop admin instead of directly in code.
In practice, a Point of Sale usually maps to your webshop, domain, app or another sales channel configured in ePay.
Find your API key
Your API key is used to authenticate requests from your backend to ePay.
Never expose your API key in frontend code.
To find your API key:
Open ePay Backoffice
Go to Developers
Find your test API key
Copy the key and store it securely
Use the test API key while building your integration.
When your account is ready for live payments, you will switch to a live API key.
Find your Point of Sale ID
A Point of Sale represents where the payment happens.
For an online store, this is usually your webshop or domain. For other setups, it can represent a specific sales channel, system or location.
To find your Point of Sale ID:
Open ePay Backoffice
Go to Point of Sale
Select the relevant Point of Sale
Copy the Point of Sale ID
You will use this ID when creating payments.
Understand test and live values
Test mode and live mode use different values.
When you are building and testing, use test values.
When you go live, make sure you switch to live values.
| Value | Test mode | Live mode |
|---|---|---|
| API key | Test API key | Live API key |
| Point of Sale | Test Point of Sale | Live Point of Sale |
| Payments | Simulated payments | Real payments |
| Money movement | No real money | Real money |
Prepare your backend
If you build a custom integration, payment creation must happen on your backend.
This is because your API key must stay secret.
Your frontend can ask your backend to create a payment, but the frontend should never call the ePay API directly with your secret API key.
Recommended flow:
Customer starts checkout
Frontend calls your backend
Backend creates a payment session with ePay
Backend returns the payment information needed by the frontend
Customer completes the payment
Prepare your notification URL
Your notification URL is where ePay sends the payment result.
This is important because a customer may close the browser before returning to your website.
Do not mark an order as paid only because the customer reaches your success page.
Use the notification from ePay to update your backend order status.
Your notification URL should:
- Be publicly available
- Accept requests from ePay
- Return a successful response when processed
- Handle duplicate notifications safely
- Update the correct order in your system
Account setup checklist
Before continuing, make sure you have:
- Access to ePay Backoffice
- An API key
- A Point of Sale ID
- A backend endpoint for creating payments, if you build a custom integration
- A notification URL, if your integration needs to update order status automatically
Next step: Create your first payment