Web Services Guide (SOAP)

Web Services Guide 3.18

Updated the list of card Status Codes that can be used when setting the status of a card using the Card Change Status (Ws_Status_Change) web service.

Updated the description of action code 952.

Added a reference to the Fees Guide, which provides further guidance on applying card fees using web services.

Removed references to the following web services, which were deprecated 30/07/2021: Ws_WebServiceResult and Web_Service_Result_V2. See PRN-31.

Two optional boolean fields, IsSingleUse and IsNonReloadable have been added to the following services: Card Create (Ws_CreateCard), Create Card with Agency Banking (Ws_CreateCard_V2), Card Bulk Create (Ws_BulkCreation) , Wallet Create (Ws_CreateWallet) and Wallet Bulk Create (Ws_BulkWalletCreation). These fields enable you to specify single use and non-reloadable cards. See PRN-162.

Removed the <Replacement> and <PublicToken> fields that were used to specify a replacement card when implementing the Card Create (Ws_CreateCard), Create Card with Agency Banking (Ws_CreateCard_V2) or Card Bulk Create (Ws_BulkCreation) web services. You should always use the Card Renew (Ws_Renew_Card) web service to specify a replacement card. See PRN-159.

Correction: In the Card Create web service section, updated the table of fields to include the ItemID field in the response, and the example response to include the StartDate field.

Web Services Guide 3.17

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_PaymentToken_Create) web service, one of the supported values that can be used in the WalletID field should be SAMSUNG, Using a value that is not supported will return an action code of 439.

Updated the PIN field usage table defining how a card's PIN can be updated. See Card PIN Control.

Maximum length of the CardManufacturer field updated to 50 characters. See Card Create.

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.

Added details of which card status values can be used to Suspend, Delete and Deactivate a payment token at the Card Scheme. See Payment Token Status Change.

For bulk card create (Quantity greater than 1), we recommend that you run the token / card details enquiry one day after the bulk card creation. Added a note to clarify that CreateType options 3, 4 and 5 will not work if Quantity is greater than 1. See Card Create.

When using the Create Card web service (Ws_CreateCard), if quantity is greater than 1, then some fields in this web service are not relevant and should be left blank or, if mandatory, set to the default value of '0'. For details, see Create Card.

Duplicate Gemalto Singapore entry removed from the Card Manufacturer Approved Characters table in the String Cleaning and Approved Characters page.

Guide rebrand to new company name and brand identity.

Web Services Guide 3.16

The ExpDate field in the Card Activate (Ws_Activate) and Card Activate and Load (Ws_Activate_Load) web services can now be used 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 (and as shown on the printed card or card image).

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.

Web Services Guide 3.15

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 CurrCode value in Card Activate and Load (Ws_Activate_Load) is optional. If it is not provided, then card’s billing currency will be used.

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).

Correction to clearing field values when using the Update Cardholder Details (V1) and Update Cardholder Details (V2) web services: the newAccCode field has been removed from the list of fields that can have their values cleared by sending a <space>.

Update to description of action code 213.

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.

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.

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.

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.

Updated the Copyright Statement.

Thredd Web Services Guide 3.14

Update to description of action code 779.

Correction to card name permitted characters: Only forward slash characters (“/”) are allowed; any backslashes (“\”) will be replaced with forward slashes.

Updated the code examples in the 3D Secure RDX Credentials (Ws_AddUpDelCredentials) web service to show the correct format of the KBA fields.

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.

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 should use.

Thredd Web Services Guide 3.13

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.

Added a new Currency Code, SLE, for the new Sierra Leonean leone.

Added two new web services: Ws_Banking_DD_CancelMandate and Ws_Banking_DD_GetMandate.

Added WebServiceResult field to wsBalanceAdjustment, wsLoad, wsUnLoad, wsUnloadStatusChange, wsStatusChange and wsActivate web services. See PRN-119.

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.

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>.

Thredd Web Services Guide 3.12

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.

Thredd Web Services Guide 3.11

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.

Web Services Guide 3.10

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.

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.

Web Services Guide 3.0.9

The web service responses for fields containing balance amounts have been updated to return the number of decimal places based on the 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.

Web Services Guide 3.0.8

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 web service, 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.

Web Services Guide 3.0.7

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).

Updates to the Ws_Renew_Card web service response to include the Expiry Date. See PRN-45.

New action code440 Archived card, deny is returned in response to a request to update an archived card. See PRN-52.

Web Services Guide 3.0.6

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. See PRN-40.

Corrections to Status Codes.

Web Services Guide 3.0.5

Changed <PrimaryToken> minimum length to 9 characters in Ws_CreateCard. See Card Create.

Web Services Guide 3.0.4

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. See PRN-33.

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>. See PRN-30.

Whitelist and Blacklist now referred to as Allow list and Disallow list.

Added Get method to the Ws_AddUpDelCredentials web service plus other updates. See 3D Secure RDX Credentials (Cardinal). See PRN-32.

Web Services Guide 3.0.3

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. See PRN-29.