https://github.com/abdullahwins/smart_pathshala_payment_docs

This documentation covers the Smart Paathshala Payment API, which provides integration with multiple mobile financial services in Bangladesh, including bKash and Rocket. The API allows educational institutions to manage student bill generation and payment processing through USSD (Unstructured Supplementary Service Data) channels.
https://github.com/abdullahwins/smart_pathshala_payment_docs

bkash inapp-billing nagad payment rocket ussd

Last synced: 3 months ago
JSON representation

Host: GitHub
URL: https://github.com/abdullahwins/smart_pathshala_payment_docs
Owner: AbdullahWins
Created: 2025-05-29T08:46:24.000Z (about 1 year ago)
Default Branch: main
Last Pushed: 2025-07-20T05:03:49.000Z (11 months ago)
Last Synced: 2025-10-09T02:34:07.759Z (9 months ago)
Topics: bkash, inapp-billing, nagad, payment, rocket, ussd
Homepage: https://www.smartpathshalabd.com
Size: 2.03 MB
Stars: 0
Watchers: 0
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md

Awesome Lists containing this project

README

# Smart Paathshala Payment API Documentation

## Overview

This documentation covers the Smart Paathshala Payment API, which provides integration with multiple mobile financial services in Bangladesh, including bKash, Rocket, Tap, and Cellfin. The API allows educational institutions to manage student bill generation and payment processing through USSD (Unstructured Supplementary Service Data) channels.

## Base URL

```
https://backend.smartpathshalabd.com/api/v1
```

## Available Payment Providers

bKash

Bangladesh's leading mobile financial service

Rocket

Mobile banking service by Dutch-Bangla Bank

Tap

Digital payment solution for Bangladesh

Cellfin

Mobile financial service for Bangladesh

## Authentication

All API endpoints are secured with Basic Authentication. Each payment provider has its own set of credentials:

- **bKash**: Requires specific bKash Basic Auth credentials
- **Rocket**: Requires specific Rocket Basic Auth credentials
- **Tap**: Requires specific Tap Basic Auth credentials
- **Cellfin**: Requires specific Cellfin Basic Auth credentials

Basic Authentication credentials should be included in the headers of each request.

## Common Request Format

All endpoints accept form-data POST requests with a `data` parameter containing a JSON string with the required fields.

```http
POST /api/v1/invoices/ussd/{provider}/{endpoint} HTTP/1.1
Host: backend.smartpathshalabd.com
Authorization: Basic [encoded credentials]
Content-Type: multipart/form-data

data={
"institute_id": "SPID9",
"student_username": "SPID9",
...other parameters...
}
```

## Common Parameters

Most endpoints require the following parameters:

| Parameter | Description |
|-----------|-------------|
| `institute_id` | The unique identifier for the educational institution (e.g., "SPID9") |
| `student_username` | The unique identifier for the student (e.g., "SPID9") |

## Environment Variables

The API collection uses the following environment variables:

| Variable | Description |
|----------|-------------|
| `baseURL` | The base URL for the API |
| `basicAuthUsernameBkash` | Username for bKash Basic Authentication |
| `basicAuthPasswordBkash` | Password for bKash Basic Authentication |
| `basicAuthUsernameRocket` | Username for Rocket Basic Authentication |
| `basicAuthPasswordRocket` | Password for Rocket Basic Authentication |
| `basicAuthUsernameTap` | Username for Tap Basic Authentication |
| `basicAuthPasswordTap` | Password for Tap Basic Authentication |
| `basicAuthUsernameCellfin` | Username for Cellfin Basic Authentication |
| `basicAuthPasswordCellfin` | Password for Cellfin Basic Authentication |

## API Workflow

The Smart Paathshala Payment API follows this general workflow:

1. **Get Bill Information**: Retrieve bill details for a specific student
2. **Process Payment**: Record payment made through the mobile financial service
3. **Verify Payment Status**: Confirm if the payment was successful

## Additional Resources

bKash
Documentation

Rocket
Documentation

Tap
Documentation

Cellfin
Documentation

## Postman Collections

For testing the API endpoints, you can use the Postman collections provided in this repository:

- [bKash Postman Collection](./bkash/Bkash%20-%20Smart%20Paathshala%20Payment.postman_collection.json)
- [Rocket Postman Collection](./rocket/Rocket%20-%20Smart%20Paathshala%20Payment.postman_collection.json)
- [Tap Postman Collection](./tap/Tap%20-%20Smart%20Paathshala%20Payment.postman_collection.json)
- [Cellfin Postman Collection](./cellfin/Cellfin%20-%20Smart%20Paathshala%20Payment.postman_collection.json)

## Contact Information

For questions, support, or further information regarding this API documentation, please contact: