EPX Account Updater API

The EPX Account Updater is a service that allows developers to update tokenized customer account information (EPX BRIC) in bulk. The updates are passed to the EPX server via SFTP in XML format. The system allows you to easily update account information such as credit card numbers and expiration dates.


Delivering definitive business benefits:

The EPX Account Updater ensures a continuous and frictionless payment processing experience for merchants who need to store customer payment information. It can help merchants can minimize invalid card declines and avoid processing errors caused by changes in stored card information. By minimizing declined payments, the customer service effort involved in attempting to collect those payments will also be reduced. Account Updater:

  • Reduces the occurrence of declined payments due to loss or expiry of cards.
  • Helps minimize both failure rates and interruptions to scheduled recurring payments.
  • Features a quick and simple one-time enrollment process.
  • Reduces the costs and risks related to individual update of card data.

How it works:

The EPX Account Updater API is an SFTP service designed to allow secure file transfers between the developer’s servers and our EPX Payment Gateway. The files we transfer will contain account information updates provided by merchants in XML format. EPX will then process the request document(s) and creates a response XML document. Once all accounts are updated, the response document is placed next to the request document in the SFTP location. You can use your system to access these documents and see the results of processing the updates.

How to use the EPX Account Updater in 5 simple steps:

  1. The developer uploads the XML batch file of account information changes from the developer’s servers to the home directory on the EPX SFTP site via port 22 and the credentials provided by EPX.
  2. The EPX Account Updater API picks up the file for parsing and processing and sends each parsed request to the EPX Payment Gateway for processing.
  3. The EPX Account Updater API then receives the response for each from the EPX Payment Gateway and combines those responses into an XML response file.
  4. The EPX Account Updater API places the XML response file into the home directory where the request file was retrieved.
  5. The developer then reconnects to the EPX SFTP server to retrieve the XML response file for parsing

Card provider setup:

To get the EPX Account Updater up and running for your business, our EPX Relationship Managers and the Merchant Setup team must enroll merchants in the Account Updater programs for both Visa and Mastercard.

Visa Account Updater enrollment steps:

  1. The merchant contacts their EPX Relationship Manager to request enrollment in the Visa program.
  2. The EPX Relationship Manager completes the Visa Merchant Enrollment Form on behalf of the merchant, secures a Registration Number and sends both to Visa.
  3. Visa reviews the information and responds with an approval. The review process can take up to 10 business days.

Mastercard Account Updater enrollment steps:

  1. The merchant contacts their EPX Relationship Manager to request enrollment in the Mastercard program.
  2. The EPX Merchant Setup team enables the "Account Updater Service" within our system. There is no need to contact Mastercard direct. 

How to get started:

EPX provides developers access to a test environment for application building and separate credentials for production upon completing certification.

Typical steps to completion:

  1. A developer must register to access the dashboard, initiate a project, and receive test credentials.
  2. With these credentials, the developer can build their application against the test environment.
  3. Prior to transmitting test XML files to EPX, an integration specialist must review the format of your file, as required.
  4. Upon review and approval of the test file’s format, they will release the SFTP credentials for the developer to begin transmitting request files.
  5. Once development is complete, the application can be submitted for certification.
  6. After certification has been passed, the Integration Team will issue a certification letter, which can be used to get production credentials.