Card Activate
API: Ws_Activate
This web service sets the status of the card to active to enable Mastercard or Visa network transactions. It is used to activate cards issued in an inactive state.
When converting from a virtual to a physical card, further activation is required on the physical card to ensure the converted details are updated on the Thredd host.
Record Description
Tag |
Type |
Minimum Length |
Maximum Length |
Description |
Request |
Response |
---|---|---|---|---|---|---|
<WSID> |
N |
1 |
19 |
Web service ID. Must be unique for every web service request sent. For details, see the FAQs.Tip: You could use a number based on the current date and time, as long as it is unique (e.g., 20201217145006). |
Mandatory |
Mandatory |
<IssCode> |
AN |
1 |
4 |
Thredd Issuer (Program Manager) Code. Assigned by Thredd. |
Mandatory |
Mandatory |
<TxnCode> |
AN |
1 |
2 |
The Transaction Code. See Transaction Codes. Default value is 10. |
Mandatory |
Mandatory |
<ClientCode> |
AN |
1 |
64 |
User ID of the customer using the service. Only applicable to systems using member logins. Returned in the response if present in the request. Note: Legacy field. Not used. |
Optional |
Conditional |
<Title> |
AN |
1 |
4 |
Cardholder’s title. Also used as the card purchaser's title if no delivery address is supplied. |
Optional |
Omit |
<LastName> |
AN |
1 |
20 |
Cardholder's last name. If no delivery address is supplied, this is the card purchaser’s last name. |
Optional |
Omit |
<FirstName> |
AN |
1 |
20 |
Cardholder's first name. Also used as the card purchaser's first name if no delivery address is supplied. Mandatory if |
Conditional |
Omit |
<Addrl1> |
AN |
1 |
50 |
Cardholder's address line 1. Also used as the card purchaser's address line 1 if no delivery address is supplied. Mandatory if ‘Address’ fields are specified. |
Conditional |
Omit |
<Addrl2> |
AN |
1 |
50 |
Cardholder's address line 2. Also used as the card purchaser's address line 2 if no delivery address is supplied. |
Optional |
Omit |
<City> |
AN |
1 |
50 |
Cardholder's home city. Also used as the card purchaser's city if no delivery address is supplied. Mandatory if |
Conditional |
Omit |
<PostCode> |
AN |
1 |
10 |
Cardholder's home postcode. Also used as the card purchaser's postcode if no postcode is supplied. Mandatory if |
Conditional |
Omit |
<Country> |
AN |
1 |
3 |
Cardholder’s country of residence. This is represented as a 3 digit ISO country code (e.g. 826 for UK). Mandatory if |
Conditional |
Omit |
<ActMethod> |
AN |
1 |
1 |
Method used for card activation. See Activation Methods. |
Mandatory |
Omit |
<PAN> |
AN |
14 |
19 |
Card Number. Unique card identifier. Mandatory in request if |
Conditional |
Omit |
<Track2> |
AN |
1 |
40 |
The card’s Track 2. Mandatory in request if |
Conditional |
Omit |
<PublicToken> |
AN |
1 |
9 |
The card’s public token. Mandatory in request if |
Conditional |
Mandatory |
<DOB> |
YYYY-MM-DD |
10 |
10 |
The cardholder's date of birth. |
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 |
<ExpDate> |
YYYY-MM-DD |
10 |
10 |
Expiry date. You can use this field to update the internal card record expiry date if you want to specify a shorter expiry date than the card expiry date that was set when the card was issued. This will not change the expiry date that was set when the card was issued (which is shown on the printed card or card image). If not specified, then the expiry date that was set when the card was issued will be used. Note: You cannot specify an expiry date that is later than the card issue expiry date. |
Optional |
Omit |
<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 |
<Reason> |
AN |
1 |
60 |
Reason for the card's status change. Overrides default of ‘Card Activated’ that is shown in the card processor. Text is shown in the Smart Client Tracker screen. On Thredd Portal, this information is captured in the Notes column in Transaction Search results. |
Optional |
Omit |
<ItemSrc> |
N |
1 |
2 |
Source field to define alternate fees. Legacy field for information purposes only; see Item Source Types. Suggest using 0. |
Mandatory |
Omit |
<SMSBalance> |
N |
1 |
1 |
Whether to send an SMS regarding the details of transaction amount and available balance to the customer after each card use. 0 or False = Do not send; 1 or True = Send; 2 = Do not change current value. |
Mandatory |
Omit |
<IsLive> |
N |
1 |
1 |
Specifies whether the card is active or not. 1 or True = Active; 0 or False = Not Active. |
Omit |
Mandatory |
<SysDate> |
YYYY-MM-DD |
10 |
10 |
The system processing date. |
Omit |
Mandatory |
<ActionCode> |
AN |
3 |
3 |
The action code for the response. See Action Codes. |
Omit |
Mandatory |
<WebServiceResult> |
AN |
|
|
Parameter group describing the result of the Web Service call. Only has values if the current request returns an action code of 868 Duplicate WSID. See WebServiceResult. |
Omit |
Mandatory |
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_Activate>
<hyp:WSID>2021123456789</hyp:WSID>
<hyp:IssCode>PMT</hyp:IssCode>
<hyp:TxnCode>0</hyp:TxnCode>
<hyp:ClientCode></hyp:ClientCode>
<hyp:Title>Mr</hyp:Title>
<hyp:LastName>Lastname</hyp:LastName>
<hyp:FirstName>Firstname</hyp:FirstName>
<hyp:Addrl1>Office 13, Telfords Yard </hyp:Addrl1>
<hyp:Addrl2>6-8 The Highway, Wapping</hyp:Addrl2>
<hyp:City>London</hyp:City>
<hyp:PostCode>E1W 2BS</hyp:PostCode>
<hyp:Country>826</hyp:Country>
<hyp:ActMethod>6</hyp:ActMethod>
<hyp:PAN></hyp:PAN>
<hyp:Track2></hyp:Track2>
<hyp:PublicToken>123456789</hyp:PublicToken>
<hyp:DOB></hyp:DOB>
<hyp:CVV></hyp:CVV>
<hyp:AccCode></hyp:AccCode>
<hyp:ExpDate></hyp:ExpDate>
<hyp:LocDate>2021-01-01</hyp:LocDate>
<hyp:LocTime>120000</hyp:LocTime>
<hyp:Reason></hyp:Reason>
<hyp:ItemSrc>2</hyp:ItemSrc>
<hyp:SMSBalance>0</hyp:SMSBalance>
</hyp:Ws_Activate>
</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_ActivateResponse xmlns="http://www.globalprocessing.ae/HyperionWeb">
<Ws_ActivateResult>
<WSID>2021123456789</WSID>
<IssCode>PMT</IssCode>
<TxnCode>0</TxnCode>
<PublicToken>123456789</PublicToken>
<LocDate>2021-01-01</LocDate>
<LocTime>120000</LocTime>
<ClientCode/>
<SysDate>2013-01-01</SysDate>
<ActionCode>000</ActionCode>
<IsLive>true</IsLive>
<WebServiceResult/>
</Ws_ActivateResult>
</Ws_ActivateResponse>
</soap:Body>