> For the complete documentation index, see [llms.txt](https://docs.digibee.com/documentation/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.digibee.com/documentation/connectors-and-triggers/connectors/financial-services/jack-henry-jxchange.md).

# Jack Henry jXchange

Discover more about the Jack Henry jXchange connector and how to use it on the Digibee Integration Platform.

The **Jack Henry jXchange** connector calls operations from the jXchange SOAP API on Jack Henry’s SilverLake, CIF 20/20, and Core Director platforms. For details about the available operations, see the [jXchange SOAP API documentation](https://jackhenry.dev/jxchange-soap/).

{% hint style="warning" %}
Before using this connector, request access for Digibee’s IP addresses through the [Digibee Support](https://docs.digibee.com/documentation/troubleshooting/help-and-faq/support.md) team.
{% endhint %}

## **Parameters**

The table below lists all configuration parameters for the connector. Parameters that support [Double Braces expressions](https://docs.digibee.com/documentation/connectors-and-triggers/double-braces/overview) are marked with ✅ in the **Supports DB** column.

{% tabs %}
{% tab title="General" %}

| Parameter        | Description                                                                                                                                                                                                                        | Type   | Supports DB | Default                                       |
| ---------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------ | ----------- | --------------------------------------------- |
| **Alias**        | Name (alias) for this connector's output, allowing you to reference it later in the flow using Double Braces expressions.                                                                                                          | String | ❌           | `jxchange-1`                                  |
| **Operation**    | The jXchange operation to call, taken from your TPG contract. This value is case-sensitive, for example `CustInq`, `AcctSrch`, `CustAcctRelInq`, or `XferAdd`.                                                                     | String | ❌           | `CustInq`                                     |
| **Request Body** | The XML elements that follow the jXchange request header, each prefixed with `ns:`. The connector builds the SOAP envelope and the `jXchangeHdr` for you. You can use Double Braces expressions here, but not account expressions. | XML    | ✅           | `<ns:CustId>{{ message.custId }}</ns:CustId>` |
| **Max Records**  | The maximum number of records to return per page, sent as `SrchMsgRqHdr/MaxRec`. This only applies to search operations (those ending in `Srch`), and it’s required for them.                                                      | String | ✅           | N/A                                           |
| **Cursor**       | The cursor returned by the previous page, used to fetch the next page of results. This only applies to search operations, and only when the previous response’s `MoreRec` field is true.                                           | String | ✅           | N/A                                           |
| {% endtab %}     |                                                                                                                                                                                                                                    |        |             |                                               |

{% tab title="Authentication" %}

| Parameter                   | Description                                                                                                                                                                                                                                                 | Type    | Supports DB | Default |
| --------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------- | ----------- | ------- |
| **Private Key Account**     | The [Private Key](https://docs.digibee.com/documentation/development-cycle/build-overview/accounts#private-key) account containing the RSA key you registered with Jack Henry. The connector uses it to sign the PS256 client assertion for authentication. | Account | ❌           | N/A     |
| **OAuth Client ID Account** | The [Secret Key](https://docs.digibee.com/documentation/development-cycle/build-overview/accounts#secret-key) account whose key value holds your jXchange OAuth client ID.                                                                                  | Account | ❌           | N/A     |
| {% endtab %}                |                                                                                                                                                                                                                                                             |         |             |         |

{% tab title="Routing" %}

| Parameter                             | Description                                                                                                            | Type   | Supports DB | Default             |
| ------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | ------ | ----------- | ------------------- |
| **Institution Routing ID (InstRtId)** | Routes the call to your institution’s core system, for example `999800100` for the SilverLake DMZ.                     | String | ✅           | `999800100`         |
| **Institution Environment (InstEnv)** | The target environment for the call, for example TEST or PROD.                                                         | String | ✅           | `TEST`              |
| **Valid Consumer Name**               | The `ValidConsmName` value Jack Henry assigned to your organization as a vendor.                                       | String | ❌           | `Digibee`           |
| **Valid Consumer Product**            | The `ValidConsmProd` value Jack Henry assigned to your vendor product.                                                 | String | ❌           | `DigibeeIntegra`    |
| **Audit User ID**                     | The user ID recorded in this call’s audit trail, sent as `AuditUsrId` in the `jXchangeHdr`. Up to 24 characters.       | String | ✅           | `DigibeeIntegra`    |
| **Audit Workstation ID**              | The workstation ID recorded in this call’s audit trail, sent as `AuditWsId` in the `jXchangeHdr`. Up to 24 characters. | String | ✅           | `DigibeeTestRunner` |
| {% endtab %}                          |                                                                                                                        |        |             |                     |

{% tab title="Advanced Settings" %}

| Parameter                      | Description                                                                                                                                                                                                                  | Type    | Supports DB | Default                                                                          |
| ------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------- | ----------- | -------------------------------------------------------------------------------- |
| **SOAP Endpoint**              | The URL of the jXchange OAuth service gateway.                                                                                                                                                                               | String  | ❌           | `https://jx.jackhenry.com/jXchange/2008/ServiceGateway/OAuth/ServiceGateway.svc` |
| **Token URL**                  | The OAuth 2.0 token endpoint the connector requests tokens from. It’s also used as the audience value in the client assertion.                                                                                               | String  | ❌           | `https://login.jackhenry.com/a/oidc-provider/api/v0/token`                       |
| **Scope**                      | The OAuth 2.0 scope the connector requests for the token. The default value covers both read and write operations.                                                                                                           | String  | ❌           | `https://jackhenry.com/jx/service-gateway.write`                                 |
| **Connect Timeout (ms)**       | The maximum time, in milliseconds, the connector waits while establishing the connection before failing.                                                                                                                     | Number  | ❌           | `15000`                                                                          |
| **Read Timeout (ms)**          | The maximum time, in milliseconds, the connector waits for a response before failing. History inquiries can take around 180 seconds, so raise this value if you’re calling one of those operations.                          | Number  | ❌           | `60000`                                                                          |
| **Fail On Client Error (4xx)** | When enabled, stops the pipeline if the response has an HTTP 4xx status, including a rejected token request, instead of returning the error in the output.                                                                   | Boolean | ❌           | `false`                                                                          |
| **Fail On Server Error (5xx)** | When enabled, stops the pipeline if the response has an HTTP 5xx status or a transport-level error occurs, instead of returning the error in the output. Keep in mind that jXchange business faults also arrive as HTTP 500. | Boolean | ❌           | `false`                                                                          |
| **Raw Mode**                   | When enabled, the connector also includes the raw SOAP response XML in the output, under `rawResponse`.                                                                                                                      | Boolean | ❌           | `false`                                                                          |
| {% endtab %}                   |                                                                                                                                                                                                                              |         |             |                                                                                  |

{% tab title="Documentation" %}

| Parameter         | Description                                                                                             | Data type | Supports DB | Default value |
| ----------------- | ------------------------------------------------------------------------------------------------------- | --------- | ----------- | ------------- |
| **Documentation** | Section for documenting any necessary information about the connector configuration and business rules. | String    | ❌           | N/A           |
| {% endtab %}      |                                                                                                         |           |             |               |
| {% endtabs %}     |                                                                                                         |           |             |               |


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.digibee.com/documentation/connectors-and-triggers/connectors/financial-services/jack-henry-jxchange.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
