Payefy Documentation
Welcome to the Payefy Developer Documentation. Here you will learn how to build amazing campus payment experiences, automate student clearances, and integrate secure ticketing using the Payefy API.
Quick start
Accept Dues
Collect faculty dues and levies securely from cards and bank transfers.
Identify Students
Verify matriculation numbers and faculties against the central registry.
Automate Clearance
Use webhooks to instantly update student clearance status upon payment.
API Reference
Explore all endpoints, parameters, and response objects in detail.
Accept a payment
Here's how to use the Payefy API to initialize a dues payment.
Before you begin
Authenticate all Payefy API calls using your secret keys. Ensure you are using your sk_test_ key for development.
# Set your secret key
export PAYEFY_SECRET_KEY="sk_test_a8f92bd3..."
# All requests must include this in the header:
# Authorization: Bearer YOUR_SECRET_KEYExplore demos
We've put together simple open-source projects to demonstrate how to use the Payefy API for various campus services.
Faculty Dues Portal
payefy-oss/sample-dues-portal
APIs Used
Initialize Payment
Verify Identity
Event Ticketing App
payefy-oss/sample-event-ticket
APIs Used
Accept Payments
Webhook Deliveries