Search Overlay

API Endpoints

The API endpoint (URI or URL) must point to either the Test or Production (live) environment.

  • Test API endpoint
    For example:
  • Production API endpoint
    For example:

API Endpoint Patterns

The API endpoints typically conform to the pattern of the example below:

Replace the elements in the API endpoint example above as follows:

Element Usage


Use test for a test transaction. Remove the word test for a live transaction.

Replace with the API you are using. The available values are:

  • 3D Secure API – threedsecure
  • Card Payments API – cardpayments
  • Customer Vault API – customervault
  • Direct Debit API – directdebit
  • Alternate Payments API – alternatepayments
v2 This is the version of the API.

Replace with your unique merchant account number.

Merchants can have multiple accounts, for example to process payments in different currencies. All accounts can be set up to use the same API key.

Refer to the table below for further examples.

API Request Used To Endpoint Pattern
Authentication Authenticate a card with 3D Secure 2.


Get Authentication Look up an authentication request.


  • In the above examples replace account_id with your unique merchant account number and replace id with the unique ID of the original transaction.
  • Some API endpoints include multiple parameters. For example, to look up an authentication request, both account_id and authentication_id must be included.
On this Page