Safe Deposit Box
Overview
AcctMod Safe Deposit Box
This operation allows you to modify or delete a deposit, loan, time deposit, safe deposit, or non-Jack Henry account.
Behavior
Within the request, enter the account ID and type, along with the other elements that contain values that must be changed.
The response contains an RsStat
element, which indicates the result of the
operation, with a value of Success when completed, or
HdrFault if the provider is not able to complete the request.
The AcctInq
operation provides you with the ability to determine an
account's Card Opt In/Out status by passing the following filter:
AccountId
- This element is a complex element that contains the incoming account identification information. The simple elements in this complex are:AcctID
- Account IDAcctType
- Account Type
XPath Elements
XPath Elements
For this business service, certain template fields, or XPath elements, are sent in on the request and corresponding elements are returned in the response.
The following tables list the elements that you send on the request and what is sent back in the response. Each table also includes any pertinent notes, such as element values or whether it is required for input.
XPath Element | File/Field | Description | Notes |
---|---|---|---|
| JHFREFAPI.ERROVRRD | Error Override? | N/A |
| SDMAST.ACCTNO | Box Number | N/A |
| SDMAST.ACTYPE | Acct Type | N/A |
| N/A | Delete | N/A |
| SDMAST.RENT | Rent | N/A |
| SDMAST.BRANCH | Branch | N/A |
| SDMAST.LBSTAT | Status | N/A |
| SDMAST.DUEDT7 | Due Date | N/A |
| SDMAST.ARGPRDCOD | Argo Product Type | N/A |
| CFALTN.CFAAL1 | Additional Name #1 | N/A |
| CFALTN.CFAAL2 | Additional Name #2 | N/A |
| SDMAST.BOXID | Box ID | N/A |
| CFALTN.CFNA1 | Alias Name | N/A |
| CFALTN.CFNA1 | Alias First Name | N/A |
| CFALTN.CFNA1 | Alias Middle Name | N/A |
| CFALTN.CFNA1 | Alias Last Name | N/A |
| CFALTN.CFNA1 | Alias Short Name | N/A |
| SDMAST.KEYDEP | Key Deposit | N/A |
| SDMAST.DSCAMT | Discount Amount | N/A |
| SDMAST.DTOPN7 | Date Opened | N/A |
| SDMAST.GLCOST | GL Cost Center | N/A |
| SDMAST.GLPROD | GL Product Code | N/A |
| SDMAST.XCLUD | Include on Stmt | N/A |
| SDMAST.HOLDM | Hold Mail | N/A |
| SDMAST.DSCPCT | Discount Percentage | N/A |
| SDMAST.PRIME | Prime | N/A |
| SDMAST.CHGCOD | Charge Code | N/A |
| SDMAST.CHGACT | Acct to Charge | N/A |
| SDMAST.CHGTYP | Acct Type | N/A |
| SDMAST.LCTYPE | Late Charge Type | N/A |
| SDMAST.SIGVER | Verify Ent Sign | N/A |
| SDMAST.RSTENT | Entry Restricted | N/A |
| CFPARB.CBFDSC | Field Description 1 – 39 | There are 39 total elements available for entering information. |
| CFPARB.CBFDFT | Field Default Value 1 – 39 | There are 39 total elements available for entering information. |
| SDMAST.SECURE | Account Level Security | N/A |
| SDMAST.SALESAC | Sales Associate | N/A |
| SDMAST.SDLANG | Language Identifier | Canonical
|
| SDMAST.SDEXM | Tax Exempt | N/A |
| CFFOPI.CFFACNAME | Name of Person Opening Account | N/A |
| CFFOPI.CFFACTITLE | Title of Person Opening Account | N/A |
XPath Element | File/Field | Description | Notes |
---|---|---|---|
RsStat | JHFREFAPI.PASSFAIL | Pass/Fail Status | N/A |
Field/Field | Maintenance Description | Field Label |
---|---|---|
SDMAST.ACCTNO | Account Number | Account Number |
SDMAST.ACTYPE | Account Type | Account Type |
All elements are evaluated and if the value sent in is different from the core file value and the process is completed successfully, then a maintenance record for that field with the field changes is written out.
Validations
Validations
Within the response, specific validations can appear in the response if incorrect or different information than what is required is sent in the request.
The following table lists the errors that can be returned and includes what prompts the validation to occur.
Code | Element | System Message | Validation Trigger |
---|---|---|---|
1 | AcctId | Account not found | Presents when the account number/type combination is not found in the Safe Deposit Master File (SDMAST). |
1 | AcctType | Account not found | Presents when the account number/type combination is not found in the Safe Deposit Master File (SDMAST). |
5 | N/A | Cannot allocate files | Presents when the files used within the procedure are not available at the time of the request. |
5 | EstbPersonName | Cannot allocate files | Presents when the files used within the procedure are not available at the time of the request. |
13 | BrCode | Branch number is not valid | Presents when the value in this field is not found in the Bank/Branch Information File (JHDATA). |
36 | GlCostCtr | GL Interface is not valid | Presents when the value in this element is not a valid value in the GL Standard Application Interface (GLINT1). |
40 | IncCombStmt | Include on combined statements. Flag must be Y or N. | Presents when this element is not sent with a value of Y or N. |
43 | N/A | Date is not valid | Presents when the value of the date is not valid, such as fewer than six digits or all zeros. |
45 | N/A | Numeric data is not valid | Presents when a numeric value is not entered in this element. |
46 | HldMailCode | Mailing Instruction code is not valid | Presents when the value in this element is not blank or is not found in the Hold Mail Code Parameter File (JHMAIL). |
68 | N/A | Special Information Code 1 must be Y or N | Presents when the value in this element is not sent as Y or N. |
69 | N/A | Special Information Code 2 must be Y or N | Presents when the value in this element is not sent as Y or N. |
70 | N/A | Special Information Code 3 must be Y or N | Presents when the value in this element is not sent as Y or N. |
71 | N/A | Special Information Code 4 must be Y or N | Presents when the value in this element is not sent as Y or N. |
112 | UserDefCode | Description is invalid | Presents when there is no user description sent when the user code is sent. |
112 | UserDefTxt | Description is invalid | Presents when there is no user description sent when the user code is sent. |
130 | N/A | The value entered is longer than the field length | Presents when the value sent is longer than the length allowed for the element. |
400 | Lang Type | Language Code is not a valid code | Presents when this element is not blank or is not found in the Preferred Language Parameter File (JHPARL). |
1005 | N/A | Date field has an invalid format | Presents when the date is not in a valid format, such as XX/XX/XXX or XX-XX-XXXX. |
2000 | N/A | Maintenance denied due to data not being current | Presents when the field modified has not changed since the last inquiry. |
202010 | EstbPersonTitle | Cannot be blank | Presents when this element is sent as blank. |
202010 | EstbPersonName.ComName | Cannot be blank | Presents when this element is sent as blank. |
410080 | SalesPerson | Invalid Sales Associate Code | Presents when the value in this element is not blank or is not found in the JHPARJ file. |
600012 | AbbName | Short Name is required | Presents when Individual field is not set to Y and this element is blank. |
600013 | ComName | Alternate name is required | Presents when the FirstName and
LastName elements are not blank and the
Individual field is set to Y. |
600014 | FirstName | First, Middle, and Last Name information required to build Alternate Short Name | Presents when the Individual field is set to Y and these elements are sent as blank. |
600014 | LastName | First, Middle, and Last Name information required to build Alternate Short Name | Presents when the Individual field is set to Y and these elements are sent as blank. |
600014 | MiddleName | First, Middle, and Last Name information required to build Alternate Short Name | Presents when the Individual field is set to Y and these elements are sent as blank. |
700005 | RentalRateIdx | Invalid Rental Rate Number | Presents when the value in this element is not equal to zero or does not match records found in the Safe Deposit Rental Rate File (SDPRIM). |
700007 | GLCostCtr | Invalid cost center | Presents when the value in this element is not found in the Cost Center Parameter File (GLPAR7). |
700008 | GLProdCode | Invalid product code | Presents when the value in this element is not found in the Product Code Parameter File (GLPAR9). |
700009 | NxtPayDt | Invalid Due Date | Presents when the date is equal to zero or does not have enough digits. |
700010 | OpenDt | Invalid date opened | Presents when the date is equal to zero. |
700011 | OpenDt | Date opened cannot be in the future | Presents when the date in this element is greater than the current date. |
700013 | DiscAmt | Discount Amount and Discount Percentage cannot both be populated | Presents when the DiscAmt element and
DiscPct element are both not equal to zero. |
700013 | DiscPct | Discount Amount and Discount Percentage cannot both be populated | Presents when the DiscAmt element and
DiscPct element are both not equal to zero. |
700014 | DiscPct | Discount Percentage cannot exceed 100 percent | Presents when this element has a value greater than 100. |
700015 | ChgMthd | Charge Code must be C, M, or N | Presents when the value in this element is not C, M, or N. |
700016 | ChgAcctId | Charge Account and Type must be entered when Charge Code is C | Presents when the charge code is equal to C
and the ChgAcctId and ChgMthd elements are sent as
zero or blank. |
700016 | ChgMthd | Charge Account and Type must be entered when Charge Code is C | Presents when the charge code is equal to C
and the ChgAcctId and ChgMthd elements are sent as
zero or blank. |
700017 | ChgAcctId | If Charge Account or Charge Type are entered, then Charge Code must be C | Presents when the ChgAcctType and
ChgMthd elements are populated and the charge code is not equal to
C. |
700017 | ChgAcctType | If Charge Account or Charge Type are entered, then Charge Code must be C | Presents when the ChgAcctType and
ChgMthd elements are populated and the charge code is not equal to
C. |
700017 | ChgMthd | If Charge Account or Charge Type are entered, then Charge Code must be C | Presents when the ChgAcctType and
ChgMthd elements are populated and the charge code is not equal to
C. |
700018 | ChgAcctId | Account to charge in invalid | Presents when the charge code is equal to C
and the ChgAcctId /ChgAcctType combination is not
found in the Deposit Master File (DDMAST) or the
Deposit New Accounts Today (DDTNEW) file. |
700018 | ChgAcctType | Account to charge in invalid | Presents when the charge code is equal to C
and the ChgAcctId /ChgAcctType combination is not
found in the Deposit Master File (DDMAST) or the
Deposit New Accounts Today (DDTNEW) file. |
700019 | SalesTaxExmp | Sales Tax Exempt Code must be Y or N | Presents when this element is not sent as Y or N. |
700020 | RstrEntryCode | Restricted Entry Code must be D, H, O, P, R, or blank | Presents when this element is not set to D, H, O, P, R, or blank. |
700021 | LateChgCode | Late Charge Type is invalid | Presents when this element is populated but the value is not found in the Safe Deposit Late Charge Parameter File (SDPAR6) |
700022 | AcctLvlSecCode | Security Override must be B, A, N, E, or blank | Presents when this element is not equal to B, A, N, E, or blank. |
700023 | DiscAmt | Discount Amount cannot be greater than the Rental Amount | Presents when the value in the DiscAmt element is
greater then the value in the RentAmt element. |
700026 | ChgMthd | Charge Code is invalid when Partial Payment exists on box | Presents when the Partial Payment field is
not equal to zero and the ChgMthd element is equal to
C or N. |
700026 | ChgAcctId | Charge Code is invalid when Partial Payment exists on box | Presents when the Partial Payment field is
not equal to zero and the ChgMthd element is equal to
C or N. |
700027 | AcctStat | Status must be O or U | Presents when the value in this element is not equal to O, U, or D. |
700028 | SigVerifyCode | Signature Verification must be Y or N | Presents when this element is not equal to Y or N. |
700029 | ChgAcctType | Account Type to charge must be D, S, or blank | Presents when this element is not equal to D, S, or blank. |
700030 | AcctStat | Invalid status. Must be U or N. | Presents when the value in this element is not equal to U or N. |
700031 | AcctType | Cannot delete a safe box record | Presents when the Delete field is Y and the account number/type combination cannot be deleted. |
700031 | AcctId | Cannot delete a safe box record | Presents when the Delete field is Y and the account number/type combination cannot be deleted. |
700032 | NxtPayDt | Bill Pending/Due Date cannot be changed | Presents when the value of the due date is not equal to the due date found in the core file and a record exists in Safety Deposit Box Billing Physical File (SDBILL). |
The following table lists the faults that can be returned and includes what prompts the validation to occur.
Code | Element | System Message | Validation Trigger |
---|---|---|---|
100002 | IncCombStmt | Account has a combined statement relationship that will be deleted | Presents when this element is equal to N and the account number/type combination is not found in the Combined Statement File (DDCOMB). |
600015 | ComName | Account has an Alternate Name record that will be deleted | Presents when an alternate name exists and the Alternate Name Delete field is set to *on. |
700006 | RentAmt | Rental Amount is not equal to the Rental Rate Number amount | Presents when the value in this element is not equal to the rental rate. |
700025 | AcctId | Box has bills pending | Presents when a record exists in the Safety Deposit Box Billing Physical File (SDBILL) for the account number/type combination. |
The following table lists the warnings that can be returned and includes what prompts the validation to occur.
Code | Element | System Message | Validation Trigger |
---|---|---|---|
202009 | EstbPersonName.ComName | Primary CIF's FinCEN Legal Entity is set to "Include" Name and Title of person | Presents when the FinCEN Legal Entity field is set to I and the name and title are blank. |
202009 | EstbPersonTitle | Primary CIF's FinCEN Legal Entity is set to "Include" Name and Title of person | Presents when the FinCEN Legal Entity field is set to I and the name and title are blank. |
400027 | N/A | Customer name closely matches OFAC suspect | Presents when the OFAC search has a match or one that closely matches. |
402500 | N/A | No OFAC match found | Presents when the OFAC search does not have a match. |
402527 | N/A | OFAC matching word | Presents when checking for OFAC keywords and gets a match. |
Service Dictionary
Service Dictionary
Service Dictionary Search provides consumers a service that can convey a service provider's element XSD path, requirements, default values, open enumerated canonical values, help/knowledge content, and fault codes per operation.
Within the SvcDictSrch
operation, you can send
AcctMod in the SvcDictName
element and
Rq or Rs in the SvcDictType
element. Within the response, SvcDictSrch
returns all mapped elements,
including any newly mapped elements, and any elements that have specific allowed values. The
following table lists the response information for elements with specified allowed values.
Element Name | Field Value (ElemCanocVal) | Field Description (ElemCanocValDesc) |
---|---|---|
RentAmt | Pulls from SDMAST.RENT | Rent |
BrCode | Pulls from SDMAST.BRANCH | Branch |
AcctStat | D | Drill |
AcctStat | N | Not Available |
AcctStat | O | Occupied |
AcctStat | U | Unoccupied |
SafeDepBoxRef | Pulls from SDMAST.BOXID | Box ID |
GlCostCrt | Pulls from SDMAST.GLCOST | GL Cost Center |
GLProdCode | Pulls from SDMAST.GLPROD | GL Product Code |
HldMailCode | A | Address Not on File |
HldMailCode | B | Forward to Deposit Operations |
HldMailCode | C | Forward to CD/IRA Team |
HldMailCode | D | Forward to Drive In |
HldMailCode | E | Employee - Do Not Mail |
HldMailCode | L | Forward to Loan Operations |
HldMailCode | O | Forward to Bus Dev Officer |
HldMailCode | P | POD Only - Non-Customer |
HldMailCode | S | Forward to Branch |
HldMailCode | X | Forward to Collections |
HldMailCode | Y | Hold Mail |
RentalRateIdx | Pulls from SDMAST.PRIME | Prime |
ChgMthd | C | Charge DDA or Savings Account |
ChgMthd | M | Generate a Mail Notice |
ChgMthd | N | No Charge |
ChgAcctType | D | Demand Deposit Account |
ChgAcctType | S | Savings Account |
SigVerifyCode | N | No |
SigVerifyCode | Y | Yes |
RstrEntryCode | D | The Box Renter is Deceased |
RstrEntryCode | H | Entry Restricted or Held by Box Renter |
RstrEntryCode | O | Entry Restricted or Held by Court Order |
RstrEntryCode | P | Entry Restricted: Rent Payment is Past Due |
RstrEntryCode | R | Entry Restricted for Some Other Reason |
AcctLvlSecCode | A | All Access |
AcctLvlSecCode | B | Balance Only Access |
AcctLvlSecCode | E | Existence Only |
AcctLvlSecCode | N | No Access Including Existence |
SalesPerson | Pulls from SDMAST.SALESAC | Sales Associate |
LangType | Blank | English (Default) |
LangType | ENG | English |
LangType | FRE | French |
LangType | GER | German |
LangType | POL | Polish |
LangType | SPA | Spanish |
LangType | SWE | Swedish |
UserDefCode | N | No |
UserDefCode | Y | Yes |