Developer Programs
Vendor Integration Program (VIP)
Direct access to Jack Henry's technical integration resources.
Technical Account Manager (TAM)
Get technical integration help from a single point of contact.
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
Admin API
Create solutions for an institution's back office support tools.
Authentication Framework
Map customer identities to your existing system IDs.
Consumer API
Access financial data for user accounts, transactions, and more.
Data Broker
Get deeper access to financial institution data.
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 third-party applications using a REST-based API.
jXchange - SOAP API
Translate business information between Jack Henry and third-party applications 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.
Plugin Framework
Embed the best of the fintech world directly into your user's dashboard.
SymXchange
Query Symitar core member accounts, post transactions, run PowerOn scripts, and more.
Xperience
Modern UI that provides consistent visual integration across Jack Henry products.
Important notification about upcoming changes to the DMZ environment. Please read.
More info

Bill Pay Payment History Inquiry

Enterprise SOAP API > API by Reference > Bill Pay Services > Bill Pay Payment History Inquiry

Bill Pay Payment History Inquiry

Bill Pay Payment History Inquiry is a jXchange service designed to return element details as related to a payment made.

Message Flow

In jXchange, the Bill Pay Payment History Inquiry service uses a typical exchange of MType messages to retrieve information about past payments made.

Primary Request

The Third Party Consumer forwards the BilPayPmtHistInqRq_MType message to the Service Provider. The message contains the following simple elements:

  • BilPayProd
  • IncChkImg
  • PmtId - This element is required.
  • SubId - This element is required.

It also contains the IncXtendElem_AType array.

Primary Response

The Service Provider returns the BilPayPmtHistInqRs_MType message to the Third Party Consumer. The message contains the following simple elements:

  • IncChkImg
  • PmtChkImgInfo
  • PmtChkNum
  • PmtChkStat
  • PmtCrtDt
  • PmtMthd
  • PmtStat
  • PmtId
  • SubId

It also contains the BilPayPmtInfo_CType and x_PmtChkTrakInfo_CType complexes and the x_PmtChkStatHistArray_AType and x_PmtStatHistArray_AType arrays.

Bill Pay Payment History Inquiry Behavior

The response returns the element details as related to a payment made.

The SubId and PmtID simple elements are required on the request. The design of the inquiry was created in a manner to leverage the addition and modification.

The Service Provider should include the additional payment status history, payment check status history, and payment check tracking information elements when the x_PmtStatHistArray_AType, x_PmtChkStatHistArray_AType, and x_PmtChkTrakInfo_CType are included in the extended element array complex request.

BilPayPmtHistInqRq_MType

BilPayPmtHistInqRq_MType is a message MType element.

Contains:

  • Custom_CType
  • IncXtendElem_AType
  • MsgRqHdr_CType

Simple Elements

The following simple elements are contained within this message.

BilPayProd
Used to show which product to use. Canonical values are:
  • BilPay - Bill Pay
  • Remit - Remittance

The default value is BilPay.

IncChkImg
Used to include the check image information. Canonical values are:
  • false
  • true
PmtId
The identification of a payment.
SubId
The ID of the subscriber or end user.

Custom_CType

Custom_CType is a complex CType element.

This element is optional.

IncXtendElem_AType

IncXtendElem_AType is an array AType element. This is an array that lists x_ elements by name, which are to be included in the response.

Contains:

  • IncXtendElemInfo_CType

IncXtendElemInfo_CType

IncXtendElemInfo_CType is a complex CType element.

Simple Elements

The following simple elements are contained within this complex.

XtendElem
Included extended elements. The consumer would ask by name for x_ prefix elements to be included in the response.

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 the submitted message. A financial institution entity uses the routing transit or nine-digit number assigned to financial institutions for 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 should use a mutually agreed upon identification that must contain at least one non-integer character.

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
AuthenUserId
This element deprecates in three years in accordance with XSD contract tenets. Effective date: 2012–01–01. The new complex element for user authentication credentials was added to 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.

BilPayPmtHistInqRs_MType

BilPayPmtHistInqRs_MType is a message MType element.

Contains:

  • BilPayPmtInfo_CType
  • Custom_CType
  • MsgRsHdr_CType
  • PmtChkImgInfo_CType
  • x_ElecBilPmtInfo_CType
  • x_PmtChkStatHistArray_AType
  • x_PmtChkTrakInfo_CType
  • x_PmtStatHistArray_AType

Simple Elements

The following simple elements are contained within this message.

BilPayProd
Used to show which product to use. Canonical values are:
  • BilPay - Bill Pay
  • Remit - Remittance

The default value is BilPay.

IncChkImg
Used to include the check image information. Canonical values are:
  • false
  • true
PmtChkNum
The check number of the check created for the payment.
PmtChkStat
The status of a check associated with a payment. Canonical values are:
  • Clr - cleared
  • Pend - pending
  • PendRi - pending reissue
  • Prst - presented
  • Prt - printed
  • PrtRi - printed reissue
  • Rfd - refunded
  • Ri - reissued
  • Stop - stopped
  • StopRq - stop requested
  • SusNotPd - suspect not paid
PmtCrtDt
The date a payment created by the end user.
PmtId
The identification of a payment.
PmtMthd
Payment method. Canonical values are:
  • Chk - check
  • Elec - electronic
  • Email - electronic but set up via an email process
PmtStat
The status of a payment. Canonical values are:
  • All - all
  • Canc - cancelled
  • Pd - paid
  • Pend - pend
  • PendSkip - pending skip
  • Proc - processed
  • Ret - returned
  • Rfd - refunded
  • Sched - scheduled
  • Skip - skipped
  • Stop - stopped
  • Sttl - settled
SubId
The ID of the subscriber or end user.

BilPayPmtInfo_CType

BilPayPmtInfo_CType is a complex CType element. This is a package of data related to a scheduled payment.

Contains:
  • BilPaySvcFeeInfoRec_CType
  • Custom_CType
  • InvoiceInfoArray_AType
  • PmtPayFromAcctInfo references PayFromAcctInfo_CType
  • PmtPayeeInfo references BilPayPmtPayeeInfo_CType
  • PmtRushOptInfo references RushOptInfo_CType
  • RecurPmtInfo references BilPayRecurPmtInfo_CType

Simple Elements

The following simple elements are contained within this complex.

PmtAmt
The payment amount.
PmtChkMemo
The memo to be added to a check associated with a payment.
PmtCmnt
The comment associated with a payment.
PmtEstArvDt
Estimated arrival date for a payment.
PmtIntentType
The payment intention type. Canonical values are:
  • PayBill - payment for a bill
  • XferToSubFinInst - transfer to the subscriber's financial institution (outbound)
  • XferFromSubFinInst - transfer from the subscriber's financial institution (inbound)
  • XferTo - internal transfer to subscriber's account
  • XferFrom - internal transfer from subscriber's account

The default value is PayBill.

PmtProcDt
Process date for a payment.
SubCmntToPayee
Application or user remarks free form text.

BilPayPmtPayeeInfo_CType

BilPayPmtPayeeInfo_CType is a complex CType element. This is a package of data related to a bill pay payee of a payment.

Contains:
  • Custom_CType
  • PayeeAddrInfo_CType
  • PayeeEmailArray references EmailArray_AType
  • PayeePhoneArray references PhoneArray_AType
Simple Elements

The following simple elements are contained within this complex.

PayeeCatName
The category name assigned to a payee.
PayeeClsf
The classification of a payee. Canonical values are:
  • Comp
  • FinInst
  • Indv
PayeeId
The payee identifier.
PmtIntentType
The payment intention type. Canonical values are:
  • PayBill - payment for a bill
  • XferToSubFinInst - transfer to the subscriber's financial institution (outbound)
  • XferFromSubFinInst - transfer from the subscriber's financial institution (inbound)
  • XferTo - internal transfer to subscriber's account
  • XferFrom - internal transfer from subscriber's account

The default value is PayBill.

PayeeName
The name of the payee.
PayeeNickname
The nickname given to a payee.
PayeePmtMthd
Payment method. Canonical values are:
  • Chk - check
  • Elec - electronic
  • Email - electronic but set up via an email process
SubMerAcctId
The subscriber's account identifier at the merchant.
SubMerPayerName
The subscriber's name understood by the merchant and used to override the subscriber's name on record.
Custom_CType

Custom_CType is a complex CType element.

This element is optional.

PayeeAddrInfo_CType

PayeeAddrInfo_CType is a complex CType element. This is a package of data related to a payee address.

Contains:
  • PayeeAddr references Addr_CType
  • Custom_CType
Simple Elements

The following simple elements are contained within this complex.

PayeeAddrId
The payee address identifier.
PayeeAddrType
Type of payee address. Canonical values are:
  • Prim
  • Rush
PayeeAddr

Addr_CType is a complex CType element containing address information. This element is optional.

PayeeAddr references Addr_CType.

Contains:

  • FreeFormAddr_AType
Simple Elements

The following simple elements are contained within this complex.

BusAddr
Answers the question: Is this a business address? Y states it is a business address.
City
The city name.
Cntry
The country name.
CntryType
The country abbreviation from ISO 3166.
County
The county name.
DlvryPt
The delivery point added to the zip.
FornAddr
Is this a foreign address? Where Y states it is a foreign address.
InvAddr
Is this address invalid? Y states mail has been returned from this address.
PostalCode
The postal code or ZIP code.
StateCode
The 2 alpha long code which represents a state. For example, MO.
StateProv
The state or province or region.
StreetAddr1
The street address.
StreetAddr2
The second line of street address.
StreetAddr3
The third line of street address.
FreeFormAddr_AType

FreeFormAddr_AType is an array AType element. This is an array of free form address lines 1–11 in a printable/usable form.

Contains:

  • AddrLineInfo_CType
AddrLineInfo_CType

AddrLineInfo_CType is a complex CType element.

Simple Elements

The following simple elements are contained within this complex.

AddrLine
Free form element of address lines 1 - 11 in a printable/usable form, generally not separated.
Custom_CType

Custom_CType is a complex CType element.

This element is optional.

PayeeEmailArray

EmailArray_AType is an array AType element. This is an array used to define email contact information.

PayeeEmailArray references EmailArray_AType.

Contains:

  • EmailInfo_CType
EmailInfo_CType

EmailInfo_Ctype is a complex CType element. This element is optional.

Simple Elements

The following simple elements are contained within this complex.

EmailAddr
Email address.
E-mailType
Email type. Examples: Home, Work, Statement, Notice.
PayeePhoneArray

PhoneArray_AType is an array AType element. This array contains one or more PhoneInfo_CType complexes to define phone contact information. This array is optional.

PayeePhoneArray references PhoneArray_AType.

Contains:

  • PhoneInfo_CType

BilPaySvcFeeInfoRec_CType

BilPaySvcFeeInfoRec_CType is a complex CType element.

Contains:

  • Custom_CType
Simple Elements

The following simple elements are contained within this complex.

SvcFeeAmt
The fee amount of the loan for some categories.
SvcFeeCode
The code that identifies the type of service fee applied to an account identification.
SvcFeeDesc
The description of the code that identifies the type of service fee applied.
Custom_CType

Custom_CType is a complex CType element.

This element is optional.

Custom_CType

Custom_CType is a complex CType element.

This element is optional.

InvoiceInfoArray_AType

InvoiceInfoArray_AType is an array AType element. This is an array of invoices.

Contains:

  • InvoiceInfo_CType
InvoiceInfo_CType

InvoiceInfo_CType is a complex CType element.

Contains:

  • Custom_CType
Simple Elements

The following simple elements are contained within this complex.

InvoiceAmtNeg
The invoice amount that is negative.
InvoiceAmtPos
The invoice amount that is positive.
InvoiceCat
The category of an invoice. Canonical values are:
  • Adj - adjustment
  • Disc - discount
  • Invoice - invoice
  • Oth - other
InvoiceDesc
The description of an invoice.
InvoiceId
The ID of an invoice.
InvoiceNum
The number of an invoice.
Custom_CType

Custom_CType is a complex CType element.

This element is optional.

PmtPayFromAcctInfo

PayFromAcctInfo_CType is a complex CType element. This is a package of data related to a pay from account.

PmtPayFromAcctInfo references PayFromAcctInfo_CType.

Contains:
  • Custom_CType
Simple Elements

The following simple elements are contained within this complex.

PayFromAcctDft
Designated as the default pay from account. Canonical values are:
  • false
  • true
PayFromAcctId
The number or character that identifies an account record.
PayFromAcctName
The account name for the subscriber's pay from account.
PayFromAcctType
The number or character that categorizes the AcctId.
PayFromId
The identifier for the Pay From account.
StartChkNum
The numbers or characters assigned to monetary drafts, often times referred to as the serial number.
Custom_CType

Custom_CType is a complex CType element.

This element is optional.

PmtPayeeInfo

BilPayPmtPayeeInfo_CType is a complex CType element. This is a package of data related to a bill pay payee of a payment.

PmtPayeeInfo references BilPayPmtPayeeInfo_CType.

Contains:
  • Custom_CType
  • PayeeAddrInfo_CType
  • PayeeEmailArray references EmailArray_AType
  • PayeePhoneArray references PhoneArray_AType
Simple Elements

The following simple elements are contained within this complex.

PayeeCatName
The category name assigned to a payee.
PayeeClsf
The classification of a payee. Canonical values are:
  • Comp
  • FinInst
  • Indv
PayeeId
The payee identifier.
PmtIntentType
The payment intention type. Canonical values are:
  • PayBill - payment for a bill
  • XferToSubFinInst - transfer to the subscriber's financial institution (outbound)
  • XferFromSubFinInst - transfer from the subscriber's financial institution (inbound)
  • XferTo - internal transfer to subscriber's account
  • XferFrom - internal transfer from subscriber's account

The default value is PayBill.

PayeeName
The name of the payee.
PayeeNickname
The nickname given to a payee.
PayeePmtMthd
Payment method. Canonical values are:
  • Chk - check
  • Elec - electronic
  • Email - electronic but set up via an email process
SubMerAcctId
The subscriber's account identifier at the merchant.
SubMerPayerName
The subscriber's name understood by the merchant and used to override the subscriber's name on record.
Custom_CType

Custom_CType is a complex CType element.

This element is optional.

EmailArray_AType

EmailArray_AType is an array AType element. This is an array used to define email contact information.

Contains:

  • EmailInfo_CType
EmailInfo_CType

EmailInfo_Ctype is a complex CType element. This element is optional.

Simple Elements

The following simple elements are contained within this complex.

EmailAddr
Email address.
E-mailType
Email type. Examples: Home, Work, Statement, Notice.
PayeeAddrInfo_CType

PayeeAddrInfo_CType is a complex CType element. This is a package of data related to a payee address.

Contains:
  • PayeeAddr references Addr_CType
  • Custom_CType
Simple Elements

The following simple elements are contained within this complex.

PayeeAddrId
The payee address identifier.
PayeeAddrType
Type of payee address. Canonical values are:
  • Prim
  • Rush
PayeeAddr

Addr_CType is a complex CType element containing address information. This element is optional.

PayeeAddr references Addr_CType.

Contains:

  • FreeFormAddr_AType
Simple Elements

The following simple elements are contained within this complex.

BusAddr
Answers the question: Is this a business address? Y states it is a business address.
City
The city name.
Cntry
The country name.
CntryType
The country abbreviation from ISO 3166.
County
The county name.
DlvryPt
The delivery point added to the zip.
FornAddr
Is this a foreign address? Where Y states it is a foreign address.
InvAddr
Is this address invalid? Y states mail has been returned from this address.
PostalCode
The postal code or ZIP code.
StateCode
The 2 alpha long code which represents a state. For example, MO.
StateProv
The state or province or region.
StreetAddr1
The street address.
StreetAddr2
The second line of street address.
StreetAddr3
The third line of street address.
FreeFormAddr_AType

FreeFormAddr_AType is an array AType element. This is an array of free form address lines 1–11 in a printable/usable form.

Contains:

  • AddrLineInfo_CType
AddrLineInfo_CType

AddrLineInfo_CType is a complex CType element.

Simple Elements

The following simple elements are contained within this complex.

AddrLine
Free form element of address lines 1 - 11 in a printable/usable form, generally not separated.
Custom_CType

Custom_CType is a complex CType element.

This element is optional.

PhoneArray_AType

PhoneArray_AType is an array AType element. This array contains one or more PhoneInfo_CType complexes to define phone contact information. This array is optional.

Contains:

  • PhoneInfo_CType
PhoneInfo_CType

PhoneInfo_CType is a complex CType element. It contains basic phone contact information. This complex is optional.

Contains:
  • MobPhoneInfo_CType
Simple Elements

The following simple elements are contained within this complex.

ConEndTime
The Greenwich Mean time when contact availability ends.
ConStartTime
The Greenwich Mean time when contact availability starts.
PhoneExt
The phone extension.
PhoneNum
The phone number.
PhoneTime
Best phone usage time, day, or evening.
PhoneType
Phone type examples are: home, work, fax, cell.

PmtRushOptInfo

RushOptInfo_CType is a complex CType element. This is a package of data related to a rush option.

PmtRushOptInfo references RushOptInfo_CType.
Contains:
  • Custom_CType
Simple Elements
The simple elements contained within this complex are listed below.
RushOpt
Option for rushing a payment to a payee. Canonical values are:
  • 2ndDay - second day
  • 2ndDayEc - second day economy
  • Ovrngt - overnight
  • Std - standard
RushOptFeeAmt
The fee associated with the rush option.
RushOptSurChg
The surcharge associated with the rush option.
Custom_CType

Custom_CType is a complex CType element.

This element is optional.

RecurPmtInfo

BilPayRecurPmtInfo_CType is a complex CType element. This is a package of data related to a recurring scheduled payment.

RecurPmtInfo references BilPayRecurPmtInfo_CType.

Contains:

  • Custom_CType
  • PmtDayInfoArray_AType
Simple Elements

The following simple elements are contained within this complex.

PmtDayOfWeek
The frequency for a recurring payment. Canonical values are:
  • Mon
  • Tues
  • Wed
  • Thur
  • Fri
PayDtInstr
The payment date instruction when recurrence date falls on a non-processing date. Canonical values are:
  • After
  • Before
PmtFinalAmt
The payment amount.
PmtFreqUnits
The frequency for a recurring payment. Canonical values are:
  • Annual
  • Every3Months
  • Every6Months
  • Every4Weeks
  • EveryOtherMonth
  • EveryOtherWeek
  • Monthly
  • Once
  • TwiceMonthly
  • Weekly
PmtOccur
Number of occurrences for the payment to be made.
PmtSerExpDt
The expiration date for the recurring payment.
PmtSerFinite
The payment series is finite. Canonical values are:
  • false
  • true
StartPmtEstArvDt
The starting date for the estimated arrival of a recurring payment.
StartPmtProcDt
The starting date for processing a recurring payment.
Custom_CType

Custom_CType is a complex CType element.

This element is optional.

PmtDayInfoArray_AType

PmtDayInfoArray_AType is an array AType element. This is an array of the day of month to make payments.

Contains:

  • PmtDayInfo_CType
PmtDayInfo_CType

PmtDayInfo_CType is a complex CType element. This is a package of data related to the day of month a payment should be made.

Contains:

  • Custom_CType
Simple Elements

The following simple elements are contained within this complex.

PmtDayOfMonth
The day of month for payment. This code is only required if the payment due date is the 29th of the month.
PmtUseLastBusDay
Use the last business day of the month. Canonical values are:
  • false
  • true
Custom_CType

Custom_CType is a complex CType element.

This element is optional.

Custom_CType

Custom_CType is a complex CType element.

This element is optional.

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 the submitted message. A financial institution entity uses the routing transit or nine-digit number assigned to financial institutions for 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 should use a mutually agreed upon identification that must contain at least one non-integer character.

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
AuthenUserId
This element deprecates in three years in accordance with XSD contract tenets. Effective date: 2012–01–01. The new complex element for user authentication credentials was added to 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.

PmtChkImgInfo_CType

PmtChkImgInfo_CType is a complex CType element. This is a package of data related to a payment check image.

Contains:

  • Custom_CType

Simple Elements

The following simple elements are contained within this complex.

BackChkImg
The back of the check image.
BackChkImgLength
The length of the back of the check image.
ChkImgFormat
The value that defines the file format that is used to deliver the check image. Canonical values are:
  • GIF
  • IOCA
  • JPG
  • PNG
  • TIFF
FrontChkImg
The front of the check image.
FrontChkImgLength
The length of the front of the check image.

Custom_CType

Custom_CType is a complex CType element.

This element is optional.

x_ElecBilPmtInfo_CType

x_ElecBilPmtInfo_CType is a complex CType element. This is a package of data related to a electronic bill payment.

Contains:

  • Custom_CType

Simple Elements

The following simple elements are contained within this complex.

CurBal
The current balance.
ElecBilPmtAuto
Answers the question: Was the electronic bill payment made automatically? Canonical values are:
  • false
  • true
MinPmtAmt
The minimum payment amount.
PmtAmtDue
The payment amount due.
PmtDueDt
The date established for a scheduled payment.
StmtBal
The statement balance.
StmtDt
Statement Date.

Custom_CType

Custom_CType is a complex CType element.

This element is optional.

x_PmtChkStatHistArray_AType

x_PmtChkStatHistArray_AType is an array AType element.

Contains:

  • PmtChkStatHistInfo_CType

x_PmtChkTrakInfo_CType

x_PmtChkTrakInfo_CType is a complex CType element. This is a package of data related to a payment check tracking.

Contains:

  • Custom_CType
  • PmtChkTrakArray_AType

Simple Elements

The following simple elements are contained within this complex.

PmtChkTrakCarr
The tracking carrier of the check created for the payment.
PmtChkTrakId
The tracking identifier of the check created for the payment.

Custom_CType

Custom_CType is a complex CType element.

This element is optional.

x_PmtStatHistArray_AType

x_PmtStatHistArray_AType is an array AType element. This is an array of responses for payment status change.

Contains:

  • PmtStatHistInfo_CType

PmtStatHistInfo_CType

PmtStatHistInfo_CType is a complex CType element. This is a package of data related to a payment status change history.

Contains:

  • Custom_CType
Simple Elements

The following simple elements are contained within this complex.

PmtChngBy
The entity that made the status change.
PmtExcDesc
The exception description associated with a payment status change.
PmtStat
The status of a payment. Canonical values are:
  • All - all
  • Canc - cancelled
  • Pd - paid
  • Pend - pend
  • PendSkip - pending skip
  • Proc - processed
  • Ret - returned
  • Rfd - refunded
  • Sched - scheduled
  • Skip - skipped
  • Stop - stopped
  • Sttl - settled
PmtStatChngDt
The date the status of the payment was changed.
Custom_CType

Custom_CType is a complex CType element.

This element is optional.

Have a Question?
Have a how-to question? Seeing a weird error? Get help on StackOverflow.
Register for the Digital Toolkit Meetup where we answer technical Q&A from the audience.
Last updated Fri Jan 7 2022