List of Web Services API

The table below lists the available web services (ordered alphabetically).

API Description
Ws_Activate Sets the status of the card to ‘active’ to enable Mastercard/Visa network transactions. Used to activate cards issued in an inactive state.
Ws_Activate_Load Enables simultaneous load and activation of a card. This is a common requirement for cards sold from kiosks or from retail stores. For cards ordered over the internet, delayed activation provides added security by ensuring that any card stolen or lost in the post cannot be used.
Ws_Activate_MVCLoad Enables simultaneous load from Master Virtual Card (MVC) and activation of cards. Ws_Activate_MVCLoad effectively combines the functions of Ws_BalanceTransfer and Ws_Activate for clients that are using MVCs (Master Virtual Card).
Ws_AddUpDelCredentials Enables you to collect the cardholders' 3D Secure credentials and insert, update or delete those credentials using the Real-Time Data Exchange interface for Cardinal and Apata.

Ws_ApataCardLevelConfigurations

Enables you to add, update or delete card level configurations for 3D Secure via Apata, such as the language of the Apata Challenge screens and the Challenge Profile to use.
Ws_Balance_Enquiry (V2) Returns the current available balance on the card.
Ws_Balance_Enquiry Wallet Returns the current available balance on each of the available currency wallets for a multi-FX card.
Ws_BalanceAdjustment Enables you to apply a debit or credit to a card record.
Ws_BalanceTransfer Used to transfer an amount from one card to another.
Ws_BalanceUpdate Updates the available and current (STIP) balance for Program Managers set up for EHI Processing with STIP (Stand-in processing mode 4). For details, see the External Host Interface (EHI) Guide.
Ws_Banking_AccountModulusCheck Validates that a sort code and account number (UK Bank Accounts provided through programmes using Thredd Bottomline Agency Banking) are valid via a modulus check.
Ws_Banking_CancelDirectDebitBankingEnabledCard Marks a direct debit as cancelled where a card has an associated UK Bank Account (provided through programmes using Agency Banking). The GUID (Globally Unique ID) for the direct debit is required and can be obtained by calling
Ws_Banking_Card_Statement_V2 This web service is an enhancement to Ws_Card_Statement and returns all statement details for this card and previous cards if the card has been replaced for various reasons
Ws_Banking_ChangeAccountBankingFeaturesStatus Changes the features of the banking enabled card and allow the user to switch functionality on or off.
Ws_Banking_CreateCustomer Enables you to register customer details without creating associated bank accounts or cards.

Ws_Banking_DD_CancelMandate

Cancels a specific mandate for a specific mandateId and token.

Ws_Banking_DD_GetMandate

Retrieves all mandates for a given token.
Ws_Banking_GetDirectDebitInstructionsBanking
EnabledCard 		Returns a list of all direct debits for a given token (with or without sub accounts). Note: Only for programmes using Agency Banking.
Ws_Banking_GetPendingDirectDebits Returns a list of all direct debits that are due for payment today for a given token (with or without sub accounts). Note: Only for programmes using Agency Banking.
Ws_Banking_RegisterNotification For some banking integrations, once you have called Ws_CreateCard_V2 to create the bank account and card, you need to make additional calls to allow payments to be processed on and off the card. There are a number of options, but as a minimum, you should switch on PAYIN and PAYOUT to facilitate payments. Note: All notifications work at a customer level, so if a customer has more than one account, the notification will apply to all of the customers accounts
Ws_Banking_ReturnBankDetailsFromToken Returns the sort code and account number (UK Bank Accounts provided through programmes using Agency Banking) from a token.
Ws_Banking_StatusQueryBankingEnabledCard Returns the Agency Banking features (UK Bank Accounts provided through programmes using Agency Banking) that are enabled on a card and the status of the card.
Ws_Banking_TransferFunds Makes an external payment via the Faster Payment banking network where a card has an associated UK Bank Account (provided through programmes using Agency Banking). Note that the money is queued and has not necessarily entered the banking network.
Ws_Banking_UpdateBankingEnabledCard Updates the status of Banking services for a card depending on the current status.
Ws_BulkCreation Creates a bulk number of virtual as well as physical cards in a single request. This web service takes an XML document as the input parameter with the information needed to create virtual or physical cards. It produces an XML document with the list of newly created virtual or physical cards as the response. Card images will be created in the web service directory when creating a virtual card.
Ws_BulkWalletCreation Creates multiple wallets in a single request. This web service takes an XML document as its input parameter with the information needed to create wallets and produces another XML document with the list of newly created wallets as a response.
Ws_Card_BalEnq Returns the available balance of a card and the sum of any blocked amounts.
Ws_Card_Change_Cardacceptor_List Updates the card acceptor lists such as Allow and Deny lists that a card makes use of.
Ws_Card_Change_Groups Changes one or more of the usage groups for a specific card within any of those configured for your programme (e.g. Limit Groups, MCC Group, Fee Group and Usage Group).
Ws_Card_Statement Returns a list of transactions performed by the cardholder since a specified date, together with the starting balance and current balance. Typically you should specify a date range of within the last 7 days. If the date is omitted, then all transactions are returned. Current actual and available balance is also returned.
Ws_CardAcceptorBlacklist Used to maintain Card Acceptor (MerchantID) Deny lists, which can then be assigned to a card or group of cards. Thredd will decline authorization transactions belonging to any merchant IDs on the Deny list. The response code will be ’05 – Do not honour’.
Ws_CardAcceptorWhiteList Used to maintain Card Acceptor (MerchantID) Allow lists which can then be assigned to a card or group of cards. Only merchant IDs on the Allow list will be approved by Thredd at authorisation stage.
Ws_CardHolder_Details_Enquiry Returns the details of a cardholder.
Ws_Change_Cardacceptor_List Updates the card acceptor lists such as Allow and Deny lists that a group of cards belong to.
Ws_Change_Groups Changes groups such as Group Limits, MCC Group and Usage Group of cards within a product or a customer account.
Ws_Check Checks web service availability. It validates the SOAP credentials and Issuer Code by calling database procedures.
Ws_Client_FX Enables you to send your own foreign exchange (FX) rates to Thredd. You can stream in FX rates at your chosen frequency (e.g. hourly, daily). The rates can be used for multi-FX wallet functions or for provisioning of fixed rate FX cards.
Ws_Convert_Card Upgrades a virtual card to a physical card.
Ws_CreateCard Creates both a virtual card and a physical card.
Ws_CreateCard_V2 Creates a card with Agency Banking features enabled. It will also upgrade an existing card to have banking features. Applies only to programmes using Agency Banking.
Ws_CreateWallet Used to create virtual wallets as well as physical card wallets.
Ws_Customer_Enquiry Returns the list of cards associated with a specified customer name.
Ws_Delete3DSecureDetails Deletes 3D secure enrolment details for a card. ( Cardinal Batch File Interface; Legacy use only).
Ws_Enquiry Returns the details of a card, such as: Token, Expiry Date, Status, Cardholder name.
Ws_ExtendExpiry Changes the Thredd expiry date of cards by the specified value.
Ws_Generic_Fees Applies fees with a comment to a particular card.
Ws_Get_Card_ExpireSoon Returns the details of cards that are going to expire within the month. The response will return all cards due to expire, regardless of the volume.

Ws_GetApataCardLevelConfigurations

Retrieves the card level configuration for 3D Secure (using Apata).
Ws_Get_Passcode Used to retrieve the Access Code (also known as pass code or activation code) of cards.
Ws_Insert3DSecureDetails Enrols a specified cardholder onto 3D Secure using the Cardinal Batch File Interface 3D Secure service. (Legacy use only)
Ws_link_cards Links cards in a Primary and Secondary relationship, and can be used when the primary card with existing secondary card linkage(s) needs to be replaced with a new token. The secondary cards can be linked to the new token via this web service call.
Ws_list_group Lists the codes and descriptions of all groups of a certain type (e.g. Fee Groups, Limit Groups).
Ws_List_Pending_Fees Lists service lists details of pending fees that relate to a particular card.
Ws_List_Products Lists products your programme has on the Thredd systems and their descriptions.
Ws_Load Loads or re-loads a card with a specified amount.
Ws_MVCLoad Loads funds from Master Virtual Cards (MVC) only. This is similar to balance transfer, the only difference is that the source is always an MVC token.
Ws_MVCUnload Enables customers to unload back to Master Virtual Card (MVC) only.
Ws_Payment_Token_Get Gets the details for MDES (Mastercard Digital Enablement Service) Payment Token Cards.
Ws_Payment_Token_StatusChange Changes the status of an MDES (Mastercard Digital Enablement Service) Payment Token Card.
Ws_Phone_Activation Enables activation of a card by phone. It also returns the PIN and the PIN status of that card.
WS_PinControl Enables you to set, retrieve, unblock and change the PIN associated with the card.
Ws_Query3DSecureDetails Used to view the phone number of a particular user’s token that has been enroled for 3D secure and gets the details from Thredd 3DS table. (Cardinal Batch File Interface; Legacy use only).
Ws_Regenerate Retrieves the card image configured in the Thredd platform for virtual and physical cards that have been converted which can then be displayed to the cardholder. If a customer wants to see the image some time after card creation you can regenerate the image. This web service can also be used to replace Lost or Stolen cards; the customer will be issued with a new PAN, CVV2 and Expiry Date.
Ws_RegenerateWallet Regenerates MFX cards.

Ws_Remove_CardHolder_Data

Removes personally identifying cardholder data (cardholder name, address, email and phone number) from the specified card. You can remove data from multiple cards in a single request.
Ws_Renew_Card Enables you to renew or replace cards. Combines the functionality of card replacement and card renewal. The replacement card will automatically have the same balance as the original card at the time when the replacement card is activated. Any linked cards will still point to the correct card.
Ws_ResetAccumulator Allows you to reset transaction and amount counters (since the last authenticated transaction) on a card to re-enable contactless devices and wearables, where a Secure Cardholder Authentication cannot be performed by the terminal (i.e. those that do not offer PIN).
Ws_Send_CardFiles Creates two CSV files and sends the files to the SFTP folder specified in the request. One file contains the 9 digit public token and CVV. The other file contains the 9 digit public token and the middle 6 digits of the PAN.
Ws_SendMessage Used to send a predefined message to the cardholder via SMS or Email. Thredd can configure the message using a selection of variables.
Ws_Simple Check Checks web service availability. Can be called over HTTPS GET.
Ws_StatusChange Enables the status of a card record to be changed. For example to: Do not honour, lost, stolen or Card Destroyed.
WS_Token_Device_Management Allows you to retrieve a list of devices bound to a DPAN. Can be used to unbind a device by initiating an Unbind API call to Visa.
Ws_Transaction_Void Enables cancellation of any transaction which has been implemented via a web service, and also allows you to remove uncleared authorizations.
Ws_UnLoad Unloads a card. Note that any outstanding, unsettled authorisations on the card may result in the card going into a negative balance.
Ws_UnLoad_StatusChange Simultaneously unloads the card and changes the card status (e.g. to expired).
Ws_Update_Cardholder_Details Enables cardholder details to be updated. For example: name and address.
Ws_Update_Cardholder_Details_V2 This web service is an enhancement to Ws_Update_Cardholder_Details. It allows further cardholder details to be updated such as EmbossLine4, ProductRef, ThermalLine1 etc.

Ws_UpdateLastModifiedType

Used to update the last modified type of 3D secure action for a card. (Cardinal Batch File Interface; Legacy use only).
Ws_Update3DSecureDetails 3D Secure service to amends 3D secure details for a card; this web service can be used to update the phone number used for authentication SMS. (Cardinal Batch File Interface; Legacy use only).

The next sections in this guide are organised based on common tasks performed using the API, in the order in which we expect most users will use them. Please use the left-hand menu options to find the section and API you are interested in.