Developer Programs
Getting Started
Get started working with Jack Henry's developer programs today.
Fintech Integration Network (FIN)
Jack Henry's Integration Program for Fintechs.
Technical Account Manager (TAM)
Get technical integration help from a single point of contact.
Developer Account
Create a developer acccount to access resources that help you integrate with Jack Henry.
Learn
Shared Responsibility
Learn about shared roles and responsibilities of customers and Jack Henry in open banking.
Developer Use Cases
Find a use case that fits your development needs.
Developer Video Gallery
Watch the latest demos, webinars, and more.
Developer Conference
Connect with industry leaders, gain insights from expert speakers, and explore our latest innovations.
Docs
Authentication Framework
Map customer identities to your existing system IDs.
Banno SDK
Create exceptional banking experiences.
Data Hub
Get deeper access to financial institution data.
Digital Core
Modernize with cloud-native core banking technology.
Enterprise Event System
Respond to events in real-time using this powerful pub/sub-based solution.
jXchange - REST API
Translate business information between Jack Henry and 3rd-party apps using a REST-based API.
jXchange - SOAP API
Translate business information between Jack Henry and 3rd-party apps using a SOAP-based API.
Operational Data Integration (ODI)
Get customized queries for bulk data needs.
Payments
Embed check deposits, ACH, bill pay, cards, and real-time payments.
Payments Orchestrator
Embed multiple payment rails and virtual accounts into your solution.
SymXchange
Query Symitar core member accounts, post transactions, run PowerOn scripts, and more.
Full List of APIs
Begin working with Jack Henry's public APIs to build financial applications today.

EFT Card Save Up Inquiry

API by Reference > Core Services > EFT Card Save Up Inquiry

Home >

EFT Card Save Up Inquiry

EFT Card SaveUp Inquiry is a jXchange service designed to inquire on SaveUp information on a specific card. The EFT Card SaveUp program is an industry standard naming convention that refers to a card feature that automatically transfers money into a savings or check account with every purchase.

Message Flow

In jXchange, the EFT Card SaveUp Inquiry service uses a typical exchange of MType messages to inquire on SaveUp information on a specific card.

Primary Request

The consumer forwards the EFTCardSaveUpInqRq_MType message to the service provider.

The message contains the following simple elements:

  • ActIntentKey
  • EFTCardNum
  • EFTCardSufxNum

The message contains the following complex elements:

  • Custom_CType
  • MsgRqHdr_CType

Primary Response

The service provider returns the EFTCardSaveUpInqRs_MType message to the consumer.

The message contains the following simple elements:

  • EFTCardNum
  • EFTCardSufxNum
  • RsStat

The message contains the following complex elements:

  • Custom_CType
  • EFTCardSaveUpInqRec_CType
  • MsgRsHdr_CType

EFT Card Save Up Inquiry Behavior

The root request and response behavior for the EFT Card Save Up Inquiry service.

The EFT Card SaveUp Inquiry root request (EFTCardSaveUpInqRq_MType) requires a valid EFT Card Number. The EFT Card SaveUp Inquiry Root request (EFTCardSaveUpInqRq_MType) optionally includes EFT Card Suffix Number and Activity Intention.

EFT Card SaveUp Inquiry root response (EFTCardSaveUpInqRs_MType) returns EFT Card Number, EFT Card Number masked value attribute @MaskVal, and EFT Card Suffix Number, Activity Intention, Activity Intention Key, EFT Card SaveUp Inquiry Record complex (EFTCardSaveUpInqRec_CType) which encapsulates:

  • EFT Card SaveUp Information Record complex (EFTCardSaveUpInfoRec_CType)
  • SaveUp Match Paid Description
  • SaveUp Amount to Match
  • SaveUp Start Date
  • SaveUp Year to Date Paid Amount
  • SaveUp Previous Year to Date Paid Amount
  • SaveUp Life to Date Paid Amount
  • SaveUp Match Year to Date Paid Amount
  • SaveUp Match Previous Year to Date Paid Amount
  • SaveUp Match Life to Date Paid Amount
  • SaveUp Match Last Paid Date
  • SaveUp Match Previous YTD Paid Date
  • SaveUp From Card Number
  • SaveUp From Suffix Number
  • SaveUp to Card Number
  • SaveUp to Suffix Number
  • SaveUp Transfer from Account Id
  • SaveUp Transfer from Account Type
  • SaveUp Transfer From Date
  • SaveUp Transfer to Account Id
  • SaveUp Transfer to Account Type
  • SaveUp Transfer to Date
  • User Definition Information Array (UserDefInfoArray_AType)
  • SaveUp Monthly Activity Array (SaveUpMonthlyActArray_AType)

SaveUp Monthly Activity Array (SaveUpMonthlyActArray_AType) encapsulates SaveUp Monthly Activity Record complex (SaveUpMonthlyActRec_CType), which encapsulates Calendar Month canonical values (Jan, Feb, Mar, Apr, May, June, July, Aug, Sep, Oct, Nov, Dec), SaveUp Paid Amount, SaveUp Paid Dt, SaveUp Match Paid Amount, and SaveUp Match Paid Date.

Adhere to the tenets related to inquiry services and the tenets related to the concurrency models.

EFTCardSaveUpInqRq_MType

EFTCardSaveUpInqRq_MType is a message MType element.

Contains:

  • Custom_CType
  • MsgRqHdr_CType

Simple Elements

The following simple elements are contained within this complex:

ActIntent

Conveys the consumer intention for a subsequent operation for the data set included in the response. Canonical values are:

  • Dlt
  • ReadOnly
  • Upd

The default value is ReadOnly.

EFTCardNum
The number that is assigned to an EFT card. The card number includes the ISO number.
EFTCardSufxNum
The number that is the suffix to the card number. Can represent the card holder when multiple cards are issued with the same card number.

Custom_CType

Custom_CType is a complex CType element.

This element is optional.

MsgRqHdr_CType

MsgRqHdr_CType is a complex CType element. This is the default message request header.

Contains:

  • AuthenUsrCred_CType
  • jXchangeHdr_CType

Simple Elements

The following simple elements are contained within this complex.

AuthenProdCred
Authentication of the Consumer Product Credentials in the form of a WS Security element that contains a single SAML V2.0 Assertion.

AuthenUsrCred_CType

AuthenUsrCred_CType is a complex CType element. This element represents authentication of the end-user credentials in the form of a WS Security element that contains a single SAML V2.0 Assertion.

Simple Elements

The following simple elements are contained within this complex.

Security
Defines the wsse:Security SOAP header element per section 4.

jXchangeHdr_CType

jXchangeHdr_CType is a complex CType element.

Simple Elements

The following simple elements are contained within this complex.

AuditUsrId
The user ID that the consumer would like written in the audit as performing the requested service. It varies, but it could be the same as the user ID. It is not used to authenticate. It is used to audit the Soap Header Fault.
AuditWsId
The workstation ID that the consumer would like written in the audit as performing the requested service for the Soap Header Fault. It varies, but it could be the same as the user ID.
AuthenUsrId

The user ID which the consumer would like the service provider to authenticate with for the Soap Header Fault. It is a user ID that the provider understands.

This element deprecates in accordance with XSD contract tenets. Effective date: 2017–01–01. The new complex element for user authentication credentials was added to both the Search Message Request Header SrchMsgRqHdr_CType and the Message Request Header MsgRqHdr_CType. AuthenUsrId is ignored by the service providers when the authentication user credentials AuthenUsrCred_CType package is delivered. The expectation is that the password credentials and the user name token are provided in the authentication user credential complex element in accordance with the standards established by WS-Security.

BusCorrelId
The correlation identification as related to business functions and activities.
ConsumerName
The name of the service consumer (business name) for the Soap Header Fault.
ConsumerProd
The name of the product which is consuming the service (business product name) for the Soap Header Fault.
InstEnv
An identification provided by the consumer that defines the environment in which the institution is operating. Canonical values are:
  • Prod
InstRtId
The identification of the entity of submitted message. A financial institution entity uses the routing transit or ABA nine-digit number assigned to financial institutions for the purpose of routing as assigned by the American Bankers Association. Any leading zeros must be provided for a complete routing and transit number. A non-financial institution entity uses a mutually agreed upon identification that must contain at least one non-integer character. When a record is directed to a specific financial institution within a holding company, the institution routing identification is the specific financial institution routing identification and not the holding company identification. The canonical value is JHA.

The element is required in all message requests.

jXLogTrackingId
An identification provided by jXchange to be able to trace the request and response of a message from the third-party gateway, internal gateway, and service provider for the Soap Header Fault.
JxVer
Contains the version jXchange is running for the Soap Header Fault.
ValidConsmName
The consumer name that can be validated by enterprise governance. The canonical values are managed in a consumer/product enterprise table. The canonical value is: JHA.
ValidConsmProd
The consumer product name that can be validated by enterprise governance. The canonical values are managed in a consumer/product enterprise table.
WorkflowCorrelId
The correlation identification as related to workflow functions and activities.
jXchangeHdr_CType Deprecation Details
AuthenUsrId

The user ID which the consumer would like the service provider to authenticate with for the Soap Header Fault. It is a user ID that the provider understands.

This element deprecates in accordance with XSD contract tenets. Effective date: 2017–01–01. The new complex element for user authentication credentials was added to both the Search Message Request Header SrchMsgRqHdr_CType and the Message Request Header MsgRqHdr_CType. AuthenUsrId is ignored by the service providers when the authentication user credentials AuthenUsrCred_CType package is delivered. The expectation is that the password credentials and the user name token are provided in the authentication user credential complex element in accordance with the standards established by WS-Security.

EFTCardSaveUpInqRs_MType

EFTCardSaveUpInqRs_MType is a message MType element.

Contains:

  • Custom_CType
  • EFTCardSaveUpInqRec_CType
  • MsgRsHdr_CType

Simple Elements

The following simple elements are contained within this complex:

EFTCardNum
The number that is assigned to an EFT card. The card number includes the ISO number.
EFTCardSufxNum
The number that is the suffix to the card number. Can represent the card holder when multiple cards are issued with the same card number.

Custom_CType

Custom_CType is a complex CType element.

This element is optional.

EFTCardSaveUpInqRec_CType

EFTCardSaveUpInqRec_CType is a complex CType element.

Contains:

  • Custom_CType
  • EFTCardSaveUpInfoRec_CType
  • SaveUpMonthlyActArray_AType
  • UserDefInfoArray_AType

Simple Elements

The following simple elements are contained within this complex:

SaveUpAmtToMatch
The SaveUp amount to match.
SaveUpFromCardNum
The number that is assigned to an EFT card. The card number includes the ISO number.
SaveUpFromSufxNum
The number that is the suffix to the card number. Can represent the card holder when multiple cards are issued with the same card number.
SaveUpLTDPdAmt
The amount of SaveUp paid during a cycle/period.
SaveUpMatchLastPdDt
The date match SaveUp funds were paid during a cycle/period.
SaveUpMatchLTDPdAmt
The amount of SaveUp match paid during a cycle/period.
SaveUpMatchPdDesc
A description of the SaveUp match paid code.
SaveUpMatchPrevYTDPdAmt
The amount of SaveUp match paid during a cycle/period.
SaveUpMatchPrevYTDPdDt
The date match SaveUp funds were paid during a cycle/period.
SaveUpMatchYTDPdAmt
The amount of SaveUp match paid during a cycle/period.
SaveUpPrevYTDPdAmt
The amount of SaveUp paid during a cycle/period.
SaveUpStartDt
The date the SaveUp program began.
SaveUpToCardNum
The number that is assigned to an EFT card. The card number includes the ISO number.
SaveUpToSufxNum
The number that is the suffix to the card number. Can represent the card holder when multiple cards are issued with the same card number.
SaveUpXferFromAcctId
The number or character that identifies an account record.
SaveUpXferFromAcctType
The number or character that categorizes the AcctId.
SaveUpXferFromDt
The date a transaction has been posted or is scheduled to be posted to an account.
SaveUpXferToAcctId
The number or character that identifies an account record.
SaveUpXferToAcctType
The number or character that categorizes the AcctId.
SaveUpXferToDt
The date a transaction has been posted or is scheduled to be posted to an account.
SaveUpYTDPdAmt
The amount of SaveUp paid during a cycle/period.

Custom_CType

Custom_CType is a complex CType element.

This element is optional.

EFTCardSaveUpInfoRec_CType

EFTCardSaveUpInfoRec_CType is a complex CType element.

Contains:

  • Custom_CType
Simple Elements

The following simple elements are contained within this complex:

SaveUpActType
The EFT Card SaveUp enrollment activity. Canonical values are:
  • true
  • false
SaveUpMatchPdCode
The SaveUp match paid code.
SaveUpAcctId
The number or character that identifies an account record.
SaveUpAcctType
The number or character that categorizes the AcctId.
SaveUpMonthMaxAmt
The maximum amount that can be saved up per month.
SaveUpCmnt
Application or user remarks free-form text.
SaveUpAddlAmt
The additional amount that can be saved up.
Custom_CType

Custom_CType is a complex CType element.

This element is optional.

SaveUpMonthlyActRec_CType

SaveUpMonthlyActRec_CType is a complex CType element.

Contains:

  • Custom_CType
Simple Elements

The following simple elements are contained within this complex:

CalMonth
The calendar month. Canonical values are:
  • Jan
  • Feb
  • Mar
  • Apr
  • May
  • June
  • July
  • Aug
  • Sep
  • Oct
  • Nov
  • Dec
SaveUpMatchPdAmt
The amount of SaveUp match paid during a cycle/period.
SaveUpMatchPdDt
The date match SaveUp funds were paid during a cycle/period.
SaveUpPdAmt
The amount of SaveUp paid during a cycle/period.
SaveUpPdDt
The date of SaveUp paid during a cycle/period.
Custom_CType

Custom_CType is a complex CType element.

This element is optional.

UserDefInfoArray_AType

UserDefInfoArray_AType is an array AType element. This is an array of UserDefInfo simple elements used to describe user-defined information.

Contains:

  • UserDefInfo_CType
UserDefInfo_CType

UserDefInfo_CType is a complex CType element.

Simple Elements

The following simple elements are contained within this complex.

OvrrdInstRtId
Describes the institution routing number or bank number/location used to override the InstRtId found in a message header.
UserDefCode
The code that represents the answer to the UserDefTxt.
UserDefDesc
The description of what the UserDefCode represents.
UserDefDt
A date field that has a relationship with the UserDefTxt or UserDefCode.
UserDefInfo1
Additional information that may accompany any of the user supplied codes.
UserDefInfo2
Additional information that may accompany any of the user supplied codes.
UserDefInfo3
Additional information that may accompany any of the user supplied codes.
UserDefTxt
User Defined Text is part of a matched pair array that describes the proceeding elements.

MsgRsHdr_CType

MsgRsHdr_CType is a complex CType element. This is the default message response header.

Contains:

  • jXchangeHdr_CType
  • MsgRecInfoArray_AType

jXchangeHdr_CType

jXchangeHdr_CType is a complex CType element.

Simple Elements

The following simple elements are contained within this complex.

AuditUsrId
The user ID that the consumer would like written in the audit as performing the requested service. It varies, but it could be the same as the user ID. It is not used to authenticate. It is used to audit the Soap Header Fault.
AuditWsId
The workstation ID that the consumer would like written in the audit as performing the requested service for the Soap Header Fault. It varies, but it could be the same as the user ID.
AuthenUsrId

The user ID which the consumer would like the service provider to authenticate with for the Soap Header Fault. It is a user ID that the provider understands.

This element deprecates in accordance with XSD contract tenets. Effective date: 2017–01–01. The new complex element for user authentication credentials was added to both the Search Message Request Header SrchMsgRqHdr_CType and the Message Request Header MsgRqHdr_CType. AuthenUsrId is ignored by the service providers when the authentication user credentials AuthenUsrCred_CType package is delivered. The expectation is that the password credentials and the user name token are provided in the authentication user credential complex element in accordance with the standards established by WS-Security.

BusCorrelId
The correlation identification as related to business functions and activities.
ConsumerName
The name of the service consumer (business name) for the Soap Header Fault.
ConsumerProd
The name of the product which is consuming the service (business product name) for the Soap Header Fault.
InstEnv
An identification provided by the consumer that defines the environment in which the institution is operating. Canonical values are:
  • Prod
InstRtId
The identification of the entity of submitted message. A financial institution entity uses the routing transit or ABA nine-digit number assigned to financial institutions for the purpose of routing as assigned by the American Bankers Association. Any leading zeros must be provided for a complete routing and transit number. A non-financial institution entity uses a mutually agreed upon identification that must contain at least one non-integer character. When a record is directed to a specific financial institution within a holding company, the institution routing identification is the specific financial institution routing identification and not the holding company identification. The canonical value is JHA.

The element is required in all message requests.

jXLogTrackingId
An identification provided by jXchange to be able to trace the request and response of a message from the third-party gateway, internal gateway, and service provider for the Soap Header Fault.
JxVer
Contains the version jXchange is running for the Soap Header Fault.
ValidConsmName
The consumer name that can be validated by enterprise governance. The canonical values are managed in a consumer/product enterprise table. The canonical value is: JHA.
ValidConsmProd
The consumer product name that can be validated by enterprise governance. The canonical values are managed in a consumer/product enterprise table.
WorkflowCorrelId
The correlation identification as related to workflow functions and activities.
jXchangeHdr_CType Deprecation Details
AuthenUsrId

The user ID which the consumer would like the service provider to authenticate with for the Soap Header Fault. It is a user ID that the provider understands.

This element deprecates in accordance with XSD contract tenets. Effective date: 2017–01–01. The new complex element for user authentication credentials was added to both the Search Message Request Header SrchMsgRqHdr_CType and the Message Request Header MsgRqHdr_CType. AuthenUsrId is ignored by the service providers when the authentication user credentials AuthenUsrCred_CType package is delivered. The expectation is that the password credentials and the user name token are provided in the authentication user credential complex element in accordance with the standards established by WS-Security.

MsgRecInfoArray_AType

MsgRecInfoArray_AType is an array AType element. This is an array of messages that can be returned in a response.

Contains:

  • MsgRec_CType
MsgRec_CType

MsgRec_CType is a complex CType element.

Simple Elements

The following simple elements are contained within this complex.

ErrCat
The Soap Header Fault error category.
ErrCode
The error code.
ErrDesc
The Soap Header Fault error description.
ErrElem
The Soap Header Fault when an error or fault occurs. This optional element contains the element which is causing the error condition.
ErrElemVal
The Soap Header Fault when an error or fault occurs. This optional element contains the value of the element which is causing the error condition.
ErrLoc
The Soap Header Fault error location. This is typically the program that generated the error condition.

Topics in this section

Have a Question?
  • Have a how-to question? Seeing a weird error? Get help on our collaborative Discourse page.
  • Register for the Developer Office Hours where we answer technical Q&A, in real time, from the audience.
Did this page help you?
Last updated Mon Sep 14 2026