Connect-E - REST API

Use our REST API to create tokens to enable you to take payments on your site using Connect-E. This is the first step when using both Connect-E Standard and Connect-E Checkouts. Requests to the REST API are designed to be made server to server as calling from a browser would expose the API key.

API Key

Our REST API is secured using an API key added to the Authorization header of inbound requests. Security keys are sensitive information and should not be publicly available. They should be stored securlerly on your server and not be used in a browser based request. If you do not already have an API Key please contact us.

Interactive Docs

If you already have an API Key for our system you can use the interactive docs to call the API. Click on the Authorise button to set up your API Key. The key needs to be added to the Authorization header in the format Bearer <YOUR_KEY>.
For requests to /v1/cross-reference-payments/{access-token} you will need to get a one time access token from /v1/access-tokens and pass it in place of access-token.
The endpoint /api/cross-reference-payments has been deprecated and will no longer be supported, please use /v1/cross-reference-payments/{access-token} instead with the API Key in the header and access token in the URL.
All endpoints starting with /api have now been deprecated. New endpoints starting with /v1 will use new API keys which will be issued to you by our support team. The new JWT based keys issued to you will only work with the v1 endpoints. To ensure the best possible support integrations to migrate to the new /v1 endpoints. The schema of request remains unchanged between versions.