Skip to content

Latest commit

 

History

History
79 lines (69 loc) · 2.45 KB

fund.md

File metadata and controls

79 lines (69 loc) · 2.45 KB
Raw

Funds

Create a fund account

$api->fundAccount->create(array('customer_id'=>$customerId,'account_type'=>'bank_account','bank_account'=>array('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* array All keys listed here are supported

Response:

{
    "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
}

Fetch all fund accounts

$api->fundAccount->all(array('customer_id'=>$customerIds));

Parameters:

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

Response:

{
    "entity": "collection",
    "count": 2,
    "items": [
        {
            "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