Quickstart Overview
This Quickstart guides you through the key steps for integrating your application with Payvala. It helps you understand the integration process, identify the requirements, and follow the right path from initial setup to production.
Start by understanding the Payvala integration that matches your use case, then get the required access, build and test your integration, and complete the necessary steps before moving to production.
Discover
01Understand the available Payvala integrations and identify the product and APIs that match your business requirements.
Get Access
02Contact the Payvala team to request the required developer access and integration credentials for your project.
Build & Test
03Configure your integration, implement the required APIs, and test your requests and responses in the appropriate environment.
Go Live
04Complete the required integration checks and production-readiness steps before moving your validated integration to production.
Explore Payvala Services & APIs
Payvala provides four core products for different integration needs. Explore each product to understand its purpose, capabilities, and how it can support your integration.
Developer Portal
The developer-facing layer of Payvala, where you manage access, credentials, and documentation for your integration.
- Developer account and access management
- Access to integration documentation
- Entry point to Payvala's other products
Any developer integrating with Payvala.
More DetailsPartner APIs
APIs designed for partner organizations that connect their systems to Payvala.
- Partner-level integration operations
- Access scoped to a partner relationship with Payvala
Partner organizations and businesses integrating at the partner level.
More DetailsRelay
Connectivity capabilities for passing data and events between systems and Payvala.
- System and service connectivity
- Message or event relay between connected systems
Developers who need to connect existing systems or services to Payvala.
More DetailsPayment
Payment processing capabilities for applications that need to accept, process, or manage transactions.
- Payment transaction processing
- Transaction status and result handling
Applications and businesses that need payment processing.
More DetailsGet Payvala Access
Payvala does not provide a self-service account signup process. To get access to Payvala products, APIs, and integration resources, contact the Payvala team and share your requirements.
The Payvala team will guide you through the required onboarding and access process based on your integration needs.
Contact Payvala
Reach out to the Payvala team through the contact form or email support@payvala.com.
Share Your Requirements
Provide information about your organization, integration requirements, and the Payvala products or APIs you want to use.
Complete Onboarding
Work with the Payvala team to complete the required onboarding and access process.
Receive Access
Once the required process is completed, the Payvala team will provide the access and credentials required for your integration.
Integration Journey
This journey explains the main steps for getting started with Payvala and connecting your application or business process with Payvala services. Whether you are a technical team member or a business user, these steps help you understand what happens from the first conversation with Payvala to using the integration in production.
Understand Your Requirements
01Identify what you want to achieve with Payvala and what your application or business needs.
Choose a Payvala Product
02Explore the available Payvala products and choose the one that best matches your requirements.
Contact Payvala
03Contact the Payvala team to discuss your requirements and learn about the access and information needed to get started.
Complete Onboarding
04Work with the Payvala team to complete the required onboarding process and set up your access.
Login
05Use the credentials provided by Payvala to log in and access the resources available to you.
Access APIs & Resources
06Access the APIs, documentation, credentials, and other resources needed for your selected Payvala product.
Understand the Documentation
07Review the available guides and API information to understand how Payvala can be connected with your application or process.
Build & Test
08Connect your application with Payvala and test the integration to make sure everything works as expected.
Review & Validate
09Check that the integration works correctly, handles different situations properly, and meets your requirements.
Go Live
10Once everything is ready, move the validated integration to the production environment and start using Payvala.
Environments
Use the environment that matches the current stage of your integration. Complete development and testing in the appropriate non-production environment before production use.
Do not use production credentials or production endpoints for development and testing.
Development
Used during application development and internal integration work.
Sandbox
Used for integration testing and developer validation without relying on production operations.
Production
Used for approved live platform operations after the integration is ready for production.
Authentication
Payvala API requests require authentication to verify that your application has permission to access Payvala services.
Your integration credentials are provided for the environment you are working with. Keep these credentials secure and never expose them in client-side code, public repositories, or application logs.
For detailed authentication requirements, credential usage, and API request examples, refer to the Authentication guide.
First API Request
Once you have access and authentication configured, you can make your first API request. Use the API documentation and the endpoint provided for your integration and environment.
Choose an API
Select the API operation that matches your integration requirement.
Prepare the Request
Prepare the request using the required method, endpoint, headers, parameters, and request body.
Add Authenticate
Include the authentication information provided for your integration and environment.
Send the Request
Send the request from your application or API testing tool to the appropriate Payvala environment.
Check the Response
Review the response status and data returned by the API.
Handle Result
Process the response according to the API documentation and your integration requirements.
Use the API documentation and environment-specific access provided by Payvala to obtain the endpoint, authentication details, request format, and response information required for your integration.
Webhooks
Webhooks let Payvala notify your application when relevant events occur, instead of requiring your application to continuously check for updates.
Where supported for your integration, configure a webhook endpoint so your application can process events as they happen.
Production Readiness
Move to Production only after your integration has been implemented, tested, and validated in the required environments.
Before going live, review the following checklist to make sure your application, authentication, API integration, security, and production configuration are ready.
Integration completed
Your application implements the required Payvala APIs and integration functionality.
Authentication verified
Authentication has been configured and verified using the credentials required for your integration.
API requests tested
Requests and responses have been validated in sandbox.
Error handling implemented
Your application can handle API errors and unexpected responses according to the documented API behavior.
Credentials secured
Production credentials are stored securely and separated from non-production credentials.
Production configuration reviewed
Production endpoints and environment configuration have been reviewed.
Final Validation Completed
The integration has been fully tested and validated before being moved to the Production environment.
Troubleshooting
If your Payvala integration does not behave as expected, start by checking the common issues below before moving to detailed troubleshooting.
Authentication Not Working
Check that the required credentials are correct and match the environment you are using.
Request Failing
Check the API endpoint, HTTP method, headers, parameters, and request body against the API documentation.
Unexpected Response
Check the HTTP status code and response details to understand whether the request was successful or returned an error.
Environment Issue
Make sure your application is using the correct environment, endpoint, credentials, and configuration.