Document History
Refer to the table for details of changes to this guide.
Prior to version 3.0, this guide was provided only in PDF format. If you want to access historical versions of the guide, please contact your Implementation Manager.
Version |
Date |
Description |
Revised by |
---|---|---|---|
3.21 |
21/07/2025 |
Added a new |
WS |
3.21
|
21/07/2025 |
The status code 41 (Lost) has been changed to irreversible, to comply with a recent Card Scheme mandate. See PRN-240. |
WS |
21/07/2025 |
Added details to the Use Case Scenarios section on Updating a Card Status to Lost, Stolen or Destroyed. |
WS |
|
11/07/2025 |
Changed the maximum length of the |
WS |
|
10/07/2025 |
Replaced the |
KD |
|
27/06/2025 |
Removed the Payment Token Create ( |
JB |
|
13/06/2025 |
Added the |
KD |
|
29/05/2025 |
Web Services exclude card status change entries prior to 2022. Card status changes before this year are no longer retrievable. See descriptions of applicable endpoints: Card Statement (v2) and Card Statement (v1). |
KD |
|
23/05/2025 |
Revised the description of the response parameter |
WS |
|
07/05/2025 |
Removed card status code 57 from the Card Status Codes page. |
WS |
|
09/04/2025 |
Added a new currency code XCG/532 for Caribbean Guilder (this replaces ANG/532 the Netherlands Antillean guilder). See Currency Codes. |
WS |
|
27/03/2025 |
Added references to Secure Connectivity Framework. |
KD |
|
20/03/2025 |
The maximum length of the |
WS |
|
20/03/2025 |
The maximum length of the response parameter |
WS |
|
13/03/2025 |
Added a new appendix, describing the WebServiceResult Field, which is returned in the response to some web services when the request includes the same WSID as a previously submitted request. |
WS |
|
13/03/2025 |
Corrected |
JB |
|
13/02/2025 |
Added references to Thredd Portal, our new online portal for managing your cards and transactions. |
KD |
|
11/02/2025 |
Added notes to clarify the effect of passing an empty space as a value in specific fields in the 3D Secure Configuration (Apata) ( |
WS |
|
03/02/2025 |
Added a new web service, 3D Secure Get Card Level Configuration (Apata) ( |
WS |
|
3.20
|
10/12/2024 |
New This field is optional, and specifies the Out of Band URL to be used during a 3D Secure authentication session. See PRN-201. |
WS |
04/12/2024 |
In the Update Cardholder Details (V2)( |
WS |
|
20/11/2024 |
Added the |
KD |
|
07/11/204 |
New FAQ added to answer common questions around Virtual to Physical Card conversion. See the FAQs. |
WS |
|
29/10/2024 |
Updated |
JB |
|
23/10/2024 |
Added a new field, |
WS |
|
24/09/2024 |
Removed |
KD |
|
04/09/2024 |
Updated the list of support card manufacturers on the Card Manufacturers page. |
JB |
|
13/08/2024 |
Updated the description of |
WS |
|
29/07/2024 |
Added some FAQs on the use of the |
WS |
|
10/07/2024 |
Corrected the definition for |
JB |
|
10/07/2024 |
Changed the minimum value of |
PC |
|
02/07/2024 |
Updated the company address. |
PC |
|
3.19 |
13/06/2024 |
Removed references to the Forwarding a PIN request to an External API option, which is no longer supported. |
WS |
07/06/2024 |
Updated the definition for |
|
|
17/05/2024 |
Added a list of available web services to the online guide table of contents. See List of Web Services API. |
WS |
|
30/04/2024 |
Updates to list of Card Manufacturers. |
WS |
|
24/04/2024 |
Updates to content and graphics to align with taxonomy updates on our Documentation Portal. |
WS |
|
27/03/2024 |
Clarification on use of action code 104. Updates to content and graphics to align with taxonomy updates on our Documentation Portal. |
WS |
|
07/03/2024 |
In the Card Renew ( |
WS |
|
07/03/2024 |
In the Card Send Files ( |
WS |
|
21/02/2024 |
Added a new web service, 3D Secure Configuration (Apata) ( |
WS |
|
14/02/2024 |
Removed references to the legacy web service |
WS |
|
12/02/2024 |
When creating a card, clarified that CreateType option 3 works the same as option 1. See Card Create ( |
WS |
|
31/01/2024 |
Added the WebServiceResult parameter to the following web services: Card Balance Transfer ( |
WS |
|
30/01/2024 |
Added full list of statuses to Status Codes. |
JB |
|
23/01/2024 |
Added action code 575. Updated the description for action code 119. |
KD |
|
08/01/2024 |
Removed the |
WS |
|
02/01/2024 |
Updated the description of action code 439. |
WS |
|
3.18 |
20/12/2023 |
Updated the list of card Status Codes that can be used when setting the status of a card using the Card Change Status ( |
WS |
15/12/2023 |
Updated the description of action code 952. |
WS |
|
15/12/2023 |
Added a reference to the Fees Guide, which provides further guidance on applying card fees using web services. |
WS |
|
18/10/2023 |
Removed references to the following web services, which were deprecated 30/07/2021: |
WS |
|
17/10/2023 |
Two optional boolean fields, |
WS |
|
21/09/2023 |
Removed the |
WS |
|
11/09/2023 |
Correction: In the Card Create web service section, updated the table of fields to include the |
WS |
|
3.17 |
08/08/2023 |
Added a note to clarify that the Token Device Management web service (Ws_Token_Device_Management) is for use on the Visa (VDEP) service only. Correction: In the Create Payment Token ( |
WS |
26/07/2023 |
Updated the PIN field usage table defining how a card's PIN can be updated. See Card PIN Control. |
WS |
|
10/07/2023 |
Maximum length of the |
WS |
|
03/07/2023 |
When creating a card, you can now use additional characters in the CardName field if the card manufacturer is Thredd (internal card manufacturer account used for non-printed cards, such as virtual cards). See Card Manufacturer Approved Characters. |
WS |
|
26/06/2023 |
Added details of which card status values can be used to Suspend, Delete and Deactivate a payment token at the Card Scheme (payment network). See Payment Token Status Change. For bulk card create ( |
WS |
|
07/06/2023 |
Updated Operations email address to be occ@thredd.com |
MW |
|
23/05/2023 |
When using the Create Card web service (Ws_CreateCard), if |
WS |
|
09/05/2023 |
Duplicate Gemalto Singapore entry removed from the Card Manufacturer Approved Characters table in the String Cleaning and Approved Characters page. |
JB |
|
27/04/2023 |
Guide rebrand to new company name and brand identity. |
WS |
|
3.16 |
11/04/2023 |
The |
WS |
03/04/2023 |
Update to description of action code 816. In the Card Bulk Create web service (Ws_BulkCreation), the field name ActivateNow in the CARD element has been corrected to ActivateOrNot. |
WS |
|
3.15 |
28/02/2023
21/02/2023 |
Added Chinese Offshore Renminbi (currency code CNH) to the list of supported currencies. See Currency Codes. Clarification: when using the Apply FX Rate web service (Ws_Client_FX) to stream your own FX rates; if you are not using the optional SellRate and MidRate fields, then you should pass a value of '0' in these fields, Correction: the Correction to the list of special characters supported by the Gemalto Czech Republic Card Manufacturer. See String Cleaning and Approved Characters. Clarification to description of the Payment_Token_ID field in Payment Token Get (Ws_Payment_Token_Get) web service. Applies to both Mastercard and Visa cards. Added a note to the Card Extend Expiry Date (Ws_ExtendExpiry) web service to indicate that changing the expiry date will also change the card status to '00' (All Good). |
WS |
08/02/2023 |
Correction to clearing field values when using the Update Cardholder Details (V1) and Update Cardholder Details (V2) web services: the |
WS |
|
06/02/2023 |
Update to description of action code 213. |
WS |
|
25/01/2023 |
Update to description of action code 122. Added information to clarify the use of CreateType = 5 when using the Card Create (Ws_CreateCard) web service. |
WS |
|
13/01/2023 |
Added a note the Card Renew web service to indicate that when the new card is activated, Thredd will change the status of the old card to 62 restricted card. |
WS |
|
12/12/2022 |
Guide updated to reflect that the OUTOFBAND authentication type is now available. See 3D Secure RDX Credentials (Cardinal). Note: Please discuss with your Implementation Manager before implementing this method. |
WS |
|
06/12/2022 |
Added the WebServiceResult parameter to the following web services: Card Renew (Ws_Renew_Card), Regenerate Wallet (Ws_RegenerateWallet), Clear Accumulator (Ws_ResetAccumulator), Change Card Acceptor List (Ws_Card_Change_Cardacceptor_List), Card Balance Update (Ws_BalanceUpdate) and Payment Token Status Change (Ws_Payment_Token_StatusChange), If the web service request is a duplicate of an existing request (has the same WSID) then the result will return an action code of 868, together with details of the original request, which will be displayed in the WebServiceResult parameter. Otherwise this new field will be blank. See PRN-135. |
WS |
|
01/12/2022 |
Updated the Copyright Statement. |
MW |
|
3.14
|
21/11/2022 |
Update to description of action code 779. |
WS |
07/11/2022 |
Correction to card name permitted characters: Only forward slash characters (“/”) are allowed; any backslashes (“\”) will be replaced with forward slashes. |
WS |
|
28/10/2022 |
Updated the code examples in the 3D Secure RDX Credentials (Ws_AddUpDelCredentials) web service to show the correct format of the KBA fields. |
WS |
|
20/10/2022 |
Removed the ability to change the card status to expired using status code 54; attempting to do so will return a new action code of 447. Card expiry status is always set by the system, based on the card's expiry date. See PRN-134. |
WS |
|
12/10/2022 |
Added additional accumulator types related to Strong Customer Authentication (SCA). See the Clear Accumulator web service. Updated the list of special characters that are removed from input fields. See String Cleaning and Approved Characters. See PRN-106. Added a new CarrierType parameter to the Card Renew and Card Convert web services. See PRN-130. Added a note to the ProductRef field in the Update Cardholder Details (V2) web service to indicate that this field can also be used during mobile wallet tokenisation, to specify which card profile the Card Scheme (payment network) should use. |
WS |
|
3.13 |
16/09/2022 |
Added a new action code of 221, which is returned in a Token Device Management request when the Visa device index is missing from a request to unbind the device. |
WS |
08/09/2022 |
Added a new Currency Code, SLE, for the new Sierra Leonean leone. |
WS |
|
18/08/2022 |
Added a new section to Use Case Scenarios for Renewing Expiring Cards and Replacing a Lost or Stolen Card. In Card Renew (Ws_Renew_Card), option 16 has been removed from the list of <RenewOptions>. |
WS |
|
10/08/2022 |
Added the WebServiceResult field to wsBalanceAdjustment, wsLoad, wsUnLoad, wsUnloadStatusChange, wsStatusChange and wsActivate web services. Added a new action code of 445, which is returned in a Payment Token Create request when the payment token count exceeds the allowed limit. Added a new <Url> parameter which enables you to include URL details in the <QRCode> field of the card generation file sent to the card manufacturer. This affects the following web services: Card Create (Ws_CreateCard), Create Card with Agency Banking (Ws_CreateCard_V2), Card Renew (Ws_Renew_Card), Update Cardholders Details (Ws_Update_Cardholder_Details and Ws_Update_Cardholder_Details_V2), Card Bulk Create (Ws_BulkCreation), Wallet Create (Ws_CreateWallet) and Wallet Bulk Create (Ws_BulkWalletCreation). See PRN-123. |
WS |
|
19/07/2022 |
Added two new web services: Ws_Banking_DD_CancelMandate and Ws_Banking_DD_GetMandate. |
JB |
|
3.12 |
19/05/2022 06/06/2022 27/06/2022 14/07/2022 |
In the Card Renew web service (Ws_Renew_Card) added a note to explain that the new card will be auto-enrolled with the same 3D Secure credentials as the old card. New Remove Cardholder Data (Ws_Remove_CardHolder_Data) web service added. This web service enables you to remove cardholder personal information from a card, such as name, address, email and phone number. See PRN-115. New <Activate> parameter added to the Payment Token Status Change (Ws_Payment_Token_StatusChange) web service, which can be used to indicate whether to activate the payment token on the MDES system (Mastercard only). See PRN-116. Updated description of action codes 118 and 441. Added log values for the Action field in the 3D Secure RDX Credentials (Cardinal) web service (Ws_AddUpDelCredentials). |
WS |
3.0.11 |
08/03/2022 15/03/2022 14/04/2022 |
Added a new 3D Secure credential for OUTOFBAND. See 3D Secure RDX Credentials (Cardinal). Note: OUTOFBAND is not yet available to use. Please check with your 3D Secure Implementation Manager for details. The Create Card web service (Ws_CreateCard) now includes a new tag called Ws_WebServiceResult, which is returned in the response; if this is a duplicate create card request then this tag is populated with data about the original Create Card request. See PRN-80. In the Register a Customer for Banking Actions web service (Ws_Banking_RegisterNotification), the <type> field now includes DD_INCOMING_DEBIT. Updated the description of the maximum length for BuyRate, SellRate and MidRate in the Apply FX Rate (Ws_Client_FX) web service. In the Card Acceptor Allow List (Ws_CardAcceptorWhiteList) and Card Acceptor Deny List (Ws_CardAcceptorBlacklist) web services, the field CardAcceptor has been corrected to CardAcceptorModifier. You can use the Card Change Acceptor List (Ws_Card_Change_Cardacceptor_List) or Card Change Acceptor List (Bulk) (Ws_Change_Cardacceptor_List) web services to update the Card Acceptor Allow and Deny lists. Correction: the character limit for the field KBA_Answer and KBA_AnswerOldValue should be 45 characters. See 3D Secure RDX Credentials (Cardinal). Correction: the response example in the Check Service Availability (Ws_Check) web service has been updated to show the correct response fields. |
WS |
3.10 |
04/01/2022 02/02/2022 14/02/2022 23/02/2022 |
Added a new 3D Secure credential for Knowledge Based Authentication (KBA). See 3D Secure RDX Credentials (Cardinal). See PRN-87 and PRN-88. When updating the 3D Secure credential using Ws_AddUpDelCredential, you can only change the credential value and not the type. See 3D Secure RDX Credentials (Cardinal). Added and updated action codes 594-599 and 601-613. See Action Codes. Added a note to not use Status Code 41 if temporarily blocking a tokenised digital PAN (DPAN). Updates to the description of the Payment Token Create web service. New Note field added to the Card Load (Ws_Load), Card Unload (Ws_Unload) and Card Unload and Change Status (Ws_UnLoad_StatusChange) web services. This note will appear in the transaction's Note field in Smart Client. See PRN-43. Added a note to Extend Expiry Date (Ws_ExtendExpiry) web service to explain that you can't extend the expiry date of a card which is in an irreversible status. Clarified which Status Codes are irreversible. See PRN-96.Added new Action Code 120, which is returned when the card or account amount system limits are exceeded. |
WS |
3.09 |
20/10/2021 08/11/2021 18/11/2021 01/12/2021 14/12/2021 29/12/2021 |
The web service responses for fields containing balance amounts have been updated to return the number of decimal places based on the ISO 4217 currency exponent for the currency; see Currency Codes. (Note: previously two decimal places were returned). See PRN-67. Updates to table of Appendices. Updates to the WSDL URL. See Using the API. Updated wording to clarify that customers must be PCI DSS Compliant in order to return the full PAN, in web services which provide this option. In Card Convert to Physical (Ws_Convert_Card) the field <ConvertDate> in the request is optional. Update to <DataSrc> tag in Ws_Card_Statement; see Card Statement (V1). Update to note about card status codes on load in Ws_Load; see Card Load. Update to example of device latitude in Ws_Payment_Token_Create; see Payment Token Create. |
WS
AL WS |
3.08 |
24/08/2021 06/09/2021 13/09/2021 20/09/2021 29/09/2021 |
Updates to support SEPA payments when creating a card with Agency Banking features and when making external payments. New web service Ws_PaymentToken_Create for Creating a Payment Token for use by Program Managers who have a direct connection to the Visa (VDEP) or Mastercard (MDES) tokenisation service. New field <PBlock> added to the Wallet Create web service (Ws_CreateWallet). See PRN-58. New field <UsageGroup> added to the Payment Token Status Change web service (Ws_Payment_Token_StatusChange) to enable users to change the card usage group of the card linked to a payment token. See PRN-63. New actions codes 439,441,442 and 443 added to support the Ws_PaymentToken_Create web service for Creating a Payment Token. General updates to web services request and response examples throughout the guide. New value of 5 added to the <CreateType> field in the Card Create and Card Bulk Create web services, to enable creating a virtual card and converting to a physical card at the same time. New Action Code of 444 added. See PRN-66. Updates to Card Status Codes to reflect new card block status codes. See PRN-48. New Action Codes for SEPA payments (Modulr Agency Banking Service): 140, 584, 585, 588, 589, 583, 590, 593. |
WS |
3.07 |
22/06/2021 02/07/2021 26/07/2021 |
Decommission of Ws_SafeReports. See PRN-39. Updates to the WS_Enquiry web service response to include the number of online PIN tries remaining and the number of CVV2 tries remaining. See PRN-38. Updates to wording and examples for the Ws_AddUpDelCredentials web service; see 3D Secure RDX Credentials (Cardinal). Card Acceptor Allow lists and Deny lists wording updates. For a Multi-FX card, a card can be loaded in any of the card's currencies. Updates to the Ws_Renew_Card web service response to include the Expiry Date. See PRN-45. New action code 440 Archived card, deny is returned in response to a request to update an archived card. See PRN-52. |
WS |
3.06 |
12/05/2021 |
Updates to description of Processing of Phone Numbers. Updated description for <CreateImage> in Card Renew. Updates to <ForcePost> field values in Card Balance Adjustment (Ws_Balance_Adjustment). <Sms_Required> field now defaults to 0. Corrections to Status Codes. Update to indicate that when creating a virtual card, if you are PCI compliant it is possible to retrieve the PAN, Expiry and CVV. See Card Create. |
WS |
3.05 |
28/04/2021 |
Changed <PrimaryToken> minimum length to 9 characters in Ws_CreateCard. See Card Create. |
WS |
3.04 |
22/04/2021 |
Updated Card Renew (Card_Renew) to reflect you can now specify renew options to immediately update the balance on the card and update any linked payment tokens at the same time. Revised Cardholder Details Enquiry (Ws_CardHolder_Details_Enquiry) to include <CrdProduct> in the response. Updated description of <LoadFee> in Create Card with Agency Banking (Ws_CreateCard_V2). Thredd now supports the use of the symbol # in address line fields: <Addrl1>, <Addrl2>, <Addrl3>, <Delv_AddrL1>, <Delv_AddrL2>, <Delv_AddrL3> Whitelist and Blacklist now referred to as Allow list and Deny list. Added GET method to the Ws_AddUpDelCredentials web service plus other updates. See 3D Secure RDX Credentials (Cardinal) |
WS |
3.03 |
16 Mar 2021 |
Fixes to web service examples: Ws_Load, Ws_BulkCreation,Ws_Regenerate,Ws_BulkWalletCreation,Ws_CardAcceptorWhiteList,Ws_Get_Passcode,Ws_Get_Card_ExpireSoon,Ws_List_Pending_Fees,Ws_CreateCard_V2,Ws_Banking_Card_Statement_V2,Ws_Banking_CreateCustomer and WS_Token_Device_Management. New action code 599 added. |
WS |
3.02 |
23/03/2021 |
Revised Ws_CardHolder_Details_Enquiry to remove <CrdProduct> from the response. |
WS |
3.01 |
17/03/2021 |
Revised examples in Cardholder Details Enquiry (Ws_CardHolder_Details_Enquiry). |
WS |
3.0 |
05/03/2021 |
Major guide revision. Complete revamp of the guide: reorganisation of the guide, major content rewrite, creation of new Getting Started topics, generation of new online help format. New appendices. Ws_UpdateLastModifiedType service added back to guide. |
WS |
2.09 |
20 Nov 2020 |
Update to WS_AddUpDelCredentials to support new Get method. Update to Ws_ResetAccumulator. |
WS MD |
2.08 |
30 Sept 2020 |
End to end review - numerous textual updates Removal of retired web services: Ws_AddressMatchChecking, Ws_LicenseVerification, Ws_PassportVerification Ws_List_Sanctions_PEP, Ws_List_Sanctions_PEP_Matches, Ws_Update_Sanctions_PEP_Matches Ws_UpdateLastModifiedType Removal of superfluous Section 1. Corrected description of ExpDate parameter of Ws_CreateCard Added Function 08 of Ws_PINControl Added section on Timeout settings to top of Spec. Updated documentation of the <Phone> parameter of Ws_Insert3DSecureDetails and Ws_Update3DSecureDetails services |
GH/MC
IF |
2.07 |
28 Jul 2020
25 Aug 2020
27 Aug 2020 |
Updated description of <StartDate> and <EndDate> in Ws_Card_Statement service. Updated description for Ws_Card_Change_Groups Documented web service Ws_Update_Cardholder_Details_V2 Added new request parameters VirtualCardImage and ImageSize to Ws_CreateWallet Service Added new request parameter ImageSize to Ws_RegenerateWallet Service.
Corrected description of Ws_Query3DSecureDetails service. Corrected some typos in Action codes 878 - 880 Appendix A. Clarified valid date range for Ws_Card_Statement Corrected description for MemorableDate in Ws_Insert3DSecureDetails and Ws_Update3DSecureDetails |
VS
MJ
IF |
2.06 |
21 Jul 2020 |
Documented Action Codes 611 and 613 |
IF |
2.05 |
29 Jun 2020 |
Added new request parameter DelvMethod to Ws_Renew_Card. Added request and response details for Ws_Query3DSecureDetails Added Specification for Ws_AddUpDelCredentials Changes in Ws_WebServiceResult_V2 response Action codes 600 ,614 and 615 added Added new renew options values to Ws_Renew_Card. |
VS VS |
2.04 |
9 Jun 2020 |
Improved description of following services: Ws_Check, Ws_Simple_Check Added new request parameters VirtualCardImage and ImageSize to following services: Ws_Createcard, Ws_Renew_Card Added new request parameter ImageId to Ws_Convert_Card Service. |
IF |
2.03 |
10 Mar 2020 |
Added new request parameter PaymentTokenUsageGroup to following services: Ws_Createcard, Ws_CreateWallet, Ws_CreateCard_V2, Ws_Change_Groups Ws_Enquiry, Ws_Card_Change_Groups, Ws_List_Group, Ws_Customer_Enquiry_V2, Ws_Regenerate, Ws_RegenerateWallet, Ws_Renew_Card, Ws_BulkCreation, Ws_BulkWalletCreation Added action codes – 431 and 432. |
VS |
2.02 |
21 Feb 2020 |
Ensure PDF version of the document has bookmarks, by ensuring sections and subsections in part 2 are all the correct heading style. Corrected Ws_Sanctions_PEP_Check_V2 <Status> field (section 2.43.1) |
MD |
2.01 |
29 Jan 2020 |
Updated Ws_Insert3DSecureDetails memorable name and memorable place no longer used and response Action code to 000 Updated Ws_Update3DSecureDetails memorable name and memorable place no longer used and response Action code to 000 Updated Ws_Delete3DSecureDetails response Action code to 000 |
IF |
2.00 |
12 Dec 2019 |
Modified Maximum Length of <Fulfil1> and <Fulfil2> from 30 to 50. |
VS |
1.99 |
19 Nov 2019 |
Added new request Parameters DPAN, PaymentTokenID, ClearAllDPANs to Ws_ResetAccumulator call. |
MJ |
1.98 |
|
Added new request parameter ProductRef to Ws_Renew_Card call. Added action codes – 426 and 427. |
MJ |
1.97 |
|
Documented Ws_ResetAccumulator Update Ws_CreateCard_V2 documentation. Document the default behavior of SMS_Required and SMSBalance input parameters Added Action Codes 664,665,666, 667 and 425. |
MJ |
1.96 |
|
Updated Ws_Bulk_Creation documentation Documented card status types 02 & 75 Documented Ws_Check Remove section about linked files from Ws_CreateCard_V2 Additional parameter in Ws_CreateCard_V2 for customer ID New web service call of Ws_Banking_CreateCustomer New we service call Ws_Banking_RegisterNotification Added a new item <BankTransactionId> to Ws_Banking_TransferFunds response New action codes for Modulr |
MJ |
1.95 |
|
Added new request parameters BlackList and WhiteList to Create Card and Create Wallet web services. Added new response parameters BlackList and WhiteList to Enquiry web service Updated <StartDate> in Ws_Card_Statement Added action code - 418 |
MJ |
1.94 |
|
In Ws_3DS_AddUpDelDetails marked Details as mandatory Provided example web service cal to include AltPhone1 Updated Details to show which calls were phone numbers and that country codes must be provided Example of how to use OverrideThredd field |
SW |
1.93 |
15 Jan 2019 |
Update Ws_Banking_TransferFunds reference field to no longer allow certain characters Additional parameters in Ws_Banking_Transfer funds to handle peer to peer transactions Additional payment types in Appendix V to handle peer to peer payment types Documented Appendix MM Documented new web service Ws_Renew_Cards Clarified <Func> 6 in PIN Control web service Updated description of Ws_Enquiry. Updated description of WS_Passport_Verification Updated Response of Ws_Bulk_Creation Upadted <TxnCode> in WS_Activate_MVCLoad Updated Response of Ws_Load Added new action codes and updated some existing ones. Added new load sources Added note to Ws_CreateCard, under <ActivateNow> parameter. Added note to Ws_Payment_Token_Get, under <Device_Type> |
MJ |
1.92 |
9 Oct 2018 |
Documented web service Ws_Activate_MVCLoad Updated the max length of input parameters CurrentPIN, NewPIN and ConfirmPIN in Ws_PINControl and max length of Pblock in Ws_CreateCard Added new request parameter FeeWaiver to web services Ws_CreateCard, Ws_CreateWallet, Ws_Regenerate and Ws_RegenerateWallet. Clarified the description of the input parameter <NewStatCode> in the status change and unload & status change requests. Clarified the description of the input parameters <PostCode>, <Delv_PostCode> and <WorkPostCode> Clarified the decription of Sms_Content in Ws_Regenerate and Ws_RegenerateWallet. Documented FxGroup request parameter to ws_Card_Change_Groups and FXGroup, CurrentFXGroup request parameters to ws_change_groups. Updated description of CardDesign request parameter of ws_activate_load |
MJ IF |
1.91 |
11 Sep 2018 |
Updated version number Updated description of W2DetailsPassThroughDataRequest parameter of ws_VerificationRequest service. |
IF |
1.90 |
6 Sep 2018 |
Added note to Ws_CreateCard, under <ActivateNow> parameter. Added note to Ws_CreateCard description regarding replacement physical cards. |
HC |
1.9 |
25-04-2012 |
Full revise of web service. |
n/a |
1.89 |
5 Sep 2018 |
Mainly a review of language to simplify terms and introduce clarifications. Added note to Ws_Activate_Load for case when card is already loaded beforehand Ws_PINControl – documented the functions 05 and 06 Update Appendix C & F Clarified Renew, SvcSrc, SvcType and SvcStatus parameters of Update Cardholder Details service. |
MC
SB
IF |
1.88 |
|
Adding Appendix MM – A Note of cleaning of some strings Updating Ws_Customer_Enquiry FirstName and LastName to be 100 characters, and Name in Ws_List_Sanctions_PEP_Matches Fixing Last Name description in Ws_VerificationRequest Added new request parameter Description to MVCLoad and MVCUnload web services. |
SB |
1.87 |
30 May 2018 |
Small Spelling corrections Ws_BalanceUpdate enhanced to include Stand In & Available balance Update Appendix H to be up to date Adding RegenType = 2 to Ws_Regenerate and Ws_RegenerateWallet Fixing Ws_Regenerate to include PAN Added Action Codes 409-416 |
SB |
1.86 |
18 May 2018 |
Updated Ws_Payment_Token_Get no longer require PAN or Pubtoken if MDES card details are provided |
SB |
1.85 |
10 Apr 2018 |
Updated Ws_CreateCard & Ws_CreateWallet description. Spelling correction to Ws_CardAcceptorWhiteList Fixed <Description> to be 150 Chars and <DescriptionDelimiter> to be AN in Ws_Card_Statement Clarified TransactionType and StatusCode in Ws_Card_Statement Added Action Codes 400-405 |
SB |
1.84 |
27 Feb 2018 |
Documented web service Ws_MVCLoad Documented web service Ws_MVCUnload |
MJ |
1.83 |
15 Feb 2018 |
Ws_Sanctions_PEP_Check_v2: New optional parameter ProductID in request. Corrected spelling of checkLevel request parameter Ws_List_Sanctions_PEP_Matches – New optional parameter ProductID in request and response, existing MatchItems response parameter documented, response example updated. Added to descripton of Action Code 897 for decimal place errors. |
IF |
1.82 |
16 Jan 2018 |
Ws_PINControl – Function 7, “CVC2 Unblocking”, added. Action Codes 127, 406 added. Optional parameters WSID, IssCode added to Ws_Regenerate Decreased the amount fields precision for Ws_BalanceAdjustment |
SB |
1.81 |
27 Dec 2017 |
Action codes 934 – 950 updated for 3DS error handling Appendix T updated to reflect correct handling of direct debits as per Wirecard directions |
SW |
1.80 |
10 Nov 2017 |
Updating Ws_3DS_AddUpDelDetails so it is up to date. Adding Action Codes from Ws_3DS_AddUpDelDetails development. Added descriptions to all the Appendix HH fields Removing references to Ws_Banking_GetDirectDebitInstructionsBankingEnabledCard as a tiered call. It is currently only functional at a Token level. (Sections 1.69 and 2.69) Removing references to Ws_Banking_GetPendingDirectDebits as a tiered call. It is currently only functional at a Token level. (Sections 1.68 and 2.68) Change to include Creator_Token_Ref in the response for WS_Payment_Token_Get Change to WSDL examples in WS_Payment_Token_Get And Ws_Payment_Token_StatusChange to make them clearer |
SB |
1.8 |
11-04-2012 |
Add a new input field in the Convert Card web service to pass expiry of the card. |
n/a |
1.79 |
7 Nov 2017 |
Fixed CrdDesign to be 50 Chars in Ws_CardHolder_Details_Enquiry |
SB |
1.78 |
28 Sep 2017 |
Clarified the description of the output parameters (<TxnDate>, <PostDate>, <Locdate> and <TxnTime>) in the card statement response. |
|
1.77 |
26 Sep 2017 |
Added action codes 548 (Cannot close account with balance) and 953 (updating MDES Card Mapping failed) Updated IsoLang and Lang fields to include a reference to the SMS templates that can be set up Added a section about the new Fair Usage Policy for web services. Clarified the description of the four web services ws_Insert3DsecureDetails, ws_Update3DsecureDetails, ws_Delete3DsecureDetails and ws_Query3DsecureDetails to make it clear that they are for customers using the Cardinal interface only. |
SB IF |
1.76 |
27 Jun 2017 |
Updated descriptionof Passcode (Acccode) to 6 digits in many web services. Updated description of LoadSrc in Balance Transfer web service. Updated <CreatedFrom> description to add “YYYY-MM-DD Format” for Ws_Banking_GetDirectDebitInstructionsBankingEnabledCard Added action code 546 – No direct debit found from ME_ActionCodeDetails Updated descriptions for <ExternalAuth> and <Mobile> fields in Ws_CreateCard Added action code 547 – Issue connecting to Bottomline V Series from ME_ActionCodeDetails Added action codes 662 (LockMode invalid or missing) and 663 (Invalid DOB) |
IF |
1.75 |
23 May 2017 |
Documented Sms_required parameter of Status Change. Updated descriptions and Response/Request for Ws_SafeReports Updated description of AmtUnload and AmtTxn in Unload/Unload Status Change and Balance Transfer respectively. Also LoadedBy changed to Opt in Unload Status Change. Changes done to match WSDL behavior. Added new Action Code: 660 |
IF |
1.74 |
21 Apr 2017 |
Added Ws_BalanceUpdate Added Ws_Payment_Token_Get and Ws_Payment_Token_StatusChange Added Appendix LL Payment Token Table Added Action codes for the above calls Added Ws_Query3DsecureDetails Response and Request – Amal Added Action codes so that 901-949 can match up better with ISO 8583:2003 Removed Ws_Card_Phone_Activation as it is not in the WSDL and is a duplicate of Ws_Phone_Activation Made <memoScope>, <dvlDaysValid>, <fundCrdIssNum>, and <FundCrdCVC> mandatory in Ws_Update_Cardholder_Details Changed Ws_Card_Statement_V2 to Ws_Banking_Card_Statement_V2 to match up with the WSDL |
SB |
1.73 |
7 Feb 2017 |
Increased CustAccount length from 16 to 25 throughout. Clarified the use of quantity parameter of Create Card. Various minor descriptive enhancements. Claried use of ItemSrc parameter |
IF |
1.72 |
6-Dec-2016 |
Added in Ws_Card_Statement_V2 Added in Ws_3DS_AddUpDelDetails Added in details for ws_RegenerateWallet as provided in CS_TUXEDO-177 at request of S Kelly |
SW |
1.71 |
15-Sep-2016 |
Clarified crdProduct parameter of Update Cardholder Details service. Changed length of designRef parameter to 50 on Update Cardholder Details service. |
|
1.70 |
9-Sep-2016 |
Various minor corrections |
|
1.7 |
26-03-2012 |
Full revise of web service. |
n/a |
1.69 |
9-Aug-2016 |
Corrected Definition of MatchItems parameter in ws_sanctions_pep_check_V2 |
|
1.68 |
11-May-2016 |
Added in the banking web service calls as follows Ws_Banking_AccountModulusCheck Ws_Banking_ChangeAccountBankingFeaturesStatus Ws_Banking_ReturnBankDetailsFromToken Ws_Banking_StatusQueryBankingEnabledCard Ws_Banking_TransferFunds Ws_Banking_UpdateBankingEnabledCard Ws_CreateCard_V2 |
SW |
1.67 |
28-Apr-2016 |
Added new service ws_VerificationRequest Added new service ws_SafeReports Added new service ws_Query3DsecureDetails Added Appendix K for Load Funds Type Added new parameter MatchItems to Ws_Sanctions_PEP_check_V2 Corrected documentation for CompleteMatch response parameter of Ws_Sanctions_PEP_check_V2 Updated documentation of the CreateImage parameter of the Create Card service due to change in recommended practice. Added documentation to the description of the Link Cards service. Removed documentation for Card Transaction XML. This web service is being retired and will be removed from the API. Correct definition of PrimaryToken request parameter on Create Card web service. Corrected description of Transaction Void service Updated list of Load Sources Documented SMS_Required parameter of Load service. |
|
1.66 |
15-Dec-2015 |
Corrected documentation for FeeWaiver request parameter. |
IF |
1.65 |
4-Dec-2015 |
Retired ws_Sanctions_PEP_Check web service, replaced by ws_Sanctions_PEP_Check_V2. |
IF |
1.64 |
30-Nov-2015 |
Added new request parameter BrnCode to Balance Transfer web service Added new web services to support 3D Secure Added new web services to list and update PEP and Sanctions matches. Updated descriptions of existing PEP/Sanctions web services to make them easier to understand. Added new Balance Enquiry V2, same as Balance Enquiry with different LimitInfo response. Added new web service to list pending fees |
IF |
1.63 |
|
Added new request parameter BrnCode to Load and Activate and Load web services. Added new request parameter Quantity to the Create Card web service. Added new request parameter LoadToken to the Create Card web service. Added option 2 to SmsBalance request parameter of Activate and Activate/Load services. Added new web services: Ws_get_ExpireSoon, Ws_list_Sanctions_PEP, Allowed overriding of Product Default groups on Create Card web service by passing space character. Updated the list of groups in the List Groups service |
IF |
1.62 |
03-09-2015 |
Added new service: Web Service Result V2 Added new parameters to Balance Transfer: FeeWaiver Added new response parameters to Enquiry and Customer Enquiry V2 services: AuthCalendarGroup FXGroup Added seconds support to TxnTime response parameter in Card Statement Updated documentation to correct definition of request of Card Change Groups Updated documentation to correct definition of response of Card Statement Updated documentation to correct case of LocDate and LocTime in a few services. |
IF |
1.61 |
27-08-2015 |
Updated documentation for PIN Control Func 03 |
IF |
1.60 |
20-08-2015 |
Added new web service: Card Acceptor Whitelist Added new web service: Send Message |
IF |
1.6 |
09-03-2012 |
Added new web service to retrieve CVV of an existing card. |
n/a |
1.59 |
30-07-2015 |
Updated documentation of Create Card SMS_Required parameter. Added new parameter to Create Card: AuthCalendarGroup Added new parameter to Card Change Groups: AuthCalendarGroup Added new web service: Card Acceptor Disallow list Added new parameter to Regenerate: MailorSMS Added new parameter to PIN Control: FeeWaiver |
IF |
1.58 |
26-06-2015 |
Revised action code table |
IF |
1.57 |
11-06-2015 |
Added new value of func to PIN control service Added new parameter Pblock to Create Card service Added new parameter PINMailer to Create Card service Added new parameter FXGroup to Create Card and Update Cardholder Details services Updated the documentation for the LoadSrc parameter Updated the documentation for the Balance Transfer web service. Added new parameters AuthType, DOB, CVV, AccCode and LastName to PIN Control service. Added new Action Codes to Appendix A Added new parameters Email and MailOrSMS to the Create Card service Added new parameters ExternalRef and TerminalId to the Regenerate service |
IF |
1.56 |
30-03-2015 |
Create Card and Link Card changed to prevent a secondary card being linked to anything other than a-Primary card Length of ProductRef changed to 50 throughout. Added new parameters to the Transactions list returned from Card Statement. These return more granular information about fees. Added new response parameters ProductID and ProductRef to Customer Enquiry Service Version 2 Added new value of CreateType to Create Card web service to allow creation of Master Virtual Cards Length of ProductRef increased to allow for up to 50 alpha characters |
IF |
1.55 |
21-01-2015 |
Change to Enquiry web service: Added PrimaryToken to the response Changed behavior of Customer Enquiry V2 web service:It now returns all secondary cards for the primary token or CustAccount by default Changes to Customer Enquiry V2 web service: Added all group info and IsLive response parameters Change to Create Card web service: Added VanityName as a new parameter Change to Update Cardholder Details service: Added VanityName as a new parameter Change to Cardholder Details Enquiry V2: Added VanityName as a new response parameter Change to Update Cardholder Details service: Added addr3 as a new parameter Change to Card Statement service: Added MCCDescription as a new response parameter. Added option to allow “Fin:” to be removed from the Presentment description Improved accuracy of spelling and case of some parameters Renamed 1.24 from Card Statement to Card Transaciton XML to avoid confusion with 1.7 Card Statement service |
IF |
1.54 |
15-01-2015 |
Change to Create Card web service: Added new request parameter: Card Linkage Group Change to Card Change Groups service: Added new request parameter: Card Linkage Group Change to Change Groups service: Added new request parameter: Card Linkage Group. Added new request and response parameter: Current Card Linkage Group Change to Enquiry service: Added Scheduled Fee Group, Web Service Fee Group and Card Linkage Group to the response. |
IF |
1.53 |
03-12-2014 |
Change to Statement service: Added Processing Code to the Transaction response Change to the Customer Enquiry V2 service. Added PublicToken to the CardList response |
IF |
1.52 |
27-11-2014 |
Changes to Balance Adjustment service: Added LoadedBy parameter Changes to Create Card service: Added new response parameter: Image. Allows card image to be returned in response as PGP-encrypted jpeg. Implemented LoadSrc and LoadFundsType validation. Implemented Limits check against LoadSrc Changes to Balance Transfer service: Added LoadedBy parameter. Added Description parameter. Implemented LoadSrc and LoadFundsType validation. Implemented Limits check against LoadSrc Changes to Activate/Load service: Added Description parameter. Implemented LoadSrc and LoadFundsType validation. Implemented Limits check against LoadSrc Changes to Load service: Implemented LoadSrc and LoadFundsType validation. Implemented Limits check against LoadSrc Change to Regenerate service (ws_regenerate): Added new response parameter: Image. Allows card image to be returned in response as PGP-encrypted jpeg. Change to Create Wallet service: Added new response parameter: Image. Allows card image to be returned in response as PGP-encrypted jpeg. Implemented LoadSrc and LoadFundsType validation. Implemented Limits check against LoadSrc Change to Status Change service: Corrected Status code validation (status 01 retired). Change to Unload Status Change service: Corrected Status code validation (status 01 retired).Added List Products service (ws_list_products). |
IF |
1.51 |
27-10-2014 |
Change to internal logic of Balance Adjustment: It will now check card maximum balance and return an error if it will be exceeded by the current operation. This ehavior can be overridden by using the “ForcePost” parameter. Changes to Create Card service: Additional Parameter: ExternalAuth, can be configured to return full PAN for a client or product. Fixed Delivery Address Line 3 issue
Changes to Balance Enquiry service: Additional request parameter: GetLimits; Additional response parameter: LimitInfo Change to Balance Transfer service to link Load and Unload transactions via LinkId Change to Void Transaction web service to link the transactions via LinkId Change to Load service so that if the card is Multi-FX then the given Load amount will load onto the account associated with the input currency Change to the Activate, Activate/Load and Phone Activation web services so that if the card is Multi-FX then the web method will activate all accounts associated with that card Added new response parameter Product to the Enquiry web service. Added new service Link Cards. Added new service List Groups. |
IF |
1.50 |
21-10-2014 |
Added new Load Sources 56-67 to Appendix J Various minor corrections including removal of references to SecDet request parameter. |
IF |
1.5 |
24-11-2011 |
Added some new process codes for taking fees. |
n/a |
1.49 |
01-09-2014 |
Documented Create Wallet, Bulk Creation Wallet and Wallet Balance Enquiry web services. Added “0 – Undefined” as an option for Itemsrc |
IF |
1.48 |
03-07-2014 |
Documented new Client FX web service |
IF |
1.47 |
06-05-2014 |
Corrected the definition of the PrimaryToken parameter on Create Card. Documented new Address Line 3 parameter addrL3 on Create Card web service Corrected definitions of txnFilter on Card Statement |
IF |
1.46 |
10-03-2014 |
Clarifications on Create Card and Regenerate parameters. Updated the Bulk Creation web service to clarify parameters and functionality. Added OrigStan as a new response parameter to Card Statement. |
IF |
1.45 |
17-02-2014 |
Increased max length of all Address Lines 1 and 2 to 50 chars Clarified Mobile Telephone parameter on Update Cardholder Details Added pubtoken request parameter to, and updated description of Create Card web service to cater for Replacement card requests Updated Regenerate web service description to clarify current Lost/Stolen functionality Added new action codes 700 and 701 Added new SMS_Required request parameters to Load and Status Change services. Added Appendix E to explain how SMS messages can now be configured in a flexible way and in chosen cardholder language |
IF |
1.44 |
07-01-2014 |
Added new Action Code 899. Added new value of filter to Card Statement (txnFilter=6) |
IF |
1.43 |
05-12-2013 |
Added cobrand to the Create Card web service. If supplied it will replace PROGRAMID in the Balance XML. Updated definition of Transaction Filter “3” in Card Statement Removed Disputed and Rejected from Appendix I – Transaction Status as no longer used. Added new request parameter DescriptionDelimiter to Card Statement Added new response parameter MCC to Card Statement Clarified the list of allowed characters in Create Card CardName parameter. Clarified dimensions of Public Token parameter. Clarified dimensions of WSID parameter. |
IF |
1.42 |
21-11-2013 |
Added new Action Codes 893-898 inclusive |
IF |
1.41 |
28-10-2013 |
Minor clarifications. Documented Description parameter of ws_load and ws_unload. |
IF |
1.40 |
17-09-2013 |
Updated Appendix G – Status Codes Added three new web services for ID verification (UK only as of this release): |
IF |
1.4 |
17-11-2011 |
Added one new field (<Apply_Fee>) in the create card web service request to take the card issue fees. Modified the available balance (<avlbal>) field in the response of web services; balance enquiry, card statement, balance adjustment, balance transfer and card enquiry. Previously the available balance includes all financials but ignores outstanding authorisations and now it includes all financials and outstanding authorisations. |
n/a |
1.39 |
16-07-2013 |
Added new Request Parameter CardManufacturer to the ws_createcard web service. Added new Request Parameters SchedFeeGroup and WSFeeGroup to the ws_createcard web service, to allow setting of Scheduled Fee Groups and Web Service Fee Groups Updated definition of <Lang> parameter in ws_createcard web service. Further clarifications throughout. |
IF |
1.38 |
09-04-2013 |
Added new response parameters in the Ws_Enquiry web service: <StartDate>, <EndDate>, <LimitsGroup>, <MCCGroup>, <PERMSGroup> and <FeeGroup>. Added new input parameters to the Create Card and Bulk Card Creation web services to specify language <lang> and bulk delivery code <Delv_Code>. Added new response parameter to the Create Card and Bulk Card Creation web services: <StartDate>. Clarified format of existing parameter: <ExpDate>. Added missing SysDate documentation to Unload web service record description. Clarified the txnFilter parameter in the ws_card_statement web service. Added new parameter <sms_required> to the ws_pincontrol web service. Added new web service Simple Check |
IF |
1.37 |
04-04-2013 |
Added LinkId to ws_card_statement response. Added new Appendix (J) for load sources. |
n/a |
1.36 |
25-03-2013 |
Added new input parameters in the Create Card and Bulk Card Creation web services to handle SMS sending during virtual card creation. |
n/a |
1.35 |
20-03-2013 |
Added new input parameters in the Create Card and Bulk Card Creation web services to take FULFIL1 and FULFIL2 |
n/a |
1.34 |
25-02-2013 |
Added new input parameters in Create Card and Bulk Card Creation web services to take delivery address. |
n/a |
1.33 |
29-01-2013 |
Full review of web service document. |
n/a |
1.32 |
28-01-2013 |
Added new web service to convert cards form virtual to physical. |
n/a |
1.31 |
17-12-2012 |
Added new web service to change the groups of card. |
n/a |
1.30 |
16-11-2012 |
Corrected the Transaction Void web service documentation |
n/a |
1.3 |
13-10-2011 |
Modified the Switch Advanced Permission web service to take a list process code to enable fees. |
n/a |
1.29 |
15-11-2012 |
Added new parameter (<SmsBalance>) in the Ws_GiftCard_Activate and Ws_GiftCard_Activate_Load web services. |
n/a |
1.28 |
27-09-2012 |
Added new web service to apply fees and web service to check the Politicaly Exposed Person(PEP) |
n/a |
1.27 |
17-09-2012 |
Full revise of web service document |
n/a |
1.26 |
07-09-2012 |
Added new input parameter (<FeeGroup>) in the create card change group web services. Added other new iput parameter (<PrimaryToken>) in the the create card web service. |
n/a |
1.25 |
14-08-2012 |
Added new web service to change the groups. |
n/a |
1.24 |
13-08-2012 |
Full revise of web service. Added new web service to get the transaction details. |
n/a |
1.23 |
19-07-2012 |
Added new out parameter (<MaskedPAN>) in the Ws_CreateCard and Ws_GiftCard_Enquiry web services. |
n/a |
1.22 |
27-06-2012 |
Added new field (<PERMSGroup>) in the Create Card web service. |
n/a |
1.21 |
25-06-2012 |
Added new fileds in the Create card web service and the XML request in the bulk creation web service. Added new action code to return when tried to activate an active card. |
n/a |
1.20 |
21-06-2012 |
Added two new input parameters (<LimitsGroup> and <MCCGroup>) in the Create Card web service. |
n/a |
1.2 |
07-10-2011 |
Added one field (<Scheme>) in the response of Card Enquiry web service. Added one new field (<AuthType>) in the request of Phone Activation web service. |
n/a |
1.19 |
20-06-2012 |
Updation in card statement web service. Added the description of transaction type and transaction status. |
n/a |
1.18 |
15-06-2012 |
Added a new input field (<newToken>) in the request of Balance Transfer web service to pass the destination token. |
n/a |
1.17 |
14-06-2012 |
Added a new input parameter (<CardName>) in the Create Card web service to pass the card’ emboss name. |
n/a |
1.16 |
12-06-2012 |
Added Fees fields (Fixed Fee, Rate Fee, FX Padding and MCC Padding) in the transaction of the card statement web service. |
n/a |
1.15 |
11-06-2012 |
Added the description of XML tags in the bulk virtual card creation web service. |
n/a |
1.14 |
07-06-2012 |
Modified the card status codes. |
n/a |
1.13 |
06-06-2012 |
Full revise of web service. |
n/a |
1.12 |
21-05-2012 |
Added a new field in the Ws_GiftCard_Activate_Load_ProductTpye_CP web service. |
n/a |
1.11 |
17-05-2012 |
Added a new field in the Ws_GiftCard_Activate_Load_ProductTpye_CP web service. |
n/a |
1.10 |
11-05-2012 |
Added new web service for instant card creation. |
n/a |
1.1 |
28-09-2011 |
Load source description field is added in the Create Card web service. Added load source description field in the Card Load web service. Created a new web service to change advanced permission bit of a card. Modified the <loadSrc> values. |
n/a |
1.0 |
15-09-2011 |
First draft. |
n/a |