Easebuzz

https://docs.easebuzz.in/
Admin
Easebuzz is a comprehensive payment gateway and fintech platform providing payment processing,...
Tokens:318,302
Snippets:2,089
Trust Score:10
Update:2 months ago
Show doc for...
Tokens:
Raw
### cURL Request Examples

Source: https://docs.easebuzz.in/docs/9-verification-suite/ju38hn7yrs3fm-retrieve-by-id-pan-to-masked-aadhaar

Examples of how to perform the GET request using cURL.

```shell
curl --location 'https://api.easebuzz.in/verify/v1/masked-aadhaar-via-pan/devvXXXXb0a7f0d/?key=77AXX95E' \
--header 'Authorization: SHA512[Key|UUID|Salt]'
```

```shell
curl --request GET \
  --url https://api.easebuzz.in/verify/v1/masked-aadhaar-via-pan/{uuid}/ \
  --header 'Accept: application/json' \
  --header 'Authorization: '
```

--------------------------------

### Get KYC Profile URL Response Example

Source: https://docs.easebuzz.in/docs/neobanking/f175b9f43dd78-get-kyc-profile-url

Example JSON response returned upon a successful request.

```json
{
  "success": true,
  "data": {
    "kyc_url": "https://kyc.easebuzz.in/c63613442d9e7c6982042b04244bbf71c40d6c12?access_key=4050122184129308892563646557575685973627498238941673355963654067162285215403909665228074170537371160"
  }
}
```

--------------------------------

### List Installment Discounts Response Example

Source: https://docs.easebuzz.in/docs/feesbuzz/beeaf78ca3e87-list-installment-discounts

Example JSON response returned upon a successful request, containing a list of discount objects.

```json
1
{
2
  "success": true,
3
  "data": [
4
    {
5
      "id": 81,
6
      "discount_name": "discount 003",
7
      "actual_amount": 10,
8
      "payable_amount": 5,
9
      "expiry_date": "2021-12-30",
10
      "structure": {
11
        "id": 656
12
      }
13
    }
14
  ]
15
}
```

--------------------------------

### Create Installment Response Example

Source: https://docs.easebuzz.in/docs/feesbuzz/637ac6220cb31-create-installment

Successful response format returned by the API.

```json
{
  "status": true,
  "data": "Installment Created"
}
```

--------------------------------

### Response Example

Source: https://docs.easebuzz.in/docs/payment-gateway/da6d73ae6acb9-auto-debit-auth-cancel-v2

Example of the successful response returned by the API.

```json
{
  "status": true,
  "message": "Mandate cancelled successfully",
  "data": {
    "customer_authentication_id": "NPCITESTsmsemail",
    "easebuzz_id": "D221126775VNDL",
    "mandate_type": "Digital"
  }
}
```

--------------------------------

### Install CapacitorJS SDK

Source: https://docs.easebuzz.in/docs/payment-gateway/9xm7b9we5tvl3-capacitor-js

Command to install the SDK into your application using npm pack.

```bash
npm install $(npm pack <Path of Capacitor SDK>/easebuzz-capacitorjs-sdk | tail -1)
```

--------------------------------

### cURL Request Example

Source: https://docs.easebuzz.in/docs/payment-gateway/0f9d0a39bcfeb-send-whatsapp-message-for-link

Example of how to invoke the API using cURL.

```bash
curl --request POST \
  --url https://testdashboard.easebuzz.in/easycollect/v1/send_whatsapp_msg \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{
  "whatsapp_template_name": "Whatsapp Template",
  "key": "XXXXX",
  "payment_url": "https://pay.easebuzz.in/easy_collect/bfec39xxxxx4a6cc01c77a8c4",
  "msg_type": "whatsapp",
  "hash": "0ea09bed0f905d82d34f5f23a7c71f8513cacf4a7fcd16c7d356a5ca2a8b30c032009c7840b6162e5cb90bf0f94a6d7ab8cac4875022a24a487f9154f430b707"
}'
```

--------------------------------

### cURL Request Example

Source: https://docs.easebuzz.in/docs/9-verification-suite/3b31968c74d38-verify-pan-to-masked-aadhaar

Example of how to perform the verification request using cURL.

```bash
curl --request POST \
  --url https://api.easebuzz.in/verify/v1/masked-aadhaar-via-pan/ \
  --header 'Accept: application/json' \
  --header 'Authorization: ' \
  --header 'Content-Type: application/json' \
  --header 'VRS-API-KEY: ' \
  --data '{
  "key": "<merchant_key>",
  "pan_number": "GQBXXXX0C",
  "unique_request_number": "RYRXXX565",
  "consent": true
}'
```

--------------------------------

### Initialize Easebuzz Class

Source: https://docs.easebuzz.in/docs/payment-gateway/j85z7nmmwdcwy-net

Create an instance of the Easebuzz class by providing the salt, key, and environment settings.

```csharp
string salt = "XXXXXX";
string Key = "XXXXXX";
string env = "test";	// test for testing env and prod for production use wisely
Easebuzz t = new Easebuzz(salt, Key, env);
```

--------------------------------

### Generate Installment cURL Request

Source: https://docs.easebuzz.in/docs/feesbuzz/bf9e3dd525e28-generate-installment

Example cURL command to trigger the installment generation endpoint.

```bash
curl --request POST \
  --url https://edu.easebuzz.in/api/fees/v1/installment \
  --header 'AUTHHASH: ' \
  --header 'AUTHID: ' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{
  "installment_ids": [
    14036
  ]
}'
```

--------------------------------

### Install Easebuzz CapacitorJS SDK

Source: https://docs.easebuzz.in/docs/payment-gateway/x5u3dm788xdry-capacitor-js

Execute this command in your terminal to add the SDK to your project.

```bash
npm i easebuzz-capacitorjs-sdk
```

--------------------------------

### Run Magento Setup Commands

Source: https://docs.easebuzz.in/docs/payment-gateway/249mrgk0rnjkq-magento-2-3-x

Execute these commands in the terminal after placing the plugin files to update the system and compile dependency injection.

```bash
php bin/magento setup:upgrade
```

```bash
php bin/magento setup:di:compile
```

--------------------------------

### Installments List Response Example

Source: https://docs.easebuzz.in/docs/feesbuzz/ba2a21975951a-installments-list

Example of a successful API response returning an empty data array.

```json
1
{
2
  "success": true,
3
  "data": []
4
}
```

--------------------------------

### Launch Payment Flow

Source: https://docs.easebuzz.in/docs/payment-gateway/qvkrbbj8zm0px-android

Use the PWECheckoutActivity to initiate the payment process by passing the access key and environment mode.

```APIDOC
## Start PWECheckoutActivity

### Description
Initiates the payment flow by launching the PWECheckoutActivity with the required access key and environment mode.

### Parameters
- **access_key** (String) - Required - The access key generated by the Initiate Payment API.
- **pay_mode** (String) - Required - The environment mode, either "test" or "production".

### Request Example
```java
Intent intentProceed = new Intent(MerchantAppActivity.this, PWECheckoutActivity.class);
intentProceed.setFlags(Intent.FLAG_ACTIVITY_REORDER_TO_FRONT);
intentProceed.putExtra("access_key", "YOUR_ACCESS_KEY");
intentProceed.putExtra("pay_mode", "test");
pweActivityResultLauncher.launch(intentProceed);
```
```

--------------------------------

### Delete Installment cURL Request

Source: https://docs.easebuzz.in/docs/feesbuzz/5c21cbe62bdf9-delete-installment

Example cURL command to perform the DELETE request to the installment endpoint.

```bash
curl --request DELETE \
  --url https://edu.easebuzz.in/api/fees/v1/installment/{id}/ \
  --header 'AUTHHASH: ' \
  --header 'AUTHID: ' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{
  "fee_structure_id": 667
}'
```

--------------------------------

### Update Installment cURL Request

Source: https://docs.easebuzz.in/docs/feesbuzz/4b700238e4e25-update-installment

Example cURL command to perform the PUT request for updating an installment.

```bash
curl --request PUT \
  --url https://edu.easebuzz.in/api/fees/v1/installment/{id}/ \
  --header 'AUTHHASH: ' \
  --header 'AUTHID: ' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{
  "fee_structure_id": "123",
  "start_date": "2021-11-01",
  "installment_amount": 10,
  "installment_name": "Installment 1",
  "note": "",
  "due_date": "2021-11-30",
  "expire_date": "2021-12-31",
  "split_bank_info": 1,
  "penalty_type": false,
  "penalty_frequency": "0",
  "penalty_amount": 0,
  "is_mandatory": false,
  "group": [
    "Installments"
  ]
}'
```

--------------------------------

### Start Payment Activity

Source: https://docs.easebuzz.in/docs/payment-gateway/64nm87cwe27sl-android

Initiates the payment flow by launching the PWECouponsActivity with the required access key and environment mode.

```APIDOC
## Start Payment Activity

### Description
Launches the PWECouponsActivity to initiate the payment process. This requires an access key obtained from the Initiate Payment API and the environment mode.

### Parameters
- **access_key** (String) - Required - The access key generated by the Initiate Payment API.
- **pay_mode** (String) - Required - The environment mode, either "test" or "production".

### Usage Example
```java
Intent intentProceed = new Intent(MerchantAppActivity.this, PWECouponsActivity.class);
intentProceed.setFlags(Intent.FLAG_ACTIVITY_REORDER_TO_FRONT);
intentProceed.putExtra("access_key", "Access key generated by the Initiate Payment API");
intentProceed.putExtra("pay_mode", "test");
pweActivityResultLauncher.launch(intentProceed);
```
```

--------------------------------

### Configure Credentials

Source: https://docs.easebuzz.in/docs/payment-gateway/jl5acj6genz7q-python

Set the merchant key, salt, and environment variables.

```python
MERCHANT_KEY = "XXXXXXXXXXX";
SALT = "XXXXXXXXXX";         
ENV = "test";   # use "test" for test enviroment or "prod" for production enviroment
```

--------------------------------

### Student Installment List Response Example

Source: https://docs.easebuzz.in/docs/feesbuzz/afa19f6c6455a-student-installment-list

Example JSON response returned by the API upon a successful request.

```json
1
{
2
  "success": true,
3
  "data": [
4
    {
5
      "id": 73,
6
      "student": {
7
        "id": 17,
8
        "prn": "111",
9
        "name": "john",
10
        "email": "john@gmail.com",
11
        "phone_number": "9958091819",
12
        "password": "719855e8f4ebd94341277b0b0d50b75c5187133f",
13
        "course_name": "testing",
14
        "batch_name": "test batch",
15
        "fees_structure": "Fees",
16
        "degree": null,
17
        "semester": null,
18
        "father_name": "Jim",
19
        "address": "Pune",
20
        "is_active": true
21
      },
22
      "start_date": "2017-10-10T05:30:00+05:30",
23
      "amount_paid": null,
24
      "installment_amount": 1,
25
      "installment_name": "test sem1",
26
      "note": "test",
27
      "due_date": "2017-10-31T05:30:00+05:30",
28
      "expire_date": "2017-11-01T05:30:00+05:30",
29
      "penalty_frequency": 1,
30
      "penalty_amount": 1,
31
      "penalty_paid": null,
32
      "is_paid": false,
33
      "payment": null,
34
      "is_optional": false,
35
      "split_bank_info_id": null,
36
      "split_bank_info": null,
37
      "is_mandatory": false,
38
      "group": null
39
    }
40
  ]
41
}
```

--------------------------------

### Fetch Dependencies

Source: https://docs.easebuzz.in/docs/payment-gateway/o8mkqq9pbl4el-flutter

Run this command after adding the dependency to download the package.

```bash
Flutter pub get
```

--------------------------------

### Get Easycollect Link Request

Source: https://docs.easebuzz.in/docs/payment-gateway/52393c651d9d1-get-easycollect-link

Example of a GET request to retrieve Easycollect link details using cURL.

```shell
curl --request GET \
  --url 'https://testdashboard.easebuzz.in/easycollect/v1/get?key=XXXXXXXX&merchant_txn=EBZTestTxn0003&hash=6408cde54bexxxxxx2f1713a7a9fbbd41c797384af3f0faaf9814b8643d8f9e46e04d860c3a024af65dc18847307ed13' \
  --header 'Accept: application/json'
```

--------------------------------

### Define startPayment method

Source: https://docs.easebuzz.in/docs/payment-gateway/7pno7lhpkyt0f-flutter

Implement the logic to parse arguments and launch the PWECouponsActivity for payment processing.

```java

private void startPayment(Object arguments) {
        try {
            Gson gson = new Gson();
            JSONObject parameters = new JSONObject(gson.toJson(arguments));
            Intent intentProceed = new Intent(getActivity(),PWECouponsActivity.class);
            intentProceed.setFlags(Intent.FLAG_ACTIVITY_REORDER_TO_FRONT);
            Iterator<?> keys = parameters.keys();
            while(keys.hasNext() ) {
            String value = "";
            String key = (String) keys.next();
            value = parameters.optString(key);
            if (key.equals("amount")){
            Double amount = new Double(parameters.optString("amount"));
            intentProceed.putExtra(key,amount);
            } else {
                intentProceed.putExtra(key,value);
            }
}
startActivityForResult(intentProceed,PWEStaticDataModel.PWE_REQUEST_CODE );
        }catch (Exception e) {
            start_payment=true;
            Map<String, Object> error_map = new HashMap<>();
            Map<String, Object> error_desc_map = new HashMap<>();
            String error_desc = "exception occured:"+e.getMessage();
            error_desc_map.put("error","Exception");
            error_desc_map.put("error_msg",error_desc);
            error_map.put("result",PWEStaticDataModel.TXN_FAILED_CODE);
            error_map.put("payment_response",error_desc_map);
            channel_result.success(error_map);
        }
    }
 
```

--------------------------------

### Create Installment cURL Request

Source: https://docs.easebuzz.in/docs/feesbuzz/637ac6220cb31-create-installment

Example cURL command to perform the POST request to the installment creation endpoint.

```bash
curl --request POST \
  --url https://edu.easebuzz.in/api/fees/v1/student/installments/ \
  --header 'AUTHHASH: ' \
  --header 'AUTHID: ' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{
  "student_id": 12345,
  "start_date": "2020-05-20",
  "installment_amount": 200,
  "installment_name": "Installment 1",
  "note": "",
  "due_date": "2020-05-20",
  "expire_date": "2020-05-20",
  "penalty_frequency": "0",
  "penalty_amount": "0",
  "penalty_type": false,
  "is_optional": false,
  "split_bank_info_id": null,
  "is_mandatory": false,
  "group": null,
  "fee_structure_id": 123
}'
```

--------------------------------

### Launch Payment Activity

Source: https://docs.easebuzz.in/docs/payment-gateway/qvkrbbj8zm0px-android

Start the PWECheckoutActivity by passing the access key and payment mode via an Intent.

```java
Intent intentProceed = new Intent(MerchantAppActivity.this,  PWECheckoutActivity.class);
intentProceed.setFlags(Intent.FLAG_ACTIVITY_REORDER_TO_FRONT); // This is mandatory flag
intentProceed.putExtra("access_key","Access key generated by the Initiate Payment API");
intentProceed.putExtra("pay_mode","This will either be "test" or "production"");
pweActivityResultLauncher.launch(intentProceed);
```

--------------------------------

### Response Example

Source: https://docs.easebuzz.in/docs/8-autocollect-recurring-payment/2ne7miemvz1yo-edit-scheduler-e-nach-upi-si

A sample JSON response returned after a successful scheduler update.

```json
1
{
2
  "id": "devschXXXXc37c0ca97",
3
  "status": "active",
4
  "frequency": "Daily",
5
  "debit_amount": 1,
6
  "start_date": "2026-01-30",
7
  "end_date": "2026-02-28",
8
  "number_of_debits": 5,
9
  "number_of_executed_debits": 0,
10
  "created_at": "2026-01-30 08:56:14",
11
  "mandate_id": "UM26XXX0AAD",
12
  "mandate_transaction_id": "DR_76X51XX6",
13
  "scheduler_request_id": "1",
14
  "merchant_request_number": "suc9XX015",
15
  "error_meta": {}
16
}
```

--------------------------------

### Optional Installments List Success Response

Source: https://docs.easebuzz.in/docs/feesbuzz/25bbdc5a40258-optional-installments-list

Example of a successful JSON response containing an array of installment objects.

```json
1
{
2
  "success": true,
3
  "data": [
4
    {
5
      "id": 45,
6
      "split_bank_info": null,
7
      "group": null,
8
      "installment_amount": 500,
9
      "installment_name": "Installment 1",
10
      "note": "",
11
      "start_date": "2020-06-03T00:00:00",
12
      "due_date": "2021-01-25T05:30:00",
13
      "expire_date": "2021-07-26T05:30:00",
14
      "penalty_frequency": 0,
15
      "penalty_type": false,
16
      "penalty_amount": 0,
17
      "is_mandatory": false,
18
      "unique_name": "Inst 1"
19
    }
20
  ]
21
}
```

--------------------------------

### Create Student Response Example

Source: https://docs.easebuzz.in/docs/feesbuzz/207a30aa38ca5-create-student

Sample JSON response returned upon successful student creation.

```json
1
{
2
  "prn": "10111",
3
  "name": "Nikhil",
4
  "email": "dummy@easebuzz.in",
5
  "father_name": "sanjay",
6
  "phone_number": "9999999999",
7
  "password": "XXXXXX",
8
  "batch_id": 123,
9
  "fees_structure": 321,
10
  "batch": {
11
    "id": 123
12
  },
13
  "id": 26946,
14
  "error_status": false,
15
  "error": "",
16
  "mobile_number": "9999999999"
17
}
```

--------------------------------

### Update Installment Discount cURL Request

Source: https://docs.easebuzz.in/docs/feesbuzz/ce6f1a02f38fe-update-discount

Example cURL command to perform the PUT request to the installment discount endpoint.

```bash
curl --request PUT \
  --url https://edu.easebuzz.in/api/fees/v1/installment_discount/{id}/ \
  --header 'AUTHHASH: ' \
  --header 'AUTHID: ' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{
  "discount_name": "Hostel Fee Discount",
  "actual_amount": 20,
  "payable_amount": 5,
  "expiry_date": "2021-12-30",
  "structure": 123,
  "description": "Hostel Fee Discount (general discount)",
  "installments": [
    12345
  ]
}'
```

--------------------------------

### POST /course

Source: https://docs.easebuzz.in/docs/feesbuzz/6e5d76015ccb3-course-ap-is

Creates a new course in the system.

```APIDOC
## POST /course

### Description
Creates a new course record.

### Method
POST

### Endpoint
https://edu.easebuzz.in/api/fees/v1/course
```

--------------------------------

### Create Optional Installment cURL Request

Source: https://docs.easebuzz.in/docs/feesbuzz/b870050831cc5-create-optional-installment

Example cURL command to perform the POST request to the optional installment API.

```bash
curl --request POST \
  --url https://edu.easebuzz.in/api/fees/v1/optional_installment/ \
  --header 'AUTHHASH: {{AUTHHASH}}' \
  --header 'AUTHID: {{AUTHID}}' \
  --header 'Accept: application/json, application/xml' \
  --header 'Content-Type: application/json' \
  --data '{
  "split_bank_info_id": "1",
  "group": null,
  "installment_amount": 500,
  "installment_name": "Installment 1",
  "note": "",
  "start_date": "2020-06-03T00:00:00+05:30",
  "due_date": "2021-01-25T05:30:00+05:30",
  "expire_date": "2021-07-26T05:30:00+05:30",
  "penalty_type": false,
  "penalty_frequency": "0",
  "penalty_amount": 0,
  "is_mandatory": false,
  "unique_name": "Inst 1"
}'
```

--------------------------------

### Create Course cURL Request

Source: https://docs.easebuzz.in/docs/feesbuzz/4668682f43b3d-create-course

Example cURL command to perform the POST request for creating a course.

```bash
curl --request POST \
  --url https://edu.easebuzz.in/api/fees/v1/course/ \
  --header 'AUTHHASH: {{AUTHHASH}}' \
  --header 'AUTHID: {{AUTHID}}' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{
  "course_institute_id": "MBA01",
  "course_name": "Master of Business Administration",
  "course_short_name": "MBA",
  "course_type": "PG",
  "course_status": true
}'
```

--------------------------------

### Update Optional Installment cURL Request

Source: https://docs.easebuzz.in/docs/feesbuzz/71a96aadb5803-update-optional-installment

Example cURL command to perform the PUT request for updating an optional installment.

```bash
curl --request PUT \
  --url https://edu.easebuzz.in/api/fees/v1/optional_installment/{id}/ \
  --header 'AUTHHASH: ' \
  --header 'AUTHID: ' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{
  "group": null,
  "split_bank_info": null,
  "installment_amount": 500,
  "installment_name": "Installment 1",
  "note": "",
  "start_date": "2020-06-03T00:00:00+05:30",
  "due_date": "2021-01-25T05:30:00+05:30",
  "expire_date": "2021-07-26T05:30:00+05:30",
  "penalty_type": false,
  "penalty_frequency": "0",
  "penalty_amount": 0,
  "is_mandatory": false,
  "unique_name": "Inst 1"
}'
```

--------------------------------

### Delete Student Installment cURL Request

Source: https://docs.easebuzz.in/docs/feesbuzz/a2052d6efb655-delete-a-student-installment

Example cURL command to perform a DELETE request to the student installment endpoint.

```bash
curl --request DELETE \
  --url https://edu.easebuzz.in/api/fees/v1/student/installments/{student_installment_id}/ \
  --header 'AUTHHASH: ' \
  --header 'AUTHID: ' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{
  "structure_id": 123,
  "is_optional": true
}'
```

--------------------------------

### cURL Request Example

Source: https://docs.easebuzz.in/docs/payment-gateway/e383e3fb60ce3-create-api

Example of how to trigger the split configuration update using a cURL command.

```bash
curl --request POST \
  --url https://dashboard.easebuzz.in/post-split/v1/create/ \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{
    "key": "N8XXXXXXXX",
    "merchant_request_id": "UMRID1",
    "easebuzz_id": "E250XXXXXXXXXX",
    "amount": "10.0",
    "description": "Split Config Update Test",
    "configuration": [
      {
        "label": "axisaccount",
        "amount": "6.6"
      },
      {
        "label": "hdfcaccount",
        "amount": "3.4"
      }
    ],
    "hash": "xxxxxxxxxxxxx"
}'
```

--------------------------------

### EasebuzzCheckout.open

Source: https://docs.easebuzz.in/docs/payment-gateway/pq6k4fyf97c9p-react-native

Initiates the payment gateway interface using the provided access key and environment mode. This method returns a Promise that resolves with the payment result or rejects on SDK errors.

```APIDOC
## EasebuzzCheckout.open(options)

### Description
Opens the Easebuzz payment gateway screen. The method requires an options object containing the access key and the environment mode.

### Parameters
- **options** (Object) - Required
  - **access_key** (String) - Required: The access key generated by the backend Initiate Payment API.
  - **pay_mode** (String) - Required: The environment mode, either "test" or "production".

### Returns
- **Promise** - Resolves with the payment response data (success or failure) or rejects with an SDK error.

### Example
```javascript
const options = {
  access_key: "555a2b009214573bd833feca997244f1721ac69d7f2b09685911bc943dcf5201",
  pay_mode: "test"
};

EasebuzzCheckout.open(options)
  .then((data) => {
    console.log("Payment Response:", data);
  })
  .catch((error) => {
    console.log("SDK Error:", error);
  });
```
```

--------------------------------

### GET /student-installment

Source: https://docs.easebuzz.in/docs/feesbuzz/tyqv1ja9sf950-student-installments-ap-is

Retrieves a list of student installments.

```APIDOC
## GET /student-installment

### Description
Retrieves a list of student installments.

### Method
GET

### Endpoint
/student-installment
```

--------------------------------

### GET /optional-installment

Source: https://docs.easebuzz.in/docs/feesbuzz/40lqwighxcv2w-optional-installments-ap-is

Retrieves a list of all optional installments.

```APIDOC
## GET /optional-installment

### Description
Retrieves a list of optional installments.

### Method
GET

### Endpoint
https://edu.easebuzz.in/api/fees/v1/optional-installment
```

--------------------------------

### Create Scheduler Response Example

Source: https://docs.easebuzz.in/docs/8-autocollect-recurring-payment/r1ehpkmvn8h77-create-scheduler-e-nach-upi-si

Example response indicating accepted and rejected schedules.

```json
{
  "success": true,
  "data": {
    "accepted_schedules": [
      {
        "id": "1",
        "scheduler_id": "XXXXXXXXX"
      },
      {
        "id": "2",
        "scheduler_id": "XXXXXXXXXXX"
      }
    ],
    "rejected_schedules": [
      {
        "id": "3",
        "message": "Start date cannot be in the past"
      }
    ]
  }
}
```

--------------------------------

### GET https://edu.easebuzz.in/api/fees/v1/optional_installment/

Source: https://docs.easebuzz.in/docs/feesbuzz/25bbdc5a40258-optional-installments-list

Retrieves a list of all optional installments.

```APIDOC
## GET https://edu.easebuzz.in/api/fees/v1/optional_installment/

### Description
Retrieves a list of optional installments available in the system.

### Method
GET

### Endpoint
https://edu.easebuzz.in/api/fees/v1/optional_installment/

### Parameters
#### Headers
- **AUTHHASH** (string) - Required - SHA-512 hash of string in the format of "[AUTHID]|[key]"
- **AUTHID** (string) - Required - API key provided by Easebuzz

### Response
#### Success Response (200)
- **success** (boolean) - Indicates if the request was successful
- **data** (array[object]) - List of optional installment objects

#### Response Example
{
  "success": true,
  "data": [
    {
      "id": 45,
      "split_bank_info": null,
      "group": null,
      "installment_amount": 500,
      "installment_name": "Installment 1",
      "note": "",
      "start_date": "2020-06-03T00:00:00",
      "due_date": "2021-01-25T05:30:00",
      "expire_date": "2021-07-26T05:30:00",
      "penalty_frequency": 0,
      "penalty_type": false,
      "penalty_amount": 0,
      "is_mandatory": false,
      "unique_name": "Inst 1"
    }
  ]
}
```

--------------------------------

### Launch Payment Activity

Source: https://docs.easebuzz.in/docs/payment-gateway/64nm87cwe27sl-android

Start the PWECouponsActivity with the required access key and payment mode. The FLAG_ACTIVITY_REORDER_TO_FRONT flag is mandatory.

```java
Intent intentProceed = new Intent(MerchantAppActivity.this, PWECouponsActivity.class);
intentProceed.setFlags(Intent.FLAG_ACTIVITY_REORDER_TO_FRONT); // This is mandatory flag
intentProceed.putExtra("access_key","Access key generated by the Initiate Payment API");
intentProceed.putExtra("pay_mode","This will either be "test" or "production"");
pweActivityResultLauncher.launch(intentProceed);
```

--------------------------------

### Optional Installment Response Example

Source: https://docs.easebuzz.in/docs/feesbuzz/b870050831cc5-create-optional-installment

Successful response format returned by the API.

```json
{
  "status": true,
  "msg": "Installment Created Successfully"
}
```

--------------------------------

### Install Plugin via Command Line

Source: https://docs.easebuzz.in/docs/payment-gateway/o8mkqq9pbl4el-flutter

Use the Flutter CLI to add the dependency to your project.

```bash
Flutter pub add easebuzz_flutter
```

--------------------------------

### Initialize Easebuzz Object

Source: https://docs.easebuzz.in/docs/payment-gateway/jl5acj6genz7q-python

Create an instance of the Easebuzz class with your credentials.

```python
easebuzzObj = Easebuzz(MERCHANT_KEY, SALT, ENV)
```

--------------------------------

### Retrieve Installments List via cURL

Source: https://docs.easebuzz.in/docs/feesbuzz/ba2a21975951a-installments-list

Use this cURL command to perform a GET request to the installments endpoint. Ensure the AUTHHASH and AUTHID headers are populated with your merchant credentials.

```shell
curl --request GET \
  --url https://edu.easebuzz.in/api/fees/v1/installment/{fee_structure_id} \
  --header 'AUTHHASH: ' \
  --header 'AUTHID: ' \
  --header 'Accept: application/json'
```

--------------------------------

### cURL Request Example

Source: https://docs.easebuzz.in/docs/payment-gateway/j6v1nmy74m325-status-api

Example command to perform the status check via a POST request to the sandbox environment.

```bash
curl --request POST \
  --url https://testdashboard.easebuzz.in/settlements/v1/ondemand/status/ \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{
  "key": "4DXXXXXXXX",
  "merchant_email": "samxxxxxxxxx@gmail.com",
  "merchant_batch_id": "XXXXXXXXXXXXXXXX",
  "hash": "ffb9847e20a8b27d0a572e550exxxxxxxx52e0c2b6e147"
}'
```

--------------------------------

### Initiate Payment with EasebuzzCheckout

Source: https://docs.easebuzz.in/docs/payment-gateway/9xm7b9we5tvl3-capacitor-js

Use the proceedToPayment method to trigger the payment flow with your access key and environment mode.

```typescript
async load_paymentgateway() 
{
  const option = 
  {
    access_key: ' Access key generated by the Initiate Payment API',
    pay_mode : ' This will either be “test” or “production ' 
  }
let data = await EasebuzzCheckout.proceedToPayment({ option });
console.log(data['result']);
console.log(data['payment_response']);
}
```

--------------------------------

### GET https://edu.easebuzz.in/api/fees/v1/installment/{fee_structure_id}

Source: https://docs.easebuzz.in/docs/feesbuzz/ba2a21975951a-installments-list

Retrieves a list of installments for a specific fee structure.

```APIDOC
## GET https://edu.easebuzz.in/api/fees/v1/installment/{fee_structure_id}

### Description
Retrieves the list of installments for the specified fee structure ID.

### Method
GET

### Endpoint
https://edu.easebuzz.in/api/fees/v1/installment/{fee_structure_id}

### Parameters
#### Path Parameters
- **fee_structure_id** (string) - Required - The unique identifier for the fee structure.

#### Headers
- **AUTHHASH** (string) - Required - SHA-512 hash of string in the format of "[AUTHID]|[key]".
- **AUTHID** (string) - Required - API key provided by Easebuzz.

### Response
#### Success Response (200)
- **success** (boolean) - Indicates if the request was successful.
- **data** (array[object]) - List of installment objects.

#### Response Example
{
  "success": true,
  "data": []
}
```

--------------------------------

### Initialize Easebuzz Object

Source: https://docs.easebuzz.in/docs/payment-gateway/ex7xej43lwl4g-php

Create an instance of the Easebuzz class using the configured credentials.

```php
$easebuzzObj = new Easebuzz($MERCHANT_KEY, $SALT, $ENV);
```

--------------------------------

### GET /api/fees/v1/installment_discount/{fee_structure_id}

Source: https://docs.easebuzz.in/docs/feesbuzz/beeaf78ca3e87-list-installment-discounts

Retrieves a list of installment discounts for a specified fee structure.

```APIDOC
## GET https://edu.easebuzz.in/api/fees/v1/installment_discount/{fee_structure_id}

### Description
Retrieves a list of installment discounts for a specific fee structure ID.

### Method
GET

### Endpoint
https://edu.easebuzz.in/api/fees/v1/installment_discount/{fee_structure_id}

### Parameters
#### Path Parameters
- **fee_structure_id** (string) - Required - The unique identifier for the fee structure.

#### Headers
- **AUTHHASH** (string) - Required - SHA-512 hash of string in the format of "[AUTHID]|[key]".
- **AUTHID** (string) - Required - API key provided by Easebuzz.

### Response
#### Success Response (200)
- **success** (boolean) - Indicates if the request was successful.
- **data** (array[object]) - List of discount objects.
  - **id** (integer) - Discount ID.
  - **discount_name** (string) - Name of the discount.
  - **actual_amount** (integer) - The original amount.
  - **payable_amount** (integer) - The amount to be paid after discount.
  - **expiry_date** (string) - The expiration date of the discount.
  - **structure** (object) - Associated structure details.

### Response Example
{
  "success": true,
  "data": [
    {
      "id": 81,
      "discount_name": "discount 003",
      "actual_amount": 10,
      "payable_amount": 5,
      "expiry_date": "2021-12-30",
      "structure": {
        "id": 656
      }
    }
  ]
}
```

--------------------------------

### GET https://edu.easebuzz.in/api/fees/v1/student/installments/{student_id}/

Source: https://docs.easebuzz.in/docs/feesbuzz/afa19f6c6455a-student-installment-list

Retrieves the installment details for a given student ID.

```APIDOC
## GET https://edu.easebuzz.in/api/fees/v1/student/installments/{student_id}/

### Description
Retrieves the list of installments for a specific student identified by their student_id.

### Method
GET

### Endpoint
https://edu.easebuzz.in/api/fees/v1/student/installments/{student_id}/

### Parameters
#### Path Parameters
- **student_id** (string) - Required - The unique identifier of the student.

#### Headers
- **AUTHHASH** (string) - Required - SHA-512 hash of string in the format of "[AUTHID]|[key]".
- **AUTHID** (string) - Required - API key provided by Easebuzz.

### Response
#### Success Response (200)
- **success** (boolean) - Indicates if the request was successful.
- **data** (array[object]) - List of installment objects.

#### Response Example
{
  "success": true,
  "data": [
    {
      "id": 73,
      "student": {
        "id": 17,
        "prn": "111",
        "name": "john",
        "email": "john@gmail.com",
        "phone_number": "9958091819",
        "password": "719855e8f4ebd94341277b0b0d50b75c5187133f",
        "course_name": "testing",
        "batch_name": "test batch",
        "fees_structure": "Fees",
        "degree": null,
        "semester": null,
        "father_name": "Jim",
        "address": "Pune",
        "is_active": true
      },
      "start_date": "2017-10-10T05:30:00+05:30",
      "amount_paid": null,
      "installment_amount": 1,
      "installment_name": "test sem1",
      "note": "test",
      "due_date": "2017-10-31T05:30:00+05:30",
      "expire_date": "2017-11-01T05:30:00+05:30",
      "penalty_frequency": 1,
      "penalty_amount": 1,
      "penalty_paid": null,
      "is_paid": false,
      "payment": null,
      "is_optional": false,
      "split_bank_info_id": null,
      "split_bank_info": null,
      "is_mandatory": false,
      "group": null
    }
  ]
}
```

--------------------------------

### Configure Podfile

Source: https://docs.easebuzz.in/docs/payment-gateway/g3qss9tu1zuko-ios

Add the Easebuzz SDK dependency to your Podfile.

```ruby
pod 'EasebuzzPaymentSDK-V2',’~> 1.3’
```
Tokens:
Raw