Elavon Payment Gateway - Payment Page (Redirect) API

8 steps
Redirect Customer's browser to payment page, after the payment Customer is redirected back to your shop. Official Integration Guide Official API reference
  1. Create order , that you are going to charge the customer for.
  2. Create payment session using the created order's id. This will respond with the url you need to redirect the customer to.
  3. You need to redirect the user to the url returned by elavon in the previous step.
  4. Wait for notification to confirm successful transaction creation or link expiration.
  5. The customer gets redirected from elaovn's site back to the return url
  6. Get the Payment-Session information by Retrieve Payment-Session that contains the transaction link.
  7. Get the transaction information by Retrieve Transaction
  8. Process the order based on Retrieve Payment-Session and Retrieve Transaction results, including ThreeDSecure data.
Good to know & Good to Go
  • You will need Processor Id, Public Key, Private Key and Merchant Alias. . You can find and generate test credentials from the Elavon Sandbox Account Form
  • You will need to send your authentication information in each call. You can read more about the details Here
  • Your base URL is either https://uat.api.converge.eu.elavonaws.com/ for the sandbox API or https://api.eu.convergepay.com/ for the production API. It is also provided at each API endpoint's description.
  • The best practice for the notifications is to not manually check, but rather setup webhook notifications.
  • You should store response data in your backend's database while implementing different steps of payment, you would likely need a value from a previous call, e.g. Order ID from Create Order
  • It is recommended to only create transactions with doThreeDSecure flag set to true, in order to prevent chargebacks from fradulent transactions.
  • It is recommended to build your return URLs with a unique id of the transaction like this: https://yourshop/redirect-return?id=12345. This way, when this URL is called, you can identify the transaction and find it in your database
  • Do not mix Payment Session and Payment Method Session. They are not the same.
  • Always check threeDSecure results. It is your choice to stand financial responsibility in a possible chargeback of a transaction. We recommend to implement a transaction amount based evaluation e.g. above 10 EUR you drop if threeDSecure.transactionStatus = "N".
  • Create payment session will not create a transaction unless the doCreateTransaction is set to true.