Integration Flow

Learn how you can integrate fixed deposit APIs in your application.

The figure below shows the steps involved in creating a fixed deposit.

453

Fixed Deposit Integration Flow

Follow the steps below to create a fixed deposit.

  1. [Prerequisite] Create a Savings or Current Account
  2. Create a Fixed Deposit Account

1. [Prerequisite] Create Savings or Current Account

Before creating a fixed deposit, the applicant must first create a savings or current account.

Contact our integration team to learn how to create a savings or current account using ZWITCH.

2. Create Fixed Deposit

After creating an account, the account holder can create a fixed deposit by sending us details such as the amount, tenure, and maturity instructions.

Use the below endpoint to create a fixed deposit account.

https://api.zwitch.io/v1/accounts

Below is a sample request and sample response for a Create Fixed Deposit API.

{
  "type": "fixed_deposit",
  "linked_to_account_id": "sa_Ov7T4kb7SiRTuTELfq0BZNxcP",
  "amount": 100,
  "tenure_in_months": 10,
  "maturity_instruction": {
    "auto_renew": "no",
    "payout_frequency": "quarterly"
  },
  "nominee": [
    {
      "name": "Ram Reddy",
      "relation": "son",
      "address": "221B Baker Street",
      "city": "Bangalore",
      "postal_code": 560005,
      "state_code": "KA",
      "date_of_birth": "2020-12-31",
      "guardian": {
        "name": "Gita Reddy",
        "relation": "mother",
        "address": "221B Baker Street",
        "state_code": "KA",
        "city": "Bangalore",
        "postal_code": 560005,
        "mobile_number": "9876543210"
      }
    }
  ],
  "device_data": {
    "latitude": 12.12,
    "longitude": 12.12,
    "ip_address": "121.122.1.1"
  },
  "metadata": {
    "key_1": "DD",
    "key_2": "XoF"
  }
}
{
  "id": "fd_9asdasdsadasd2342asd",
  "object": "account.fixed_deposit",
  "type": "fixed_deposit",
  "linked_to_account_id": "sa_Ov7T4kb7SiRTuTELfq0BZNxcP",
  "amount": 300,
  "tenure_in_months": 10,
  "maturity_instruction": {
    "auto_renew": "no",
    "payout_frequency": "quarterly"
  },
  "nominee": [
    {
      "name": "Ram Reddy",
      "relation": "son",
      "address": "221B Baker Street",
      "city": "Bangalore",
      "postal_code": "560005",
      "state_code": "KA",
      "date_of_birth": "2020-12-31",
      "guardian": {
        "name": "Gita Reddy",
        "relation": "mother",
        "address": "221B Baker Street",
        "state_code": "KA",
        "city": "Bangalore",
        "postal_code": "560005",
        "mobile_number": "9876543210"
      }
    }
  ],
  "status": "active",
  "fd_account_number": "282139812831232",
  "device_data": {
    "latitude": 12.12,
    "longitude": 12.12,
    "ip_address": "121.122.1.1"
  },
  "interest_rate": 3.69,
  "maturity_amount": 369,
  "maturity_date": "2022-12-31",
  "settled_amount": 0,
  "closed_date": null,
  "metadata": {
    "key_1": "DD",
    "key_2": "XoF"
  },
  "created_at": 1658991892,
  "updated_at": 1658991892,
  "is_sandbox": false
}

Use the links below to learn more about our Fixed Deposit APIs.