Wipays API Reference¶
Welcome to the Wipays API! You can use our API to receive payments from your customers. You will be able to create payment links, and receive payment notifications.
This API documentation is a part of Wipays. Feel free to contact us for any questions or feedback.
Getting Started¶
To use the Wipays API, you'll need:
- API Keys: public_keyandsecret_keyprovided by your support manager
- Base URL: https://{{DOMAIN}}/
- Content-Type: All requests should use application/json
Security Notice
You should keep both keys secure and never expose them to the public.
API Overview¶
The Wipays API provides two main payment flows:
HPP (Hosted Payment Page) Flow¶
- Initiate Payment - Create payment links that redirect customers to Wipays checkout pages
H2H (Host-to-Host) Payment Flow¶
- H2H Overview - Direct payment processing without redirects
- Initiate H2H Payment - Receive payment credentials for required country and payment method
- Submit Proof - Handle manual payment verification
- Check Status - Query payment status
Instant Payment Notifications¶
- IPN (Instant Payment Notifications) - Receive real-time payment status updates for both HPP and H2H flows
Next Steps¶
- Set up Authentication - Configure your API keys
- Choose Your Flow:
- For hosted checkout: HPP Payment
- For direct integration: H2H Payments
- Handle Notifications: Set up IPN