Welcome to Sosta Pay Documentation Last updated: 2024-06-06
Sosta Pay is a secure and reliable payment automation solution designed to transform your personal account into a fully functional payment gateway. This comprehensive documentation provides everything you need to integrate our API into your website and start accepting payments from customers worldwide.
Quick Start
Get started in 3 easy steps:
Obtain your API credentials from the dashboard
Choose your preferred integration method
Test in sandbox mode before going live
API Documentation
Our RESTful API provides a seamless and secure integration experience for receiving payments through multiple channels including card systems, mobile financial services, and digital wallets.
API Introduction
The Sosta Pay Payment Gateway enables merchants to securely receive payments by temporarily redirecting customers to our secure payment portal. After successful payment completion, customers are redirected back to your website, and you receive instant payment notifications with complete transaction details.
Technical Requirements: Working knowledge of HTML forms or cURL is required for integration. Test accounts are available for development purposes.
API Operation
We support REST APIs in both sandbox (testing) and production environments. Use the sandbox environment for development and testing, then switch to production when ready to go live.
Live API Endpoint (Payment Creation): https://pay.sostapay.xyz/api/payment/create
Important: Your server must support cURL for API integration. For HTML form submissions, please refer to our alternative integration methods.
Parameter Details
Payment Creation Parameters
Required parameters to initialize the payment process:
Field Name
Description
Required
Example Values
cus_name
Customer's full name
Yes
John Doe
cus_email
Customer's email address
Yes
john@example.com
amount
Total payment amount (omit trailing zeros for whole numbers)
Yes
10, 10.50, or 10.6
success_url
URL to redirect customer after successful payment
Yes
https://yourdomain.com/success.php
cancel_url
URL to redirect customer if payment is cancelled
Yes
https://yourdomain.com/cancel.php
meta_data
Additional JSON-formatted data for custom requirements
Optional
{"order_id": "12345", "product": "Premium Plan"}
Payment Verification Parameters
Parameters required for payment verification:
Field Name
Description
Required
Example Values
transaction_id
Transaction ID received from success URL callback
Yes
OVKPXW165414
API Headers Configuration
Header Name
Value
Source
Content-Type
application/json
Fixed Value
API-KEY
Your unique API key
API Credentials Section
SECRET-KEY
Your secret key
API Credentials Section
BRAND-KEY
Your brand identifier key
Brands Management Section
Integration Guide
Seamlessly integrate our payment gateway into your PHP, Laravel, WordPress, WooCommerce, and other platforms. Choose from direct API integration or Sosta Pay modules for faster implementation.
Payment Link (where customers will complete their payment)
Error Response
status
bool
FALSE
message
String
Message associated with the error response
Completing Payment Page task you will be redirected to success or cancel page based on transaction status with the following Query Parameters: yourdomain.com/(success/cancel)?transactionId=******&paymentMethod=***&paymentAmount=**.**&paymentFee=**.**&status=pending or success or failed
Accelerate your integration with our professionally developed modules for popular platforms. Each module comes with easy installation guides and full support.
WordPress Plugin v2.1
Integrate our payment gateway seamlessly into your WordPress website. Perfect for e-commerce stores, membership sites, donation platforms, and any WordPress-based business.
Integrate our payment gateway seamlessly into your WHMCS billing system. Manage invoices, accept payments, and track transactions effortlessly with our professional module.
Enhance your social media marketing panel with our specialized payment gateway module. Streamline payment processing and provide a seamless experience for your clients.
Integrate payment functionality into your Sketchware mobile applications with our specialized SWB module. Perfect for developers creating Android apps with payment features.
Seamlessly integrate payment functionality into your Laravel-based topup or recharge applications. Perfect for telecom, gaming, or digital service platforms.
Looking for Custom Development Solutions? Connect with Developer HMS for professional application and website development services. With extensive experience in payment gateway integration and platform development, we provide tailored solutions to meet your specific requirements.