Skip to main content

TSYS Wholesale Boarding API Usage

Updated

Below is a breakdown of the TSYS boarding API commands that are used in TurboApp (before and during submission) and in the Helpdesk (for real-time maintenance). 

 

TurboApp - Before Submission

  1. The ViewMerchant command is used to confirm the MID has not been used in Express when creating a TurboApp.

  2. The ViewDiscoverRegistration command is used to confirm MID is not associated with another merchant in Express, when assigning the Discover MID in the Rates & Fees page.

 

TurboApp - During Submission

  1. The command AddDiscoverRegistration is used to create the Discover Registration record in Express.

  2. The command AddMerchant is used to create the merchant record and the Amex Registration in Express.

  3. The action SaveMerchantPricing is used to create the merchant pricing profile in PPM.

  4. The action SaveMerchantDDA is used to sync the merchant DDA info with PPM.

  5. The command AddTerminal is used to create the terminal records in Express. One command is executed per terminal.

 

Helpdesk - Realtime Maintenance

Below is a list of the Helpdesk Ticket Types used for real-time maintenance and the TSYS API commands they use:

  1. TSYS - Update DDA (Auto)
    The actions SaveMerchantDDA & DeleteMerchantDDA are used to sync DDA updates to PPM.

  2. TSYS - Funding Delay (Auto)
    The command ViewMerchant is used to pull the live record for the merchant from Express.
    The command MaintainMerchant is used to push the updated merchant record to Express.

  3. TSYS - Manage Demographics (Auto) & TSYS - Update DBA & Address (Auto)
    The command ViewMerchant is used to pull the live record for the merchant from Express.
    The command MaintainMerchant is used to push the updated merchant record to Express.
    The commands ViewDiscoverRegistration & MaintainDiscoverRegistration are used to pull and apply the demographic changes to the Discover Registration.
    The commands ViewAmexOptBlueReg & MaintainAmexOptBlueReg are used to pull and apply the demographic changes to the AMEX Registration.
    The command ViewMerchantTerminals is used to pull the list of all terminals for the merchant.
    The commands ViewTerminal & MaintainTerminal are used to pull and apply the demographic changes to each individual merchant terminal.

  4. TSYS - Update Status (Auto)
    The command ViewMerchant is used to pull the live record for the merchant from Express.
    The command MaintainMerchant is used to push the updated merchant record to Express. If setting the merchant to Closed, TSYS will also close its equipment records with no need for a separate Update Equipment submission from Merchant Central.

  5. TSYS - Update Pricing (Auto)
    The action GetMerchantPricing is used to get all the merchant fees from PPM.
    The actions DeleteMerchantFees & AddMerchantFees are used to sync the fee changes to PPM.

  6. TSYS - Add Equipment (Auto) & TSYS - Copy Equipment (Auto)
    The command ViewMerchant is used to pull the live record for the merchant from Express.
    The command ViewMerchantTerminals to get the number of terminals and apply the next terminal sequence in the form.
    The command AddTerminal is used to create the terminal record in Express

  7. TSYS - Update Equipment (Auto)
    The command ViewMerchant is used to pull the live record for the merchant from Express.
    The commands ViewTerminal & MaintainTerminal are used to pull and apply the changes to the terminal record in Express.

  8. TSYS - Update Equipment Status (Auto)
    The command ViewMerchant is used to pull the live record for the merchant from Express.
    The commands ViewTerminal & MaintainTerminal are used to pull and apply the Close Profile & Closed Profile Date field changes to the terminal record in Express.