Table Of Contents
Overview
In the realm of Payment API integration, understanding and customizing response variables can significantly enhance the flexibility and utility of your system. This article will provide insights into configuring the response variables, allowing integrators to tailor their API responses to specific needs.
Configure the Variables
To customize your Payment API response variables, follow these simple steps:
-
Access the Merchant Control Panel:
- Log in to the Merchant Control Panel and navigate to "Settings" > "API Configuration."
-
Navigate the API Configuration Screen:
- Upon reaching the "API Configuration" screen, you'll encounter two lists of variables.
- Left List: Contains all available variables that can potentially be included in the API response.
- Right List: Encompasses currently selected variables that will be part of the API response.
- The default variables are displayed in blue (refer to the image below).
- Upon reaching the "API Configuration" screen, you'll encounter two lists of variables.
-
Add New Variables:
- To augment the variables in your API response, simply drag the desired variables from the left column to the right column.
- Choose the variables that align with your integration needs.
-
Save Changes:
- After selecting the desired variables, solidify your choices by clicking "Save" at the bottom of the screen.
To add new variables to the response, you will need to drag the variables from the left column over to right column. Once you have selected all of the variables that you would like added to the response, you will need to save the changes by selecting " Save" at the bottom of the screen.
Additional Tips
-
Consider Integrator Needs:
- Evaluate the specific requirements of your integration. What data points are crucial for your system to handle effectively?
-
Default Variables:
- The API response, by default, contains only a limited set of variables. These defaults are depicted in blue on the configuration screen.
- Testing:
- After configuring your response variables, conduct thorough testing to ensure that the desired variables are included in the API response.
Conclusion
Configuring Payment API response variables is a pivotal step in tailoring your integration to meet the unique demands of your system. By selecting and customizing variables, you not only enhance the richness of the data returned but also optimize your API to seamlessly integrate with your application. Keep in mind the specific needs of your integrators and stay vigilant in adapting your configuration to evolving requirements. With these steps, you are poised to elevate the efficiency and functionality of your Payment API integration.