In this “How-to” guide, we will show you how to test MLE (Message Level Encryption) enabled APIs using Postman.
Important Links:
-
Encryption Guide https://developer.visa.com/pages/encryption_guide
-
Working with Two Way SSL https://developer.visa.com/pages/working-with-visa-apis/two-way-ssl
- How to run the Hello World API with Mutual SSL on Postman
- Postman MLE Zip File
Enable MLE for the API(s) you are interested in.
Login to your Visa Developer Dashboard and go to your project, you should see something like this:
Enable the APIs for which MLE needs to be active in VDP by toggling the API for which MLE needs to be enforced.
In this example, we will enable MLE for Funds Transfer API And Query API as below:
How to get credentials
You can obtain your project credentials by browsing the left side navigation menu of your project and click on “Credentials”.
Next step we will create a Key-ID by clicking on the Generate Key-ID button.
After you have clicked the button, you will get Key-ID. Copy the Key-ID for your reference.
The Key-ID will look like this: 41d9f2a1-xxxx-4xxx-b40c-a0480c2xxxxx
The next step is to add a CSR (Certificate Signing Request). Click on the link "Add CSR" .
You will be prompt to submit a Certificate Signing Request.
We have option to Generate a CSR for me (default) or submit your own. In this example we will use the Generate a CSR for me (default) and Click Confirm button.
After submitting the request, you will be prompt to download the Certificate/Copy Private Key.
After you have downloaded the private key, check the box "I confirm that I've downloaded my certificate key" and click continue. You will see the Status change to "Active".
Expand the Key-ID and you will see the Server Encryption Certificate and Client Encryption Certificate.
Download both certificates and save it.
To be able to make an API call with MLE, you need to have the following
- Server Encryption Certificate
- Key-ID
- Certificate Private Key
How to test MLE using Postman
Step 1 - Get the Postman MLE Zip File
- Download the attached postman MLE Zip file and extract it
- You should see the following files
Step 2 - Setting up the mock server for the encryption and decryption
We are using Node JS for the mock server which allows the ease of encrypting the request payload and decrypting the encrypted response payload.
- If node is not already installed, please install from https://nodejs.org/en/download/
- Go the extracted folder location, and edit config.js
- Set the below parameters
var config = {};
config.mlePublicKeyPath = 'ENTER PUBLIC KEY PATH';
config.mlePrivateKeyPath = 'ENTER PRIVATE KEY PATH';
module.exports = config;
- Run npm install
- Run node index.js to start the Node JS Server on port 3000
Step 3 - Configure Postman
- Launch Postman
- Click on the Import button
- Import the collection file "TestMLE.postman_collection.json" to postman
- Set Your Key ID on Postman. Navigate to TestMLE -> a_Encrypt -> Headers. The value of header kid will be the MLE key
- Set your VDP credentials for Basic Authentication. Navigate to TestMLE -> b_VDRequest -> Authorization.
- Configure 2-Way (Mutual) SSL on Postman. Please refer to the step 2 of the article How to run the Hello World API with Mutual SSL on Postman
NOTE: All the above steps are one time set up which is needed only once during initial setup.
Step 4 - Executing the test
- Navigate to TestMLE -> a_Encrypt -> Body.
Copy paste the sample payload from the below link to the postman body, click on send.
https://developer.visa.com/capabilities/visa_direct/reference#visa_direct__funds_transfer__v1__pushf...
Update the json field "localTransactionDateTime" accordingly to the current date/time.
- Navigate to TestMLE-> b_VDRequest
Copy the Request URL from the below link. Once done just click on send https://developer.visa.com/capabilities/visa_direct/reference#visa_direct__funds_transfer__v1__pushf...
E.g. https://sandbox.api.visa.com/visadirect/fundstransfer/v1/pushfundstransactions
- Navigate to TestMLE-> c_decrypt. Click on send to see the response
Want more? Join the Visa Developer Community to get alerts on the latest tutorials, guides and new developer resources. Stay tuned for more in the series.
Hello,
Thanks for provide the How to test MLE on Postman
I am using this project to generate a encrypt payload to use in this API: https://sandbox.api.visa.com/universal/core/cards
because I need the vCardID to use in this API: https://sandbox.api.visa.com/inapp/provisioning/cardData/samsungPay
To get the right data to send to the Samsung Pay SDK, I am working in a project which I need to crate a button in my app and call the Samsung Say Adk to AddCard to the wallet but I need this payload first from VISA because my client use VISA cards.
I am getting the same error that I already see here in the posts:
paulocesar@Paulos-Laptop postman % node index.js
Running!
/Users/paulocesar/Downloads/postman/node_modules/node-jose/lib/jwe/decrypt.js:176
reject(new Error("no key found"));
this error only happens when I call the decrypt endpoint in POSTMAN for the encrypt data is working fine 🙂
OK, I am attaching my project and also my keys here for you check if everything in fine I added the files in the root of the project to make sure that I am not missing something but still doesn't work
Also I attached the postman request for you check. also added the screenshot of "hellowolrd" for you see that everything is working fine with my credentials added in postman config (certificates and user/pass in Basic Auth)
Could you help me on that please?
Thank you
