Skip to content

Latest commit

 

History

History
103 lines (93 loc) · 2.73 KB

fund.md

File metadata and controls

103 lines (93 loc) · 2.73 KB
Raw

Funds

Create a fund account

client.fund_account.create({
  "customer_id":"cust_Aa000000000001",
  "account_type":"bank_account",
  "bank_account":{
    "name":"Gaurav Kumar",
    "account_number":"11214311215411",
    "ifsc":"HDFC0000053"
  }
})

Parameters:

Name Type Description
customerId* string The id of the customer to be fetched
account_type* string The bank_account to be linked to the customer ID
bank_account* object All keys listed here are supported

Response:

{
  "id": "fa_JexSeA2SS1S19D",
  "entity": "fund_account",
  "customer_id": "cust_JdumbHq5F3kKu6",
  "account_type": "bank_account",
  "bank_account": {
    "ifsc": "HDFC0000053",
    "bank_name": "HDFC Bank",
    "name": "Gaurav Kumar",
    "notes": [],
    "account_number": "11214311215411"
  },
  "batch_id": null,
  "active": true,
  "created_at": 1654682051
}

Fetch all fund accounts

client.fund_account.all({"customer_id":customerId})

Parameters:

Name Type Description
customerId* string The id of the customer to be fetched

Response:

{
  "entity": "collection",
  "count": 2,
  "items": [
    {
      "id": "fa_JcXaLomo4ck5IY",
      "entity": "fund_account",
      "customer_id": "cust_JZse2vlC5nK9AQ",
      "account_type": "bank_account",
      "bank_account": {
        "ifsc": "HDFC0000053",
        "bank_name": "HDFC Bank",
        "name": "Gaurav Kumar",
        "notes": [],
        "account_number": "11214311215411"
      },
      "batch_id": null,
      "active": true,
      "created_at": 1654154246
    },
    {
      "id": "fa_JcXYtecLkhW74k",
      "entity": "fund_account",
      "customer_id": "cust_JZse2vlC5nK9AQ",
      "account_type": "bank_account",
      "bank_account": {
        "ifsc": "HDFC0000053",
        "bank_name": "HDFC Bank",
        "name": "Gaurav Kumar",
        "notes": [],
        "account_number": "11214311215411"
      },
      "batch_id": null,
      "active": true,
      "created_at": 1654154163
    }
  ]
}

PN: * indicates mandatory fields

For reference click here