Skip to Content

Epay connection


An Epay connection, created using the Epay connector, establishes access to Epay. Once a connection is configured, you can create instances of Epay activities associated with that connection to be used either as sources (to provide data in an operation) or as targets (to consume data in an operation).

Create or edit an Epay connection

A new Epay connection is created using the Epay connector from one of these locations:

An existing Epay connection can be edited from these locations:

Configure an Epay connection

Each user interface element of the Epay connection configuration screen is described below.

Epay connection configuration


Fields with a variable icon Variable icon support using global variables, project variables, and Jitterbit variables. Begin either by typing an open square bracket [ into the field or by clicking the variable icon to display a list of the existing variables to choose from.

  • Connection Name: Enter a name to use to identify the connection. The name must be unique for each Epay connection and must not contain forward slashes / or colons :. This name is also used to identify the Epay endpoint, which refers to both a specific connection and its activities.

  • User: Enter the username for the Epay instance.

  • Password: Enter the password for the Epay instance.

  • Environment: Select the environment, either Production or Sandbox.


    Epay's production environment has controlled security through allowlisting. To allow access to Epay's production environment while using this connector with a private agent, contact Epay and request the inclusion of your Private Agent IP addresses (located on the Management Console Agents page) in Epay's firewall allowlist. Jitterbit's cloud agents are already allowlisted with Epay.

  • Use Proxy Settings (Private Agent Only): When using a private agent, this setting can be selected to use private agent proxy settings.

  • Test: Click to verify the connection using the provided configuration. When the connection is tested, the latest version of the connector is downloaded by the agent(s) in the agent group associated with the current environment. This connector supports suspending the download of the latest connector version by using the Disable Auto Connector Update organization policy.

  • Save Changes: Click to save and close the connection configuration.

  • Discard Changes: After making changes to a new or existing configuration, click to close the configuration without saving. A message asks you to confirm that you want to discard changes.

  • Delete: After opening an existing connection configuration, click to permanently delete the connection from the project and close the configuration (see Component dependencies, deletion, and removal). A message asks you to confirm that you want to delete the connection.

Next steps

After an Epay connection has been created, you place an activity type on the design canvas to create activity instances to be used either as sources (to provide data in an operation) or as targets (to consume data in an operation).

Menu actions for a connection and its activity types are accessible from the project pane and design component palette. For details, see Actions menus in Connector basics.

These activity types are available:

  • Read: Retrieves object data from Epay and is intended to be used as a source in an operation.

  • Update: Updates object data in Epay and is intended to be used as a target in an operation.