Skip to main content

Create Payment Link

POST 
/public/api/v1/payment-links

Creates a new payment link 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.

Required fields

In the ePay backoffice in the advanced Point of Sale settings you can set the default for many of the session initialization parameters, allowing you to change your setup from the interface without updating your code.

Properties must be defined in either the point of sale settings or the API request. The API request takes precedence and overwrites any point of sale settings if present.

These fields are:

  • scaMode
  • timeout
  • instantCapture
  • processor
  • maxAttempts
  • notificationUrl
  • successUrl
  • failureUrl

Request​

Responses​

Successful payment link creation response.