Overview
The Port X panel simplifies integrating your Sharpen contact center or IVR with a banking core, tailored primarily for credit unions, banks, and other financial institutions. Rather than requiring a lengthy custom development effort to build the connection between Sharpen and a banking core, Port X has already built that connection and exposes a standard API for Sharpen to use, dramatically reducing setup time and complexity.
The panel provides dropdown-based configuration for common banking core actions, making it straightforward to retrieve account information, balances, transactions, and customer data directly within a Logic+ flow.
Prerequisites
Before configuring this panel, the following must be in place:
-
PortX Setup
The customer must have worked directly with PortX, or through Sharpen, to set up the connector on the PortX network. A PortX account and API credentials are required.
Contact your Sharpen representative if you are unable to locate this panel, as it may not be enabled for environment.
Before You Begin
The Port X panel is designed for financial institution use cases where callers need to access account information during an IVR interaction, such as checking a balance, reviewing recent transactions, or looking up account details by name or TIN. The panel retrieves this data from the banking core and stores it in variables that can be used throughout the rest of the flow.
Properties
-
Name
Enter a unique, descriptive name to identify the panel.
-
Description
Enter any notes about the panel for reference. This field is collapsed by default; select the down arrow to expand it.
-
Initiates Flow
Designates this panel as the starting point of the Logic flow. When selected, this panel will be the first to execute when the flow is triggered. This can only be removed by setting a different panel as the flow initiator.
-
Redact Data in Logging
Disables data logging for this panel to support data redaction requirements. This feature is available upon request and is subject to change.
Fields
API Integration
Select the integration to use for the PortX API calls.
Use Dropdown: Select from all integrations configured in your company's Sharpen account.
Use Variable: Reference a variable containing an integration's ID.
Token Integration
Select the integration to use for retrieving the authentication token required by the PortX API.
Use Dropdown: Select from all integrations configured in your company's Sharpen account.
Use Variable: Reference a variable containing an integration's ID.
PortX Action
Select the banking core API action to execute. Available options are:
type andAction |
Description |
|---|---|
Get Persons |
Retrieve person records matching the specified query. |
Get Person Accounts |
Retrieve all accounts associated with a person. |
Get Account by ID |
Retrieve a specific account using its ID. |
Get Account Balances |
Retrieve balance information for an account. |
Get Account Transactions |
Retrieve transaction history for an account. |
Queries
Define a query using caller data to filter and retrieve precise information from the banking core. Each query consists of a query type and a value to match against.
-
Key
-
Use Dropdown: Select from the available query options:
Last Name Is
First Name Is
Name Includes
TIN Is
SSN Is
-
Phone Number Is
-
Screenshot Example
-
Use Variable: Reference a variable containing the query type.
-
-
Value
Enter the value to use in the query. This can be a static value or a dynamic variable populated from earlier in the flow (e.g., a caller's phone number captured via ANI).
Body
If the selected action requires a request body, enter it here as a JSON string.
Variables
Define variables to store specific values from the API response for use in subsequent panels. Each entry consists of:
-
Name
Enter a unique name for the variable. This variable can be referenced throughout the rest of the flow using
$(variableName)syntax.
-
JSON Path
Enter the JSON path to the specific value you want to extract from the response body (e.g.,
$.results[0].firstName). If left empty, the entire response body will be stored in the variable.
Exits
-
Default
The path taken when the PortX action executes successfully and returns a response.
-
Error
The path taken if an error occurs during the API request or authentication.
This article is part of a series on Admin Configuration topics.