SymXchange API

https://jackhenry.dev/symxchange-api-docs/
Admin
SymXchange is a web services SOAP API that enables credit unions, third-party vendors, and...
Tokens:57,064
Snippets:346
Trust Score:8.4
Update:1 month ago
Show doc for...
Tokens:
Raw
### Change directory to SYM

Source: https://jackhenry.dev/symxchange-api-docs/troubleshooting

Example command to navigate to the specific SYM directory.

```bash
# cd /SYM/SYM000
```

--------------------------------

### CardCreatableFields Request Example

Source: https://jackhenry.dev/symxchange-api-docs/troubleshooting

A partial request snippet demonstrating the use of 'NEXT' in the Number field for card creation.

```xml
MessageId="GROMessage">

<CardCreatableFields>
  <ChkId>74</ChkId>
  <CreatedAtBranch>31</CreatedAtBranch>
  <Description>DEBIT CARD</Description>
  <EffectiveDate>2022-05-19</EffectiveDate>
  <InstantIssue>0</InstantIssue>
  <IssueCode>0</IssueCode>
  <IssueDate>2022-05-19</IssueDate>
  <NameType>0</NameType>
  <Number>NEXT</Number>
  <ReissueCode>1</ReissueCode>
  <ReissueMonths>36</ReissueMonths>
  <Status>0</Status>
  <StatusReason>0</StatusReason>
  <Type>15</Type>
```

--------------------------------

### searchShareTransactionSelectFields Query Example

Source: https://jackhenry.dev/symxchange-api-docs/troubleshooting

An example of using searchShareTransactionSelectFields to filter share transactions by regecode, commentcode, sequencenumber, and PostDate.

```xml
        <SelectableFields>
            <IncludeAllShareTransactionFields>true</IncludeAllShareTransactionFields>
        </SelectableFields>
        <SearchFilter>
            <Query>
                regecode = 1 and commentcode = 1 and (
                    (sequencenumber = 483158 and PostDate = {date:'2017-11-15'}) or
                    (sequencenumber = 409349 and PostDate = {date:'2017-11-15'}) or
                    (sequencenumber = 129200 and PostDate = {date:'2017-11-15'}) or
                    (sequencenumber = 451352 and PostDate = {date:'2017-11-14'}) or
                    (sequencenumber = 370664 and PostDate = {date:'2017-11-14'}) or
                    (sequencenumber = 291428 and PostDate = {date:'2017-11-14'}) or
                    (sequencenumber = 8714   and PostDate = {date:'2017-11-14'}) or
                    (sequencenumber = 59921  and PostDate = {date:'2017-11-13'}) or
                    (sequencenumber = 9518   and PostDate = {date:'2017-11-13'}) or
                    (sequencenumber = 4273   and PostDate = {date:'2017-11-12'})
                )
            </Query>
        </SearchFilter>
    </Request>
</searchShareTransactionSelectFields>
```

--------------------------------

### Import Banno Instance Template

Source: https://jackhenry.dev/symxchange-api-docs/troubleshooting

Run the symXInstanceImportExport command to import a product instance template. Requires ROOTACCESS password and the destination SYM identifier.

```Shell
# symXInstanceImportExport -file=/SYM/OP/SYMX._<PRODUCT.????.??>_.TMPL -sym=_SYMxxx_ import
Enter Password:
Parse import file
Start parameter import .
Set heap size
Done with import.
#
```

--------------------------------

### Invalid Transaction Effective Date Log Example

Source: https://jackhenry.dev/symxchange-api-docs/troubleshooting

Example log output showing a 13305 error caused by an incorrectly formatted JTREFFECTDATE.

```text
f234b533f238~A11308~BQ2~DCARD~F50500000051491~JTRCODE=XF~JTRFMACCT=0000051491~JTRFMID=20~JTRFMTYPE=S~JTRTOACCT=0000051491~JTRTOID=27~JTRTOTYPE=L~JTRAMOUNT=14308~JTRCOMMENTCODE=~JTRCOMMENT=Regular Payment~JTRPAYMENTTYPE=0~JTREFFECTDATE=09/14/2023

2023-09-14 08:02:48.0302   DEBUG   SendMessage:Adapter3 - Unique ID:963cdb86-48c0-4777-8dd0-f234b533f238, Request:TR~963cdb86-48c0-4777-8dd0-f234b533f238~A11308~BQ2~DCARD~F50500000051491~JTRCODE=XF~JTRFMACCT=0000051491~JTRFMID=20~JTRFMTYPE=S~JTRTOACCT=0000051491~JTRTOID=27~JTRTOTYPE=L~JTRAMOUNT=14308~JTRCOMMENTCODE=~JTRCOMMENT=Regular Payment~JTRPAYMENTTYPE=0~JTREFFECTDATE=09/14/2023 

2023-09-14 08:02:48.0302   DEBUG   Is socket pool null? False

2023-09-14 08:02:48.0927   DEBUG   SendMessage:Adapter3 - Response received:RSTR~963cdb86-48c0-4777-8dd0-f234b533f238~K13305:An invalid transaction effective date was specified
```

--------------------------------

### Log in as root

Source: https://jackhenry.dev/symxchange-api-docs/troubleshooting

Command to initiate root access for server configuration.

```bash
$ sym root

Enter ROOTACCESS password
```

--------------------------------

### Minimal TotalAmount Tag

Source: https://jackhenry.dev/symxchange-api-docs/troubleshooting

An example of sending only the TotalAmount tag, which may unintentionally create check records.

```xml
<dto:TotalAmount>?</dto:TotalAmount>
```

--------------------------------

### Diagnose symXchange Startup Failure from Missing Keystore Certificate

Source: https://jackhenry.dev/symxchange-api-docs/troubleshooting

Inspect StartupOrchestrator error logs, keystore directory files, and XML configuration parameters when symXchange fails to start due to missing TLS certificates. Useful for identifying missing keystore entries after a SYM environment refresh.

```text
+12148   2020-02-26 20:00:50,248 \[symXchange\] ERROR com.symitar.symxchange.mainl  
ine.StartupOrchestrator  - Error starting up symXchange.                         
+12149  com.symitar.exception.SymitarRuntimeException: symXchange SYM500.2 confi  
guration error                                                                   
+12150          at com.symitar.symxchange.mainline.StartupHelper.getRuntimeConfi  
guration(StartupHelper.java:121)                                               

  
  +510  2020-02-26 19:58:32,826 \[pool-1-CertificateMonitoring-1\] INFO  com.symit  
ar.security.keystore.monitor.WebConsoleExpirationThresholdFinder  - cannot load  
configuration file: properties system property not set.  no configuration being  
loaded.                                                                          
  +511  2020-02-26 19:58:32,826 \[pool-1-CertificateMonitoring-1\] ERROR com.symit  
ar.security.keystore.monitor.WebConsoleExpirationThresholdFinder  - cannot load  
properties.  using default expiration threshold value of 90    

[root@symdev1](mailto:root@symdev1) #cd KEYSTORE                                                        
[root@symdev1](mailto:root@symdev1) #fs                                                                 
total 40                                                                         
\-rwxrwx---	 1 SYM500	 SYM500		 360 Oct 29 2018  Security.properties	
\-rwxrwx---	 1 SYM500	 SYM500		 240 Oct 25 2018  Wire.keyconfig		
\-rwxrwx---	 1 SYM500	 SYM500		 4100 Oct 29 2018  WireKeyStore.jceks	
\-rwxrwx---	 1 SYM500	 SYM500		 32 Oct 25 2018  WireTrustStore.jceks	
[root@symdev1](mailto:root@symdev1) #																				
\-rwxr-x---	 1 SYM500	 SYM500		 94895 Nov 26 01:29 adminAuthServer.EXE	

 +3030          <Parameter name="KeyStoreAlias" isSubsetReference="false">       
 +3031              <value>wits</value>                                          
 +3032          </Parameter>                                                     
 +3033          <Parameter name\="KeyStoreConfigurationName" isSubsetReference="false">                                                                           
 +3034              <value>Wire</value>                                          
 +3035          </Parameter>                                                     
 +3036          <Parameter name="Protocol" isSubsetReference="false">            
 +3037              <value>https</value>                                         
 +3038          </Parameter>                                                   

  
 +3104          <Parameter name="KeyStoreAlias" isSubsetReference="false">       
 +3105              <value>a</value>                                             
 +3106          </Parameter>                                                     
 +3107          <Parameter name="KeyStoreConfigurationName" isSubsetReference="false">                                                                           
 +3108              <value>SymXchange</value>                                    
 +3109          </Parameter>                                                     
 +3110          <Parameter name="Protocol" isSubsetReference="false">            
 +3111              <value>https</value>                                         
 +3112          </Parameter>    
```

--------------------------------

### Set permissions with SYMACLSETALL

Source: https://jackhenry.dev/symxchange-api-docs/troubleshooting

Apply permissions to the configuration file using the SYMACLSETALL command.

```bash
# SYMACLSETALL SYMXXX (where XXX is your SYM number)
```

--------------------------------

### Sample SOAP fault response

Source: https://jackhenry.dev/symxchange-api-docs/troubleshooting

An example of a SOAP fault response containing an ErrorCode and a ProposedSolution field for debugging.

```xml
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
   <soap:Body>
      <soap:Fault>
         <faultcode>soap:Client</faultcode>
         <faultstring>[MessageId=Test] The argument DeviceNumber in your request was not 
         initialized correctly.</faultstring>
         <detail>
             <ErrorCode>1.17</ErrorCode>
            <ProposedSolution>Please be sure to set this argument correctly and try the process 
            again.</ProposedSolution>
         </detail>
      </soap:Fault>
   </soap:Body>
</soap:Envelope>
```

--------------------------------

### Configure Parameter Service in PARAMETERSERVICE.CFG

Source: https://jackhenry.dev/symxchange-api-docs/troubleshooting

Add your three-digit SYM number to the /SYM/CONFIGURE/PARAMETERSERVICE.CFG file to enable the Parameter Service for your SYM.

```text
# PARAMETERSERVICE.CFG
#
#This file specifies the SYMs that are configured to run the Parameter 
#Service. A single three digit SYM number should be listed per line.
#
#SYM
#123

```

--------------------------------

### Check Service createCheck Request and Response

Source: https://jackhenry.dev/symxchange-api-docs/troubleshooting

This example demonstrates the SOAP request and response for creating a check using the Check Service, which serves as a workaround for multiple disbursals.

```xml
<soapenv:Envelope xmlns:soapenv=http://schemas.xmlsoap.org/soap/envelope/ xmlns:chec=http://www.symxchange.generated.symitar.com/check xmlns:tns=http://www.symxchange.generated.symitar.com/common/dto/common>  
	<soapenv:Header/>  
	<soapenv:Body>  
	   <chec:createCheck>  
		  <!--Optional:-->  
		  <Request MessageId="?" chec:BranchId="0">  
			 <!--Optional:-->  
			 <CheckCreatableFields>  
				<!--Optional:--> 				  
				<AccountCode>00</AccountCode>  
				<AccountNumber>0000017111</AccountNumber>  
				<!--Optional:-->  
				<Amount>123</Amount>  
				<!--Optional:-->  
				<Branch>0</Branch>  
				<!--Optional:--> 			  
				<Id>01</Id>  
				<!--Optional:-->  
				<IdType>0</IdType>  
				<!--Optional:-->  
				<Number>0000001234</Number> 			  
				<Status>1</Status>  
			 </CheckCreatableFields>  
			 <!--Optional:-->  
			 <Credentials tns:ProcessorUser="0">  
				<!--You have a CHOICE of the next 3 items at this level-->  
				<!--Optional:-->  
				<AdministrativeCredentials>  
				   <!--Optional:-->  
				   <Password>will</Password>  
				</AdministrativeCredentials>  
			 </Credentials>  
			 <!--Optional:-->  
			 <DeviceInformation DeviceType="will" DeviceNumber="20205"/>  
		  </Request>  
	   </chec:createCheck>  
	</soapenv:Body>  
</soapenv:Envelope>
```

```xml
<soap:Envelope xmlns:soap=http://schemas.xmlsoap.org/soap/envelope/>  
	<soap:Body>  
	   <tns:createCheckResponse xmlns:common=http://www.symxchange.generated.symitar.com/common/dto/common xmlns:tns=http://www.symxchange.generated.symitar.com/check xmlns:create=http://www.symxchange.generated.symitar.com/check/dto/create xmlns:retrieve=http://www.symxchange.generated.symitar.com/check/dto/retrieve xmlns:update=http://www.symxchange.generated.symitar.com/check/dto/update>  
		  <CreateResponse MessageId="?">  
			 <CheckCompositeKey>  
				<CheckGlobalSequenceDate>2026-01-01</CheckGlobalSequenceDate>  
				<CheckGlobalSequence>145</CheckGlobalSequence>  
			 </CheckCompositeKey>  
		  </CreateResponse>  
	   </tns:createCheckResponse>  
	</soap:Body>  
</soap:Envelope>
```

--------------------------------

### Configure NumberOfRecordsToReturn in getShareTransactionPagedListSelectFields

Source: https://jackhenry.dev/symxchange-api-docs/troubleshooting

Example of the NumberOfRecordsToReturn element within a PagingRequestContext for controlling the maximum number of records returned in a response.

```xml
<PagingRequestContext>
<!--Optional:-->
<NumberOfRecordsToReturn>?</NumberOfRecordsToReturn>
<!--Optional:-->


```

--------------------------------

### LoanAddon SOAP Request

Source: https://jackhenry.dev/symxchange-api-docs/troubleshooting

An example of a loanAddon SOAP request containing administrative credentials, device information, and transaction details.

```xml
<REQUEST>
  <s:Envelope
   xmlns:s="[http://schemas.xmlsoap.org/soap/envelope/](http://schemas.xmlsoap.org/soap/envelope/)">
    <s:Body
     xmlns:xsi="[http://www.w3.org/2001/XMLSchema-instance](http://www.w3.org/2001/XMLSchema-instance)"
     xmlns:xsd="[http://www.w3.org/2001/XMLSchema](http://www.w3.org/2001/XMLSchema)">
      <loanAddon xmlns="[http://www.symxchange.generated.symitar.com/v1/transactions](http://www.symxchange.generated.symitar.com/v1/transactions)">
        <Request MessageId="ea1dacfb-78d4-49a9-a7d7-47dc3b1a98c9" xmlns="">
          <Credentials>
            <AdministrativeCredentials>
              <Password>yX4gyO6ygCm7sjWxrNTI1WMYrFo2X6WC5Gtir/uWhs9vlNDne5a3yAIgIOoU36Us</Password>
            </AdministrativeCredentials>
          </Credentials>
          <DeviceInformation DeviceType="CENTRIXDTS" DeviceNumber="2"/>
          <AccountNumber xmlns="[http://www.symxchange.generated.symitar.com/v1/transactions/dto](http://www.symxchange.generated.symitar.com/v1/transactions/dto)">1058940</AccountNumber>
          <LoanId xmlns="[http://www.symxchange.generated.symitar.com/v1/transactions/dto](http://www.symxchange.generated.symitar.com/v1/transactions/dto)">31</LoanId>
          <Amounts xmlns="[http://www.symxchange.generated.symitar.com/v1/transactions/dto](http://www.symxchange.generated.symitar.com/v1/transactions/dto)">
            <TotalAmount>122.10</TotalAmount>
            <CashAmount xmlns="">122.10</CashAmount>
          </Amounts>
          <Comment xmlns="[http://www.symxchange.generated.symitar.com/v1/transactions/dto](http://www.symxchange.generated.symitar.com/v1/transactions/dto)">Provisional Credit Reversal N 4292 PIGGLY WIGGLY #266 MCCALLA AL 36</Comment>
          <CommentCode xmlns="[http://www.symxchange.generated.symitar.com/v1/transactions/dto](http://www.symxchange.generated.symitar.com/v1/transactions/dto)">0</CommentCode>
          <EffectiveDate xmlns="[http://www.symxchange.generated.symitar.com/v1/transactions/dto](http://www.symxchange.generated.symitar.com/v1/transactions/dto)">2019-11-01</EffectiveDate>
          <GLAccounts xmlns="[http://www.symxchange.generated.symitar.com/v1/transactions/dto](http://www.symxchange.generated.symitar.com/v1/transactions/dto)">
            <ClearingAccount xmlns="">87700900000000</ClearingAccount>
          </GLAccounts>
          <SourceCode xmlns="[http://www.symxchange.generated.symitar.com/v1/transactions/dto](http://www.symxchange.generated.symitar.com/v1/transactions/dto)">D</SourceCode>
        </Request>
      </loanAddon><
    /s:Body>
  </s:Envelope>
</REQUEST>
```

--------------------------------

### Execute SymXLogAnalyzer command

Source: https://jackhenry.dev/symxchange-api-docs/troubleshooting

Run this command to analyze performance logs for a specific instance and time range.

```bash
/SYM/SYMPR/SymXLogAnalyzer -period=5 -instance=LIVEOLB -sym=000 -startTime=“03/30/2020 00:00” -stopTime=“03/30/2020 23:59” -directory=/SYM/ONHOST/log
```

--------------------------------

### Parameter Server process output

Source: https://jackhenry.dev/symxchange-api-docs/troubleshooting

This is the expected output when the Parameter Server process is running correctly.

```text
root 17760960 33554544 0 13:42:44 pts/68 0:00 /SYM/SYMPR/symitarParametersDB -sym=SYMxxx
```

--------------------------------

### SOAP Response for Error 13030

Source: https://jackhenry.dev/symxchange-api-docs/troubleshooting

Example SOAP envelope returned when an invalid transaction share or loan ID is specified.

```xml
<soap:Envelope xmlns:soap=http://schemas.xmlsoap.org/soap/envelope/>
    <soap:Body>
        <tns:payLoanResponse
         xmlns:tns=http://www.symxchange.generated.symitar.com/v1/transactions
         xmlns:transactionsdto=http://www.symxchange.generated.symitar.com/v1/transactions/dto>
            <Response MessageId="0" StatusCode="13030">
                <StatusMessage>An invalid transaction share or loan ID was specified </StatusMessage>
                <transactionsdto:OverdrawInformation>
                    <OverdrawToleranceAmount>0.00</OverdrawToleranceAmount>
                </transactionsdto:OverdrawInformation>
            </Response>
        </tns:payLoanResponse>
    </soap:Body>
</soap:Envelope>
```

--------------------------------

### Invalid Record Path Error Detail

Source: https://jackhenry.dev/symxchange-api-docs/troubleshooting

An example of the fault detail returned when an invalid record path is specified for a LoanTransfer record.

```xml
[MessageId=b524532f-dccb-9bec-919c-80e7ffddb9b8]  Error creating the LoanTransfer record: Failed to create record type LoanTransfer - An invalid record path was specified.
</faultstring>
<detail>
  <ErrorCode>100.100005</ErrorCode>
```
Tokens:
Raw