Fetch All Fund Accounts

GET

/v1/fund_accounts

Click to copy

Use this endpoint to retrieve all fund accounts.

Is this page helpful?

Curl

1curl -u [YOUR_KEY_ID]:[YOUR_KEY_SECRET] \
2-X GET https://api.razorpay.com/v1/fund_accounts

Success

1{
2  "entity": "collection",
3  "count": 3,
4  "items": [
5  {
6  "id": "fa_00000000000001",
7  "entity": "fund_account",
8  "contact_id": "cont_00000000000001",
9  "account_type": "bank_account",
10  "bank_account": {
11    "ifsc": "HDFC0000053",
12    "bank_name": "HDFC Bank",
13    "name": "Gaurav Kumar",
14    "account_number": "765432123456789",
15    "notes": []
16  },
17  "active": false,
18  "batch_id": null,
19  "created_at": 1545312598
20  },
21  {
22  "id": "fa_00000000000002",
23  "entity": "fund_account",
24  "contact_id": "cont_00000000000001",
25  "account_type": "vpa",
26  "vpa": {
27    "username": "gaurav.kumar",
28    "handle": "exampleupi",
29    "address": "gaurav.kumar@exampleupi"
30  },
31  "active": true,
32  "batch_id": null,
33  "created_at": 1545313478
34  },
35  {
36  "id": "fa_00000000000001",
37  "entity": "fund_account",
38  "contact_id": "cont_00000000000001",
39  "account_type": "card",
40  "card": {
41    "name": "Gaurav Kumar",
42    "last4": "6789",
43    "network": "Visa",
44    "type": "credit",
45    "issuer": "HDFC"
46  },
47  "active": false,
48  "batch_id": null,
49  "created_at": 1545312598
50  }
51 ]
52}

Query Parameters

account_type

string

The fund account type to be retrieved. Possible values:

bank_account
vpa
card (if
payouts to cards
is enabled on your account)

contact_id

string

The unique contact ID for which fund accounts are to be retrieved. For example, cont_00000000000001.

from

integer

Timestamp, in Unix, from when fund accounts are to be retrieved.

to

integer

Timestamp, in Unix, till when fund accounts are to be retrieved.

count

integer

The number of fund accounts to be retrieved. Default = 10. Maximum = 100. This can be used for pagination, in combination with skip.

skip

integer

The number of fund accounts to be skipped. Default = 0. This can be used for pagination, in combination with count.

Response Parameters

id

string

The unique identifier linked to the fund account. For example, fa_00000000000001.

entity

string

Here it is fund_account.

contact_id

string

The unique identifier linked to the contact. For example, cont_00000000000001.

account_type

string

The fund account type being created. Here it will either be bank_account, vpa or card.

Show child parameters (3)

active

boolean

Possible values of Fund Account status:

true: active
false: inactive

batch_id

string

This value is returned if the fund account was created as part of a bulk upload.
For example, batch_00000000000001.

status

string

The status of the account validation transaction. Possible values:

created
completed
failed

results

object

Result of the validation. If the account validation is complete and the account is invalid, the value in the below parameters is null.

Show child parameters (2)

created_at

integer

Timestamp, in Unix, when the fund account was created. For example, 1543650891.

Errors

<fund account id> is not a valid id.

Error Status: 4xx

The fund account ID entered is invalid.

Solution

Fetch All Fund Accounts

GET

/v1/fund_accounts

Click to copy

Use this endpoint to retrieve all fund accounts.

Is this page helpful?

Query Parameters

account_type

string

The fund account type to be retrieved. Possible values:

bank_account
vpa
card (if
payouts to cards
is enabled on your account)

contact_id

string

The unique contact ID for which fund accounts are to be retrieved. For example, cont_00000000000001.

from

integer

Timestamp, in Unix, from when fund accounts are to be retrieved.

to

integer

Timestamp, in Unix, till when fund accounts are to be retrieved.

count

integer

The number of fund accounts to be retrieved. Default = 10. Maximum = 100. This can be used for pagination, in combination with skip.

skip

integer

The number of fund accounts to be skipped. Default = 0. This can be used for pagination, in combination with count.

Response Parameters

id

string

The unique identifier linked to the fund account. For example, fa_00000000000001.

entity

string

Here it is fund_account.

contact_id

string

The unique identifier linked to the contact. For example, cont_00000000000001.

account_type

string

The fund account type being created. Here it will either be bank_account, vpa or card.

Show child parameters (3)

active

boolean

Possible values of Fund Account status:

true: active
false: inactive

batch_id

string

This value is returned if the fund account was created as part of a bulk upload.
For example, batch_00000000000001.

status

string

The status of the account validation transaction. Possible values:

created
completed
failed

results

object

Result of the validation. If the account validation is complete and the account is invalid, the value in the below parameters is null.

Show child parameters (2)

created_at

integer

Timestamp, in Unix, when the fund account was created. For example, 1543650891.

Errors

<fund account id> is not a valid id.

Error Status: 4xx

The fund account ID entered is invalid.

Solution

Curl

1curl -u [YOUR_KEY_ID]:[YOUR_KEY_SECRET] \
2-X GET https://api.razorpay.com/v1/fund_accounts

Success

1{
2  "entity": "collection",
3  "count": 3,
4  "items": [
5  {
6  "id": "fa_00000000000001",
7  "entity": "fund_account",
8  "contact_id": "cont_00000000000001",
9  "account_type": "bank_account",
10  "bank_account": {
11    "ifsc": "HDFC0000053",
12    "bank_name": "HDFC Bank",
13    "name": "Gaurav Kumar",
14    "account_number": "765432123456789",
15    "notes": []
16  },
17  "active": false,
18  "batch_id": null,
19  "created_at": 1545312598
20  },
21  {
22  "id": "fa_00000000000002",
23  "entity": "fund_account",
24  "contact_id": "cont_00000000000001",
25  "account_type": "vpa",
26  "vpa": {
27    "username": "gaurav.kumar",
28    "handle": "exampleupi",
29    "address": "gaurav.kumar@exampleupi"
30  },
31  "active": true,
32  "batch_id": null,
33  "created_at": 1545313478
34  },
35  {
36  "id": "fa_00000000000001",
37  "entity": "fund_account",
38  "contact_id": "cont_00000000000001",
39  "account_type": "card",
40  "card": {
41    "name": "Gaurav Kumar",
42    "last4": "6789",
43    "network": "Visa",
44    "type": "credit",
45    "issuer": "HDFC"
46  },
47  "active": false,
48  "batch_id": null,
49  "created_at": 1545312598
50  }
51 ]
52}