Introduction

Welcome to the Batchmates API documentation. Batchmates is a platform that facilitates educational funding through campaigns, donations, and institutional partnerships.

Getting Started

The Batchmates API is organized around REST principles. Our API has predictable resource-oriented URLs, accepts form-encoded or JSON request bodies, returns JSON responses, and uses standard HTTP response codes and authentication.

Base URL

https://batchmates-v2.revlv.com/api/v1/

Key Features

• Campaign Management - Create and manage fundraising campaigns
• Donations - Process one-time and recurring donations
• Institution Support - Multi-institution architecture with role-based access
• Scholar Profiles - Manage beneficiary information and family backgrounds
• Payment Integration - Support for Maya and Magpie payment gateways
• Webhook Notifications - Real-time payment status updates

Authentication

Batchmates supports two authentication methods:

• JWT Tokens - For mobile applications and stateless clients
• Session-based - For web admin interfaces

See Authentication for details.

Rate Limiting

API requests are rate-limited to ensure service stability:

• Login endpoints: 10 requests per minute
• General API: 120 requests per minute

See Rate Limiting for more information.

Response Format

All API responses follow a consistent JSON structure:

{
  "success": true,
  "data": { /* response data */ },
  "message": "Operation completed successfully"
}

Error responses include detailed information:

{
  "success": false,
  "message": "Validation failed",
  "errors": {
    "email": ["The email field is required."]
  }
}

Pagination

List endpoints return paginated results with metadata:

{
  "success": true,
  "data": {
    "data": [ /* items */ ],
    "current_page": 1,
    "per_page": 15,
    "total": 150,
    "last_page": 10
  }
}

Quick Links

Support

Need help? Contact us:

• Email: support@batchmates.com
• Documentation: https://docs.batchmates.com
• Status: https://status.batchmates.com