Developer Resources
Details
SoapAction | http://jackhenry.com/ws/CardAlrtMod |
Input Name | CardAlrtMod |
Output Name | CardAlrtModResponse |
Input Namespace | http://jackhenry.com/jxchange/TPG/2008 |
Group Name | Customer |
Container | TPG_CustomerMaster.xsd |
XML Examples
CardAlrtMod-XML-A03
<?xml version="1.0" encoding="UTF-8"?>
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<SOAP-ENV:Header>
<wsse:Security xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd"
xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd">
<wsse:UsernameToken xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd">
<wsse:Username>{Insert}</wsse:Username>
<wsse:Password Type="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#PasswordText">{Insert}</wsse:Password>
</wsse:UsernameToken>
</wsse:Security>
</SOAP-ENV:Header>
<SOAP-ENV:Body>
<CardAlrtMod xmlns="http://jackhenry.com/jxchange/TPG/2008">
<MsgRqHdr>
<jXchangeHdr>
<JxVer/>
<AuditUsrId></AuditUsrId>
<AuditWsId></AuditWsId>
<AuthenUsrId/>
<ConsumerName></ConsumerName>
<ConsumerProd></ConsumerProd>
<Ver_1/>
<jXLogTrackingId>{Insert}</jXLogTrackingId>
<Ver_2/>
<InstRtId>012343210</InstRtId>
<InstEnv>TEST</InstEnv>
<Ver_3/>
<BusCorrelId/>
<Ver_4/>
<WorkflowCorrelId/>
<Ver_5/>
<ValidConsmName>{Insert}</ValidConsmName>
<ValidConsmProd>{Insert}</ValidConsmProd>
<Ver_6/>
</jXchangeHdr>
<Ver_1/>
<Ver_2/>
<Ver_3/>
</MsgRqHdr>
<ErrOvrRdInfoArray/>
<CustId>{Insert}</CustId>
<EFTCardNum>{Insert}</EFTCardNum>
<CardAlrtCode>A03</CardAlrtCode>
<AlrtActType>Act</AlrtActType>
<CardAlrtUsrDesc/>
<!-- Note this sets both threshold codes to Act -->
<CardAlrtThldCode>A03T00,A03T01</CardAlrtThldCode>
<ActIntentKey>199602</ActIntentKey>
<Dlt/>
<Custom/>
<Ver_1/>
<CardAlrtRegionId/>
<Ver_2/>
</CardAlrtMod>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
CardAlrtMod-XML-A04Activate
<?xml version="1.0" encoding="UTF-8"?>
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<SOAP-ENV:Header>
<wsse:Security xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd"
xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd">
<wsse:UsernameToken xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd">
<wsse:Username>{Insert}</wsse:Username>
<wsse:Password Type="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#PasswordText">{Insert}</wsse:Password>
</wsse:UsernameToken>
</wsse:Security>
</SOAP-ENV:Header>
<SOAP-ENV:Body>
<CardAlrtMod xmlns="http://jackhenry.com/jxchange/TPG/2008">
<MsgRqHdr>
<jXchangeHdr>
<JxVer/>
<AuditUsrId></AuditUsrId>
<AuditWsId></AuditWsId>
<AuthenUsrId/>
<ConsumerName></ConsumerName>
<ConsumerProd></ConsumerProd>
<Ver_1/>
<jXLogTrackingId>{Insert}</jXLogTrackingId>
<Ver_2/>
<InstRtId>012343210</InstRtId>
<InstEnv>TEST</InstEnv>
<Ver_3/>
<BusCorrelId/>
<Ver_4/>
<WorkflowCorrelId/>
<Ver_5/>
<ValidConsmName>{Insert}</ValidConsmName>
<ValidConsmProd>{Insert}</ValidConsmProd>
<Ver_6/>
</jXchangeHdr>
<Ver_1/>
<Ver_2/>
<Ver_3/>
</MsgRqHdr>
<ErrOvrRdInfoArray/>
<CustId>122222222</CustId>
<EFTCardNum>{Insert}</EFTCardNum>
<CardAlrtCode>A04</CardAlrtCode>
<AlrtActType>Act</AlrtActType>
<CardAlrtUsrDesc/>
<CardAlrtThldCode>A04T00,A04T01,A04T02,A04T03,A04T04,A04T05,A04T06,A04T07,A04T08,A04T09</CardAlrtThldCode>
<ActIntentKey>210829</ActIntentKey>
<Dlt></Dlt>
<Custom/>
<Ver_1/>
<CardAlrtRegionId/>
<Ver_2/>
</CardAlrtMod>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
CardAlrtMod-XML-A05
<?xml version="1.0" encoding="UTF-8"?>
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<SOAP-ENV:Header>
<wsse:Security xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd"
xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd">
<wsse:UsernameToken xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd">
<wsse:Username>{Insert}</wsse:Username>
<wsse:Password Type="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#PasswordText">{Insert}</wsse:Password>
</wsse:UsernameToken>
</wsse:Security>
</SOAP-ENV:Header>
<SOAP-ENV:Body>
<CardAlrtMod xmlns="http://jackhenry.com/jxchange/TPG/2008">
<MsgRqHdr>
<jXchangeHdr>
<JxVer/>
<AuditUsrId></AuditUsrId>
<AuditWsId></AuditWsId>
<AuthenUsrId/>
<ConsumerName></ConsumerName>
<ConsumerProd></ConsumerProd>
<Ver_1/>
<jXLogTrackingId>{Insert}</jXLogTrackingId>
<Ver_2/>
<InstRtId>012343210</InstRtId>
<InstEnv>TEST</InstEnv>
<Ver_3/>
<BusCorrelId/>
<Ver_4/>
<WorkflowCorrelId/>
<Ver_5/>
<ValidConsmName>{Insert}</ValidConsmName>
<ValidConsmProd>{Insert}</ValidConsmProd>
</jXchangeHdr>
</MsgRqHdr>
<ErrOvrRdInfoArray/>
<CustId>{Insert}</CustId>
<EFTCardNum>{Insert}</EFTCardNum>
<CardAlrtCode>A05</CardAlrtCode>
<AlrtActType>Act</AlrtActType>
<CardAlrtUsrDesc/>
<CardAlrtRegionUsrDesc>Casper</CardAlrtRegionUsrDesc>
<CardAlrtRegionLat>42.848705</CardAlrtRegionLat>
<CardAlrtRegionLong>-106.31739</CardAlrtRegionLong>
<CardAlrtRegionRadius>50.0</CardAlrtRegionRadius>
<ActIntentKey>199602</ActIntentKey>
<Dlt/>
<Custom/>
<Ver_1/>
<CardAlrtRegionId>0</CardAlrtRegionId>
<Ver_2/>
</CardAlrtMod>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
CardAlrtMod-XML-A05Remove
<?xml version="1.0" encoding="UTF-8"?>
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<SOAP-ENV:Header>
<wsse:Security xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd"
xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd">
<wsse:UsernameToken xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd">
<wsse:Username>{Insert}</wsse:Username>
<wsse:Password Type="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#PasswordText">{Insert}</wsse:Password>
</wsse:UsernameToken>
</wsse:Security>
</SOAP-ENV:Header>
<SOAP-ENV:Body>
<CardAlrtMod xmlns="http://jackhenry.com/jxchange/TPG/2008">
<MsgRqHdr>
<jXchangeHdr>
<JxVer/>
<AuditUsrId>PA</AuditUsrId>
<AuditWsId>PA</AuditWsId>
<AuthenUsrId/>
<ConsumerName></ConsumerName>
<ConsumerProd></ConsumerProd>
<Ver_1/>
<jXLogTrackingId>{Insert}</jXLogTrackingId>
<Ver_2/>
<InstRtId>012343210</InstRtId>
<InstEnv>TEST</InstEnv>
<Ver_3/>
<BusCorrelId/>
<Ver_4/>
<WorkflowCorrelId/>
<Ver_5/>
<ValidConsmName>{Insert}</ValidConsmName>
<ValidConsmProd>{Insert}</ValidConsmProd>
</jXchangeHdr>
</MsgRqHdr>
<ErrOvrRdInfoArray/>
<CustId>122222222</CustId>
<EFTCardNum>{Insert}</EFTCardNum>
<CardAlrtCode>A05</CardAlrtCode>
<AlrtActType>Act</AlrtActType>
<CardAlrtUsrDesc/>
<CardAlrtRegionUsrDesc>Casper</CardAlrtRegionUsrDesc>
<CardAlrtRegionLat>42.848705</CardAlrtRegionLat>
<CardAlrtRegionLong>-106.31739</CardAlrtRegionLong>
<CardAlrtRegionRadius>45.0</CardAlrtRegionRadius>
<ActIntentKey>210829</ActIntentKey>
<Dlt>false</Dlt>
<Custom/>
<Ver_1/>
<CardAlrtRegionId JHANull="true">99309</CardAlrtRegionId>
<Ver_2/>
</CardAlrtMod>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
CardAlrtMod-XML-A06
<?xml version="1.0" encoding="UTF-8"?>
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<SOAP-ENV:Header>
<wsse:Security xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd"
xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd">
<wsse:UsernameToken xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd">
<wsse:Username>{Insert}</wsse:Username>
<wsse:Password Type="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#PasswordText">{Insert}</wsse:Password>
</wsse:UsernameToken>
</wsse:Security>
</SOAP-ENV:Header>
<SOAP-ENV:Body>
<CardAlrtMod xmlns="http://jackhenry.com/jxchange/TPG/2008">
<MsgRqHdr>
<jXchangeHdr>
<JxVer/>
<AuditUsrId></AuditUsrId>
<AuditWsId></AuditWsId>
<AuthenUsrId/>
<ConsumerName></ConsumerName>
<ConsumerProd></ConsumerProd>
<Ver_1/>
<jXLogTrackingId>{Insert}</jXLogTrackingId>
<Ver_2/>
<InstRtId>012343210</InstRtId>
<InstEnv>TEST</InstEnv>
<Ver_3/>
<BusCorrelId/>
<Ver_4/>
<WorkflowCorrelId/>
<Ver_5/>
<ValidConsmName>{Insert}</ValidConsmName>
<ValidConsmProd>{Insert}</ValidConsmProd>
</jXchangeHdr>
</MsgRqHdr>
<ErrOvrRdInfoArray/>
<CustId>{Insert}</CustId>
<EFTCardNum>{Insert}</EFTCardNum>
<CardAlrtCode>A06</CardAlrtCode>
<AlrtActType>Act</AlrtActType>
<CardAlrtUsrDesc>FullMoon</CardAlrtUsrDesc>
<CardAlrtThldCode>A06T01</CardAlrtThldCode>
<!-- Note this is $80 and less than A09 example -->
<CardAlrtThldVal>80</CardAlrtThldVal>
<ActIntentKey>{Insert}</ActIntentKey>
<Dlt/>
<Custom/>
<Ver_1/>
<Ver_2/>
</CardAlrtMod>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
CardAlrtMod-XML-A09
<?xml version="1.0" encoding="UTF-8"?>
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<SOAP-ENV:Header>
<wsse:Security xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd"
xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd">
<wsse:UsernameToken xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd">
<wsse:Username>{Insert}</wsse:Username>
<wsse:Password Type="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#PasswordText">{Insert}</wsse:Password>
</wsse:UsernameToken>
</wsse:Security>
</SOAP-ENV:Header>
<SOAP-ENV:Body>
<CardAlrtMod xmlns="http://jackhenry.com/jxchange/TPG/2008">
<MsgRqHdr>
<jXchangeHdr>
<JxVer/>
<AuditUsrId></AuditUsrId>
<AuditWsId></AuditWsId>
<AuthenUsrId/>
<ConsumerName></ConsumerName>
<ConsumerProd></ConsumerProd>
<Ver_1/>
<jXLogTrackingId>{Insert}</jXLogTrackingId>
<Ver_2/>
<InstRtId>012343210</InstRtId>
<InstEnv>TEST</InstEnv>
<Ver_3/>
<BusCorrelId/>
<Ver_4/>
<WorkflowCorrelId/>
<Ver_5/>
<ValidConsmName>{Insert}</ValidConsmName>
<ValidConsmProd>{Insert}</ValidConsmProd>
</jXchangeHdr>
</MsgRqHdr>
<ErrOvrRdInfoArray/>
<CustId>{Insert}</CustId>
<EFTCardNum>{Insert}</EFTCardNum>
<CardAlrtCode>A09</CardAlrtCode>
<AlrtActType>Act</AlrtActType>
<CardAlrtUsrDesc>Movies</CardAlrtUsrDesc>
<CardAlrtThldCode>A09T01</CardAlrtThldCode>
<!-- Note this is $3000 and more than A06 example -->
<CardAlrtThldVal>3000</CardAlrtThldVal>
<ActIntentKey>199602</ActIntentKey>
<Dlt/>
<Custom/>
<Ver_1/>
<CardAlrtRegionId/>
<Ver_2/>
</CardAlrtMod>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
CardAlrtMod-XML-C01
<?xml version="1.0" encoding="UTF-8"?>
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<SOAP-ENV:Header>
<wsse:Security xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd"
xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd">
<wsse:UsernameToken xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd">
<wsse:Username>{Insert}</wsse:Username>
<wsse:Password Type="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#PasswordText">{Insert}</wsse:Password>
</wsse:UsernameToken>
</wsse:Security>
</SOAP-ENV:Header>
<SOAP-ENV:Body>
<CardAlrtMod xmlns="http://jackhenry.com/jxchange/TPG/2008">
<MsgRqHdr>
<jXchangeHdr>
<JxVer/>
<AuditUsrId></AuditUsrId>
<AuditWsId></AuditWsId>
<AuthenUsrId/>
<ConsumerName></ConsumerName>
<ConsumerProd></ConsumerProd>
<Ver_1/>
<jXLogTrackingId>{Insert}</jXLogTrackingId>
<Ver_2/>
<InstRtId>012343210</InstRtId>
<InstEnv>TEST</InstEnv>
<Ver_3/>
<BusCorrelId/>
<Ver_4/>
<WorkflowCorrelId/>
<Ver_5/>
<ValidConsmName>{Insert}</ValidConsmName>
<ValidConsmProd>{Insert}</ValidConsmProd>
</jXchangeHdr>
</MsgRqHdr>
<ErrOvrRdInfoArray/>
<CustId>122222222</CustId>
<EFTCardNum>0027006000000840</EFTCardNum>
<CardAlrtCode>A01</CardAlrtCode>
<!-- Act disables the card -->
<AlrtActType>Act</AlrtActType>
<ActIntentKey>199602</ActIntentKey>
<Dlt></Dlt>
<Custom/>
<Ver_1/>
<CardAlrtRegionId></CardAlrtRegionId>
<Ver_2/>
</CardAlrtMod>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
CardAlrtMod-XML-Remove
<?xml version="1.0" encoding="UTF-8"?>
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<SOAP-ENV:Header>
<wsse:Security xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd"
xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd">
<wsse:UsernameToken xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd">
<wsse:Username>{Insert}</wsse:Username>
<wsse:Password Type="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#PasswordText">{Insert}</wsse:Password>
</wsse:UsernameToken>
</wsse:Security>
</SOAP-ENV:Header>
<SOAP-ENV:Body>
<CardAlrtMod xmlns="http://jackhenry.com/jxchange/TPG/2008">
<MsgRqHdr>
<jXchangeHdr>
<JxVer/>
<AuditUsrId></AuditUsrId>
<AuditWsId></AuditWsId>
<AuthenUsrId/>
<ConsumerName></ConsumerName>
<ConsumerProd></ConsumerProd>
<Ver_1/>
<jXLogTrackingId>{Insert}</jXLogTrackingId>
<Ver_2/>
<InstRtId>012343210</InstRtId>
<InstEnv>TEST</InstEnv>
<Ver_3/>
<BusCorrelId/>
<Ver_4/>
<WorkflowCorrelId/>
<Ver_5/>
<ValidConsmName>{Insert}</ValidConsmName>
<ValidConsmProd>{Insert}</ValidConsmProd>
<Ver_6/>
</jXchangeHdr>
<Ver_1/>
<Ver_2/>
<Ver_3/>
</MsgRqHdr>
<ErrOvrRdInfoArray/>
<CustId>122222222</CustId>
<EFTCardNum>0027006000000222</EFTCardNum>
<CardAlrtCode>A04</CardAlrtCode>
<AlrtActType>InAct</AlrtActType>
<ActIntentKey>210829</ActIntentKey>
<Dlt>true</Dlt>
<Custom/>
<Ver_1/>
<CardAlrtRegionId/>
<Ver_2/>
</CardAlrtMod>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
FAQ
CardAlrtModFAQ-ActiveInactive
Q: CardAlrtCode has C01 as Card Off. How do you turn it on?
A: When C01 has
<AlrtActType>Act</AlrtActType>
the card is OFF.
When C01 has <AlrtActType>InAct</AlrtActType>
and
<Dlt>true</Dlt>
the card is ON.
Q: Is the delete element
<Dlt>
required?
A: It is when <AlrtActType>
is set to
InAct. <Dlt>
needs to be true.
Q: How do I set more than one
<CardAlrtThldCode>
since there isn't an array?
A: You need to separate them by a comma and include all of them that you want active.
<CardAlrtCode>A03</CardAlrtCode>
<AlrtActType>Act</AlrtActType>
<CardAlrtUsrDesc/>
<CardAlrtThldCode>A03T00,A03T01,A03T04,A03T07</CardAlrtThldCode>
<ActIntentKey>199602</ActIntentKey>
<Dlt/>
In this example A03T00, A03T01, A03T04, and A03T07 would be active. A03T02 and A03T05 would be inactive, even if they were active before.
Q: Say I have A03T00,A03T01, and A03T04 active. How do I inactive A03T00?
A: If you have more than one active like this case and only want to inactive one of them you must send an Activate(Act) instead of an InAct. Seems strange, but an InAct inactivates all A03 in this case.
Correct
<CardAlrtCode>A03</CardAlrtCode>
<AlrtActType>Act</AlrtActType>
<CardAlrtUsrDesc/>
<CardAlrtThldCode>A03T01,A03T04</CardAlrtThldCode>
<ActIntentKey>210830</ActIntentKey>
<Dlt/>
Wrong
<CardAlrtCode>A03</CardAlrtCode>
<AlrtActType>InAct</AlrtActType>
<CardAlrtUsrDesc/>
<CardAlrtThldCode>A03T00</CardAlrtThldCode>
<ActIntentKey>210830</ActIntentKey>
<Dlt>true</Dlt>
Q: Somehow I got My Regions as InAct and tried to get it Act with one of my regions and it will not activate it. How do I do it?
A: Set the CardAlrtRegionId element to zero and it will create a new region and My Regions will be Active again with a different RegionId.
CardAlrtModFAQ-General
Q: Where do we get this CustId from?
A: You can use the FI CustId value or create your own value. Note that if you create your own, you will need to know the CustId for every card. Thus, you will need to store the value if you use anything besides the CustID from the core.
Q: Are both an A06 code and A09 code being Active (Act) necessary?
A: No, however one of the things with the A09 monthly spend limit to keep in mind is that the threshold – spend limit – value must be greater than the A06 transaction spend limit threshold when both are enabled.
Q: What are the enumerations?
A: CardAlrtThldCode table is used for A03 and A04 (enumerated)
CardAlrtCode
Alert (A) and Control (C)
Code | Description |
---|---|
C01 | Card Off (more info on C01 below) |
A02** C02 | My Location – within X distance of my phone |
A03 C03* | Transaction Type (enumerated) |
A04 C04 | Merchant Type (enumerated) |
A05 C05 | My Regions - applies to in-store transactions |
A06 C06 | Spend Limit Per Transaction - must be > 0 and < A/C09 |
A07 C07 | International |
A09 C09 | Spend Limit – Monthly - must be > 0 and > A/C06 |
A028 | Alert None Including non-preferences |
A029 | No Alerts - when enabled a triggered alert is not sent |
A030 | All Transactions send an alert when enabled |
*Controls will not impact recurring payments unless the member sets controls specifically on the recurring payment category.
**A02/C02 will not be available until sometime in 2022
CardAlrtThldCode
(Merchant type for MCC Alert)
Code | Description |
---|---|
A03T00 C03T00 | In store transaction |
A03T01 C03T01 | eCommerce |
A03T02 C03T02 | Mail/Phone Order |
A03T04 C03T04 | Recurring |
A03T05 C03T05 | ATM |
A03T07 C03T07 | Other |
------ | -------------------- |
A04T00 C04T00 | Department Store |
A04T01 C04T01 | Entertainment |
A04T02 C04T02 | Gas Station |
A04T03 C04T03 | Grocery |
A04T04 C04T04 | Household |
A04T05 C04T05 | Personal Care |
A04T06 C04T06 | Restaurant |
A04T07 C04T07 | Travel |
A04T08 C04T08 | Age Restricted |
A04T09 C04T09 | Other |
------ | -------------------- |
A06T01 C06T01 | Spend Limit/transaction |
------ | -------------------- |
A09T01 C09T01 | Spend Limit/month |
Q: Transaction Type A03 doesn't seem to be using
<CardAlrtThldVal>
?
A: <CardAlrtThldVal>
is used on only
A06 and A09.
Q: Does the CardAlrtThldVal use dollars and cents?
A: No, CardAlrtThldVal only uses whole dollars
(i.e <CardAlrtThldVal>3000</CardAlrtThldVal>
).
Q: If CardAlrtCode C01 turns the card off, are all transactions off including recurring?
A: If a card is turned “off”, all transactions made on the card, other than pre-authorized recurring transactions, credits/payments, or balance consolidations will be denied. Recurring payments (i.e. Netflix) are typically pre-authorized so no authorization request is made when the payment processes, thus MyCardRules does not have the ability to block the authorization.
Q: Where do I get the Activity Intention Key
<ActIntentKey>
and what is it?
A: You can perform a
<CardAlrtSubInq>
for the card and it is returned in the
response. The <ActIntentKey>
represents the
card reference identification in the system.
Q: I discovered by accident that when you run CardAlrtMod on an account with multiple cards, using the Valid Card with a valid ActIntentKey from another valid card on the subscription, the result is the card belonging to the valid ActIntentKey is changed and not the valid card.
A: Yes, it seems like there is a lack of validation. However, we don't have any control on upstream code. To prevent this you will need to ensure your code uses the correct ActIntentKey.
Q: Does A07/C07 currently work?
A: I was hoping to tour Europe and test it, but they didn't approve it. A07/C07 is determined by the merchant’s POS location. International will only block “in-store” foreign transactions. To block ALL international transactions, enable C07 and C04 with merchant type ecommerce.
CardAlrtModFAQ-MyRegions
The App allows you to set control settings for region transactions. When the “My Region” control is set, in-store transactions made outside the specified region(s) will be alerted/denied. The intent for My Regions is for the app to incorporate a SDK for a mapping solution such as Google Maps. Each region is a circular area with a minimum radius of five miles. The App determines the user’s location by assuming that the user will always carry the phone.
The following behavior is specific to alerts/controls related to region:
- CardAlrtRegionRadius minimum is 0.1 and must have at least one decimal digit. Max is 99.99999.
- CardAlrtRegionId is unique to PSCU and the policy. CardAlrtRegionUsrDesc is not unique on any level.
- If the request contains zero for CardAlrtRegionId and a value for CardAlrtRegionUsrDesc - region is added to the policy and OnDot assigns an id.
- If adding a new region the CardAlrtRegionId must be a zero or an unused 5 digit number.
- If the subscriber has a region alert or control with several regions
associated with it, and the user wants to remove one of those regions,
set the CardAlrtRegionId [JHANull = true] and enter the
CardAlrtRegionId.
- If Dlt = true and AlrtActType = InAct, then the region is removed, and the entire control/alert is disabled for the remaining regions.
- If Dlt = false and AlrtActType = Act, then the region is removed, but the control/alert remains active for the remaining regions.
- If the request contains CardAlrtRegionId that was assigned previously
with a different value for CardAlrtRegionUsrDesc -
- If CardAlrtRegionId [JHANull = false] -
- If the id was previously used in the policy and it still exists in the policy, the information will be updated.
- If the id was used in another policy, the request will fail.
- If CardAlrtRegionId [JHANull = true] -
- If the id was previously used in the policy and it still exists in the policy, the information will be deleted.
- If the id was used in another policy, the request will fail.
- If the request contains CardAlrtRegionId [JHANull = true] -
- but no value for CardAlrtRegionId - the request will fail because both CardAlrtRegionId and CardAlrtRegionUsrDesc are required.
- but no value for CardAlrtRegionUsrDesc - the request will fail because both CardAlrtRegionId and CardAlrtRegionUsrDesc are required.
- If the request contains CardAlrtRegionId [JHANull = true] and the request contains mismatched values for CardAlrtRegionId and CardAlrtRegionUsrDesc - the id is used to delete the region; so, if it exists, it will be deleted and if it does not exist, the request will fail.
- If attempting to add a new region but request contains an existing
CardAlrtRegionId or CardAlrtRegionUsrDesc
- If CardAlrtRegionId [JHANull = false] - the region will be updated if it exists in the policy; otherwise the request will fail.
- If CardAlrtRegionId [JHANull = true] - the region will be deleted if it exists in the policy; otherwise the request will fail.
- There are no limitations to the number of regions that may be added to a subscriber/card combination.
- If CardAlrtRegionId [JHANull = false] -
Q: When adding a region, the response description has java.lang.Exception: REGIONNAME field cannot be blank or null. What element is REGIONNAME?
A: CardAlrtRegionId is the element. If you don't have a desired 5-digit number, just put zero and OnDot will assign a number.
Q: When adding a region, the response description has java.lang.Exception: REGIONS field cannot be blank or null. What element is REGIONS?
A: CardAlrtRegionUsrDesc is the element. Please enter the name of the city or area (i.e. local QuickTrip).
Q: In the regions alert/control specification, is the data type for the CardAlrtRegionUsrDesc field limited only to alpha characters?
A: Yes, numbers are not allowed and the field length is eleven.
Active/InActive
Q: CardAlrtCode has C01 as Card Off. How do you turn it on?
A: When C01 has
<AlrtActType>Act</AlrtActType>
the card is OFF.
When C01 has <AlrtActType>InAct</AlrtActType>
and
<Dlt>true</Dlt>
the card is ON.
Q: Is the delete element
<Dlt>
required?
A: It is when <AlrtActType>
is set to
InAct. <Dlt>
needs to be true.
Q: How do I set more than one
<CardAlrtThldCode>
since there isn't an array?
A: You need to separate them by a comma and include all of them that you want active.
<CardAlrtCode>A03</CardAlrtCode>
<AlrtActType>Act</AlrtActType>
<CardAlrtUsrDesc/>
<CardAlrtThldCode>A03T00,A03T01,A03T04,A03T07</CardAlrtThldCode>
<ActIntentKey>199602</ActIntentKey>
<Dlt/>
In this example A03T00, A03T01, A03T04, and A03T07 would be active. A03T02 and A03T05 would be inactive, even if they were active before.
Q: Say I have A03T00,A03T01, and A03T04 active. How do I inactive A03T00?
A: If you have more than one active like this case and only want to inactive one of them you must send an Activate(Act) instead of an InAct. Seems strange, but an InAct inactivates all A03 in this case.
Correct
<CardAlrtCode>A03</CardAlrtCode>
<AlrtActType>Act</AlrtActType>
<CardAlrtUsrDesc/>
<CardAlrtThldCode>A03T01,A03T04</CardAlrtThldCode>
<ActIntentKey>210830</ActIntentKey>
<Dlt/>
Wrong
<CardAlrtCode>A03</CardAlrtCode>
<AlrtActType>InAct</AlrtActType>
<CardAlrtUsrDesc/>
<CardAlrtThldCode>A03T00</CardAlrtThldCode>
<ActIntentKey>210830</ActIntentKey>
<Dlt>true</Dlt>
Q: Somehow I got My Regions as InAct and tried to get it Act with one of my regions and it will not activate it. How do I do it?
A: Set the CardAlrtRegionId element to zero and it will create a new region and My Regions will be Active again with a different RegionId.