Skip to Content

Epay Read Activity

Introduction

An Epay Read activity, using its Epay connection, retrieves object data from Epay and is intended to be used as a source to provide data in an operation.

Create an Epay Read Activity

An instance of an Epay Read activity is created from an Epay connection using its Read activity type.

To create an instance of an activity, drag the activity type to the design canvas or copy the activity type and paste it on the design canvas. For details, see Creating an Activity Instance in Component Reuse.

An existing Epay Read activity can be edited from these locations:

Configure an Epay Read Activity

Follow these steps to configure an Epay Read activity:

Step 1: Enter a Name and Select an Object

In this step, provide a name for the activity and select an object. Each user interface element of this step is described below.

Epay Read Activity Configuration Step 1

  • Name: Enter a name to identify the activity. The name must be unique for each Epay Read activity and must not contain forward slashes / or colons :.

  • Select an Object: This section displays objects available in the Epay endpoint.

    • Selected Object: After an object is selected, it is listed here.

    • Search: Enter any part of the object name into the search box to filter the list of objects. The search is not case-sensitive. If objects are already displayed within the table, the table results are filtered in real time with each keystroke. To reload objects from the endpoint when searching, enter search criteria and then refresh, as described below.

    • Refresh: Click the refresh icon Refresh icon or the word Refresh to reload objects from the Epay endpoint. This may be useful if objects have been added to Epay. This action refreshes all metadata used to build the table of objects displayed in the configuration.

    • Selecting an Object: Within the table, click anywhere on a row to select an object. Only one object can be selected. The information available for each object is fetched from the Epay endpoint:

      • Name: The name of the object.

      • Description: The description of the object.

    Tip

    If the table does not populate with available objects, the Epay connection may not be successful. Ensure you are connected by reopening the connection and retesting the credentials.

  • Save & Exit: If enabled, click to save the configuration for this step and close the activity configuration.

  • Next: Click to temporarily store the configuration for this step and continue to the next step. The configuration will not be saved until you click the Finished button on the last step.

  • Discard Changes: After making changes, click to close the configuration without saving changes made to any step. A message asks you to confirm that you want to discard changes.

Step 2: Review the Data Schemas

Any request or response schemas are displayed. Each user interface element of this step is described below.

Epay Read Activity Configuration Step 2

  • Data Schemas: These data schemas are inherited by adjacent transformations and are displayed again during transformation mapping.

    Important

    In the response, the RESULT field will return 0 as the success code. Any other value present in the RESULT field is an error code.

    The Epay connector uses the Epay REST API v1.

    The request and response data schemas consist of these nodes and fields:

    Request Schema Node/Field Description
    TERMINALID The terminal ID
    LOCALDATETIME The date and time of the request using the terminal's time settings
    TXID The transaction ID, unique to the terminal and the transaction
    CURRENCY The currency ISO code for the transaction
    CARD Node containing information about the card
    PAN The card number
    Response Schema Node/Field Description
    TYPE The type of transaction, such as refund
    RESULT The success or failure of the request, 0 is the success code, all other values refer to error codes
    RESULTTEXT The transaction message
    TERMINALID The terminal ID
    TXID The transaction ID, unique to the terminal and the transaction
    HOSTTXID The host transaction ID
    LOCALDATETIME The date and time of the response with the terminal's time settings
    SERVERDATETIME The date and time of the response with the host's time settings
    CARD Node containing information about the card
    PAN The card number
    EXPIRY_YEAR The card's expiration year
    EXPIRY_MONTH The card's expiration month
    EXPIRY_DATE The card's expiration day
    BALANCE Node containing the balance information
    CURRENCY Node containing the currency information
    STANDARD The currency standard
    ISOCODE The currency ISO code for the transaction
    NAME The currency name
    FRACTION The fraction of the currency setting
    BALANCE The card account balance; the balance is always a whole value (the fraction is not represented)
    BALANCE_BEFORE The account balance on a card before the transaction is processed
    RESERVED The reserved balance of the card account
    RESERVED_BEFORE The reserved balance of the card account before the transaction is processed
  • Refresh: Click the refresh icon Refresh icon or the word Refresh to regenerate schemas from the Epay endpoint. This action also regenerates a schema in other locations throughout the project where the same schema is referenced, such as in an adjacent transformation.

  • Back: Click to temporarily store the configuration for this step and return to the previous step.

  • Finished: Click to save the configuration for all steps and close the activity configuration.

  • Discard Changes: After making changes, click to close the configuration without saving changes made to any step. A message asks you to confirm that you want to discard changes.

Next Steps

After configuring an Epay Read activity, complete the configuration of the operation by adding and configuring other activities, transformations, or scripts as operation steps. You can also configure the operation settings, which include the ability to chain operations together that are in the same or different workflows.

Menu actions for an activity are accessible from the project pane and the design canvas. For details, see Activity Actions Menu in Connector Basics.

Epay Read activities can be used as a source with these operation patterns:

To use the activity with scripting functions, write the data to a temporary location and then use that temporary location in the scripting function.

When ready, deploy and run the operation and validate behavior by checking the operation logs.