API Explorer
Explore and run ePay API requests with an interactive request builder for the ePay Payments API.
Initialize Payment Session
/public/api/v1/cit
Initializes a new payment session with the ePay Payments API. This endpoint requires a valid ApiKey and must be called from the server side to ensure the ApiKey is never exposed client-side.
You’ll receive the outcome of the payment session on the notificationUrl you provide within the request, making it the primary way to track the result of this payment. Webhooks can be used separately if you need broader, system-wide updates.
We recommend a minimum timeout of 5 seconds.
Required or configurable fields
In the ePay backoffice, under Advanced Point of Sale Settings, you can set default values for many session initialization parameters. This allows you to manage your setup without updating your code.
Each property must be defined either in the backoffice or in the API request. If a value is provided in the API request, it overrides the backoffice default.
The following fields can be configured:
scaModetimeoutinstantCaptureprocessormaxAttemptsnotificationUrlsuccessUrlfailureUrlexemptionsNote: Only a subset of these fields are strictly required for the API request. The table below indicates which fields are mandatory or optional.
Authentication
Paste a key, or log in to ePay test.