Capabilities
Overview
NexumAPI is the quickest way to use SymXchange and fortunately it comes with a growing feature set of new capabilities. Discover what's possible and what's coming to NexumAPI.
all SymXchange services and operations are available through NexumAPI in JSON
Available
end-to-end coverage of parameter descriptions and mocks with working playground requests (5 out of 36 complete)
In Progress
all SymXchange error responses are translated to HTTP error codes for better stack management
Available
ignore the schema-mandated ordering of request elements
Available
send silent NaaS requests through custom PowerOn requests
Available
we maintain translations for all supported SymXchange versions
Available
gain insight on all third-party connections to your SymXchange instance
Available
track all SymXchange requests and bubble up critical user information with little to no configuration
Available
we manage all of the infrastructure
Available
we automatically update NexumAPI on new releases
Available
we will load balance requests and automatically provision new compute resources to meet any demand
Available
we host your NexumAPI instance in multiple availability zones to ensure that we're always operational
Available
we're building custom routes which combine popular requests to reduce development burden
Coming soon
RESTful interface in JSON
NexumAPI provides a way to interact with Symitar data strictly from JSON in a RESTful-like way using a proprietary translation engine compiled in native code for virtually no impacts on performance.
"...NexumAPI isn’t just another middleware or endpoint; it’s a revolution for Symitar credit unions. It transforms the way we interact with the Symitar database, replacing outdated software and systems with a modern, streamlined approach. It significantly lowers the barrier to entry for working with the Symitar database via SymXchange..." — Ray Satterfield, Programmer II, Dover Federal Credit Union
Full content SymX API reference
We provide a complete SymXchange API reference for every service and operation to use with NexumAPI. This includes detailed parameter descriptions, references to Symitar eDocs, and working request payloads for the NexumAPI Playground or your credit unions environment.
We're working hard to provide complete coverage for detailed parameter descriptions and working sample request payloads for each operation through a mix of generative AI, our translation engine, and manual validation. Below is a list of full-content SymX services maintained in a best effort fashion and may not reflect all changes being made.
HTTP error codes
NexumAPI uses the standard HTTP status codes to indicate the success or failure of an API request. The 2xx codes will generally indicate success, 4xx will indicate an error within the information provided (e.g. invalid payload), and 5xx will indicate an error on our side (this shouldn't happen).
Symitar eDocs References: SymXchange Specification Response Codes, SymXchange Error Messages, SymXchange Error Codes
Recursive order agnostic request elements
NexumAPI provides flexibility when constructing SymXchange request payloads. This prevents developers from having to reference a schema and ensure the order of their many request elements match 100%. We take care of this for every request, no matter the depth.
Form URLEncoded content-type
NexumAPI supports the application/x-www-form-urlencoded content-type for all requests, enabling developers to easily send silent HTTP requests from inline PowerOn.
Check out our white paper on sending a NexumAPI request via Validation PowerOn to circumvent inherent PowerOn limitations:
Multi-version support
NexumAPI supports every Jack Henry supported SymXchange version (v2018 through v2023 + Persistent endpoint).
SymXchange native passthrough
Libum-hosted • Most third-party SymXchange traffic is unknown to a credit union unless there's a failure. Even then, it can be tricky to quickly access and interpret the available logging information. NexumAPI can gain insight on all third-party traffic over any SymXchange instance without making any internal Symitar configuration changes, simply tell your vendor to access SymXchange through a new endpoint.
The participating third-party can send either native SymXchange or NexumAPI request payloads to the endpoint and the traffic is interpreted and logged just the same.
Detailed logging transports
All NexumAPI traffic is accessible through all logging transports and bubbles up critical user identifying information desired by auditors. Even further, this can be coupled with NexumAPI attributes using customFields to expose custom metadata to various logging levels.
Managed infrastructure
Libum-hosted • NexumAPI is available on a completely managed infrastructure with availability subject to our published SLA. For those wondering, this is handled completely by infrastructure as code (IaC) on a serverless compute engine on AWS.
Automatic updates
Libum-hosted • As new features become available, NexumAPI will automatically be updated using non-invasive techniques keeping your institution on the latest release without the need for scheduled updates or even downtime.
Load balancing & auto scaling
Libum-hosted • Given NexumAPI's infrastructure is serverless it is also governed by a load balancer such that it automatically distributes incoming application traffic across multiple targets and virtual appliances to meet your SymXchange demand.
High availability
Libum-hosted • NexumAPI is spread across multiple availability zones to meet the standards described in our SLA.
Custom chained actions
NexumAPI is constantly being equipped with new custom request paths that provide developers a nice alternative to self-managing tedious chained SymXchange calls (e.g. findbySSN + getAccount).
Last updated