Encryption Web Services (EWS) provides a SOAP-based web service for Vantiv’s Encryption Services. This includes primary support for OmniToken and in some case, legacy support for Reverse Crypto. Operations that support Reverse Crypto will be noted. A caveat to this support is that the service assumes that Reverse Crypto at Vantiv will be retired prior to the next key rotation; hence supported operations will not return the token Id at this time.
This document details the use of Vantiv’s Encryption Web Services and its message structure. The intended audience is developers who want to consume Vantiv’s Encryption Web Services and have received the on-boarding materials that are associated with this document. In the Message Structure section, the entire message is broken down layer by layer and is meant as a reference. Many of the tags seen in that section are not meant to be used together, but rather describe each tag and its potential inner tags and attributes. This is a great place to find the meaning of a tag and how to format the contents properly.
The Web Service Operations section calls out each operation and relevant details about the unique fields. An important note about the order of tags in a message: order matters! Misordering tags will result in a request that is invalid which will generate a fault response.
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.
- Gradle v4.0 and above. To install, follow the steps mentioned at Gradle | Installation
- Get the latest code from the repo using the command below:
git clone https://github.com/Vantiv/ews-simulator.git
- Run the gradle build:
gradle build
- The gradle build should create the Spring boot jar as below:
build/libs/worldpay-ews-simulator-X.X.X.jar
Tests are run as part of the build steps above, but to run them manually you can run the command:
gradle test
Following are the command line options that can be used to start the simulator to respond accordingly.
| Argument Name | Default value | Description | Type | Sample value |
|---|---|---|---|---|
| port | 443 | Port number to start the simulator on. | Optional | 443 |
| key-store | Fully qualified location to the key store file | Mandatory | /etc/path/to/key/store/keystore.jks | |
| key-pass | Password to the key store | Mandatory | keyStorePassword | |
| validate-header | true | Determines if soap header needs to be validated in the incoming requests | Optional | true/false |
| delay | 0 | Amount of delay in ms to be simulated in response, if -1 adds delay based on merchant-ref-id. More details in wiki. | Optional | 5 |
| endpoint | merchant/encryption/v4 | Endpoint the simulator listens to. E.g. https://host:port/merchant/encryption/v4 | ||
| log-level | INFO | Level of details in logging | Optional | DEBUG |
| log-path | ewsLog | The folder location where the log will be stored | Optional | temp/simulatorLog |
To start the spring server for a given port use the below command:
java -jar -Dport=XXXX -Dkey-pass=<KeyPassword> -Dkey-store=<Location to keystore file> -Dvalidate-header=false -Ddelay=0 -Dendpoint=etws/v4 -Dlog-path=temp/simulatorLog -Dlog-level=DEBUG path/to/worldpay-ews-simulator-X.X.X.jar
To get the current health of the server, use the below command:
curl -X GET https://host:port/actuator/health
Please see the wiki to get the full list of available features in the simulator.
- Gradle - The build tool
For the versions available, see the tags on this repository.
See also the list of contributors who participated in this project.
This project is licensed under the MIT License - see the LICENSE file for details