Provider Lookups

Overview

Many jXchange services include elements with provider or bank-level canonical values, defaults, and service dictionaries. This page explains the APIs that help consumers retrieve and review these values before making API calls.

Parameter Value Search

In several jXchange services, certain element codes require parameter values supplied by Service Providers. These values are not defined in the XSD contract, but can be retrieved using the Parameter Value Search Request (ParmValSrchRq) service. With this service, a Third-Party Consumer can request a list of parameter values associated with element codes such as:

• AcctRelCode
• BrCode
• FedWithCode …and more.

To perform a search, the consumer provides:

• The jXchange element name for the parameter.
• A template with details identifying the parameter type.
• The type and/or variation of the template that applies to the element code.

Detailed information, including a complete list of elements supplied by this API, can be found on the ParmValSrch Message Brief page. Sample requests and FAQ may be found on the ParmValSrch Developer Resources page.

Service Defaults

In many jXchange services used for adding consumers, transactions, or accounts, default values are supplied by Service Providers for certain elements. These defaults are not included in the XSD contract, but can be retrieved using the Service Default Request SrcDft API.

With this service, a Third-Party Consumer can request a list of default values associated with add services, such as:

• Customer Add
• Account Add …and more.

To make a request, the consumer provides:

• The type of account to be added.
• A template with details identifying the product type.
• The type and/or variation of the template that applies to the product.

For detailed information and a complete list of services supplied by this API, see the SvcDft Message Brief page. Sample requests and FAQ may be found on the SvcDft Developer Resources page. For default lookups that require categorization, review the SvcDft Categories Spreadsheet.

Service Dictionary Search

The Service Dictionary Search API is a jXchange messaging service that provides consumers with detailed metadata about a Service Provider’s operations. This service is designed to help developers understand the structure and constraints of a provider’s implementation before making API calls, ensuring accurate and efficient integration.

This includes:

• Element XSD paths
• Field requirements
• Default values
• Open enumerated canonical values
• Help and knowledge content
• Fault codes per operation

For detailed information and a complete list of dictionaries supplied by this API, see the SvcDictSrch Message Brief page. Sample requests and FAQ may be found on the SvcDict Developer Resources page.