Cardholder Send Message
API: Ws_SendMessage
This web service enables you to send a pre-defined message to the cardholder via SMS or Email. Thredd can configure the message using a selection of variables.
If the SMS or Email option is selected and a bespoke message has not been configured, the default Thredd message is sent. Character limitation is in line with standard SMS message capacity.
Record Description
Tag |
Type |
Minimum Length |
Maximum Length |
Description |
Request |
Response |
---|---|---|---|---|---|---|
<WSID> |
N |
1 |
19 |
Web service ID. Must be unique for every request. For details, see the FAQs. |
Mandatory |
Mandatory |
<IssCode> |
AN |
1 |
4 |
Thredd Issuer (Program Manager) Code. Assigned by Thredd. |
Mandatory |
Mandatory |
<AuthType> |
AN |
1 |
1 |
Parameter to specify how the card is authenticated. See Authentication Methods. |
Mandatory |
Omit |
<PAN> |
AN |
14 |
19 |
Card Number. Required in request if |
Conditional |
Omit |
<PublicToken> |
AN |
1 |
9 |
The card’s public token. Mandatory in request if |
Conditional |
Mandatory |
<LocDate> |
YYYY-MM-DD |
10 |
10 |
The local current date in year-month-date format. |
Mandatory |
Mandatory |
<LocTime> |
HHMMSS |
6 |
6 |
The local current time, in hour-minute-second format. |
Mandatory |
Mandatory |
<DOB> |
YYYY-MM-DD |
10 |
10 |
Date of Birth. Mandatory if value of |
Conditional |
Omit |
<CVV> |
AN |
3 |
3 |
Card Verification Value |
Conditional |
Omit |
<AccCode> |
AN |
0 |
6 |
Access code or passcode for setting a code which is validated during activation (e.g. via the Thredd IVR system |
Conditional |
Omit |
<LastName> |
AN |
1 |
20 |
Cardholder’s last name. |
Optional |
Omit |
<EventId> |
N |
1 |
4 |
ID of the event. See Event ID below. Thredd generates and sends the appropriate SMS or Email message. |
Mandatory |
Omit |
<MailOrSMS> |
N |
1 |
1 |
The cardholder's preferred contact method. 0 = SMS; 1 = email. 2 = SMS and email. Default value is ‘0’. |
Mandatory |
Omit |
<SysDate> |
YYYYY-MM-DD |
10 |
10 |
The system processing date. |
Omit |
Mandatory |
<ActionCode> |
AN |
3 |
3 |
The action code for the response. Relevant codes are: 604 = Invalid event ID 787 = Email address is missing 788 = Invalid mail or SMS |
Omit |
Mandatory |
Event ID
ID |
Description |
ID |
Description |
---|---|---|---|
1 |
Activation |
12 |
Balance Adjustment |
2 |
Balance Enquiry |
13 |
Balance Transfer |
3 |
Card Creation |
14 |
Change Groups |
4 |
Card Renewal |
15 |
Extent Expiry |
5 |
Card Replacement |
16 |
Unload |
6 |
Load |
17 |
Unload and Status Change |
7 |
PIN Retrieval |
18 |
Update Cardholder |
8 |
Status Change |
19 |
Send Mobile Activation code to Cardholder |
9 |
Card Image Regeneration |
20 |
Notification of Tokenisation |
10 |
Card Conversion |
21 |
CVC2 Unblock |
11 |
Activation and Load |
|
|
Request
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:hyp="http://www.globalprocessing.ae/HyperionWeb">
<soapenv:Header>
<hyp:AuthSoapHeader>
<hyp:strUserName>*****</hyp:strUserName>
<hyp:strPassword>*****</hyp:strPassword>
</hyp:AuthSoapHeader>
</soapenv:Header>
<soapenv:Body>
<hyp:Ws_SendMessage>
<hyp:WSID>5122404400194940928</hyp:WSID>
<hyp:IssCode>PMT</hyp:IssCode>
<hyp:AuthType>1</hyp:AuthType>
<hyp:PAN></hyp:PAN>
<hyp:PublicToken>123456789</hyp:PublicToken>
<hyp:LocDate>2015-07-20</hyp:LocDate>
<hyp:LocTime>101010</hyp:LocTime>
<hyp:DOB>1982-01-01</hyp:DOB>
<hyp:CVV>223</hyp:CVV>
<hyp:AccCode/>
<hyp:LastName>Abraham</hyp:LastName>
<hyp:EventId>1</hyp:EventId>
<hyp:MailOrSMS>1</hyp:MailOrSMS>
</hyp:Ws_SendMessage>
</soapenv:Body>
</soapenv:Envelope>
Response
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<soap:Body>
<Ws_SendMessageResponse xmlns="http://www.globalprocessing.ae/HyperionWeb">
<Ws_SendMessageResult>
<WSID>5122404400194940928</WSID>
<IssCode>PMT</IssCode>
<PublicToken>101967192</PublicToken>
<LocDate>2015-07-20</LocDate>
<LocTime>101010</LocTime>
<SysDate>2015-07-22</SysDate>
<ActionCode>000</ActionCode>
</Ws_SendMessageResult>
</Ws_SendMessageResponse>
</soap:Body>
</soap:Envelope>