Knowledge Base

This integration option keeps the user in your application with your pages for a consistent user experience.

To start, there are a few configuration values that must be stored in the Integrating System. The configuration values are broken into two categories – values that must be stored at the system level and are shared across all clients and values that are specific to each client.

• API Url – The Url for the API. The default page loads the Swagger UI for full documentation of the API.
• API Key – The key for the API. This should never be shared with outside entities.
• API Secret – The secret for the API. This should never be shared with outside entities.
• API Public Key – The Public Key can be shared with outside entities since it can only be used to create payment tokens while the Key and Secret can be used to run any operation on the API.
• Impersonation Key (optional) – When combined with the Key and Secret or Public Key, the Impersonation Key, gives authorization to the Integrating System to run transactions on behalf of the Client. If the Integrating System is for a single entity and not on behalf of a number of different clients, then any reference to an Impersonation Key in this documentation can be ignored and this can be left null.

Step 1: Create the Payment Page Session Id
Authentication Required for this step: API Key, API Secret (and Impersonation Key if applicable)

The first step is to create a “payment page session Id” which will allow you to redirect the user to a hosted page on our servers to collect the payment information. Pass in any custom attributes to attach to the transacation, along with a success Url which your payer will be forwarded to once a payment is made through the hosted payment page.

The session Id returned by the API is valid for 30 minutes.

Step 2: Forward your Payer to the Hosted Page
Authentication Required for this step: None

Your application forwards the user to the hosted payment page with the session Id in the query string (<payment page Url>?sessionId={sessionId}). On the payment page, they will see the amount in a readonly field since the amount was already passed to our system in Step 1. Once a successful payment is made, the user will be forwarded back to the success Url specified in Step 1 along with the transaction Id in the query string (<success Url>?transactionId={id}.

Step 3: Execute the Payment Transaction
Authentication Required for this step: API Key, API Secret (and Impersonation Key if applicable)

Using the API and the transaction Id from the query string, execute a GET operation against the API to obtain the transaction details including any custom attributes passed in during Step 1.