Docs Logo

Account Validation Composite

Validate a Bank Account

Validate a VPA

Fetch All Account Validation Transactions

Fetch Account Validation Transaction With ID

Docs Logo

API Test keys

Api

X

Composite Account Validation

Fetch All Transactions

API Test keys

Api

X

Composite Account Validation

Fetch All Transactions

Fetch All Account Validation Transactions

GET
/v1/fund_accounts/validations?account_number={account number}

Click to copy

Use this endpoint to retrieve the details of all Fund Account Validation transactions you have made.

Is this page helpful?

Curl

1
curl -u <YOUR_KEY>:<YOUR_SECRET> \
2
    -X GET https://api.razorpay.com/v1/fund_accounts/validations?account_number=7878780080316316

Success

1
{
2
  "entity":"collection",
3
  "count":2,
4
  "items":[
5
    {
6
     "id": "fav_00000000000001",
7
     "entity": "fund_account.validation",
8
     "status": "completed",
9
     "validation_results": {
10
        "account_status": "valid",
11
        "registered_name": "Gaurav Kumar",
12
        "details": "The beneficiary account is valid." ,
13
        "name_match_score": 100
14
                        },
15
    "status_details": {
16
        "description": "Validation request is completed",
17
        "source": "beneficiary_bank",
18
        "reason": "validation_completed"
19
                    },
20
    "reference_id": "112233",
21
    "notes": {
22
        "random_key_1": "Make it so.",
23
        "random_key_2": "Tea. Earl Grey. Hot."
24
            },
25
    "fund_account": {
26
        "id": "fa_00000000000001",
27
        "entity": "fund_account",
28
        "account_type": "bank_account",
29
        "bank_account": {
30
            "name": "Gaurav Kumar",
31
            "bank_name": "HDFC",
32
            "ifsc": "HDFC0000053",
33
            "account_number": "765432123456789"
34
             },
35
        "active": true,
36
        "created_at": 1567064019,
37
        "contact": {
38
            "id": "cont_00000000000001",
39
            "entity": "contact",
40
            "name":"Gaurav Kumar",
41
            "email":"gaurav.kumar@example.com",
42
            "contact":"9123456789",
43
            "type":"employee",
44
            "reference_id":"Acme Contact ID 12345",
45
            "active": true,
46
            "created_at": 1567064019,
47
            "notes":{
48
            "notes_key_1":"Tea, Earl Grey, Hot",
49
            "notes_key_2":"Tea, Earl Grey... decaf."
50
                }
51
            }
52
        }
53
    },
54
    {
55
     "id": "fav_00000000000002",
56
     "entity": "fund_account.validation",
57
     "status": "completed",
58
     "validation_results": {
59
        "account_status": "valid",
60
        "registered_name": "Gauri Kumari",
61
        "details": "The beneficiary account is valid." ,
62
        "name_match_score": 100
63
        },
64
    "status_details": {
65
        "description": "Validation request is completed",
66
        "source": "beneficiary_bank",
67
        "reason": "validation_completed"
68
        },
69
    "reference_id": "112244",
70
    "notes": {
71
        "random_key_1": "Make it so.",
72
        "random_key_2": "Tea. Earl Grey. Hot."
73
    },
74
    "fund_account": {
75
        "id": "fa_00000000000002",
76
        "entity": "fund_account",
77
        "account_type": "bank_account",
78
        "bank_account": {
79
            "name": "Gauri Kumari",
80
            "bank_name": "HDFC",
81
            "ifsc": "HDFC0000054",
82
            "account_number": "765432123456798"
83
        },
84
        "active": true,
85
        "created_at": 1567064019,
86
        "contact": {
87
            "id": "cont_00000000000002",
88
            "entity": "contact",
89
            "name":"Gauri Kumari",
90
            "email":"gauri.kumari@example.com",
91
            "contact":"9999999999",
92
            "type":"employee",
93
            "reference_id":"Acme Contact ID 12354",
94
            "active": true,
95
            "created_at": 1567064120,
96
            "notes":{
97
            "notes_key_1":"Tea, Earl Grey, Hot",
98
            "notes_key_2":"Tea, Earl Grey... decaf."
99
                }
100
            }
101
        }
102
    }
103
  ]
104
}
Path Parameters
account_number

*

string

The account from which you want to make the payout.
Account details can be found on the RazorpayX Dashboard. For example, 7878780080316316.

  • Pass your customer identifier if you want money to be deducted from RazorpayX Lite.

Watch Out!

  • This is not your contact's bank account number. Log in to your
    RazorpayX Dashboard
    and go to My Account & Settings ā†’ Banking ā†’ Customer Identifier.
  • This value is different for Test Mode and Live Mode.

Query Parameters
from
integer

Timestamp in Unix from when you want to fetch payouts.

to
integer

Timestamp in Unix till when you want to fetch payouts.

count
integer

Number of payouts to be retrieved. Default value is 10. Maximum value is 100. This can be used for pagination, in combination with skip.

skip
integer

Number of payouts to be skipped. Default value is 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 will be fund_account.validation.

status
string

The status of the account validation transaction. Possible values:

  • created
  • completed
  • failed

validation_results
object

Result of the validation.

Show child parameters (4)

status_details
object

This parameter returns the current status of the customer's bank account.

Show child parameters (3)

fund_account
object

Fund account details to which the payout was made.

Show child parameters (3)

contact
object

Contact details to which the payout was made.

Show child parameters (6)

reference_id
string

A user-generated reference given to the payout. Maximum length is 40 characters. For example, 112233. You can use this field to store your own transaction ID, if any.

notes
object

User-entered notes for internal reference. This is a key-value pair. You can enter a maximum of 15 key-value pairs. For example, "note_key": "Beam me up Scottyā€¯.

active
boolean

Possible values of Fund Account status:

  • true: active
  • false: inactive

created_at
integer

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

Fetch All Account Validation Transactions

GET
/v1/fund_accounts/validations?account_number={account number}

Click to copy

Use this endpoint to retrieve the details of all Fund Account Validation transactions you have made.

Is this page helpful?

Path Parameters
account_number

*

string

The account from which you want to make the payout.
Account details can be found on the RazorpayX Dashboard. For example, 7878780080316316.

  • Pass your customer identifier if you want money to be deducted from RazorpayX Lite.

Watch Out!

  • This is not your contact's bank account number. Log in to your
    RazorpayX Dashboard
    and go to My Account & Settings ā†’ Banking ā†’ Customer Identifier.
  • This value is different for Test Mode and Live Mode.

Query Parameters
from
integer

Timestamp in Unix from when you want to fetch payouts.

to
integer

Timestamp in Unix till when you want to fetch payouts.

count
integer

Number of payouts to be retrieved. Default value is 10. Maximum value is 100. This can be used for pagination, in combination with skip.

skip
integer

Number of payouts to be skipped. Default value is 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 will be fund_account.validation.

status
string

The status of the account validation transaction. Possible values:

  • created
  • completed
  • failed

validation_results
object

Result of the validation.

Show child parameters (4)

status_details
object

This parameter returns the current status of the customer's bank account.

Show child parameters (3)

fund_account
object

Fund account details to which the payout was made.

Show child parameters (3)

contact
object

Contact details to which the payout was made.

Show child parameters (6)

reference_id
string

A user-generated reference given to the payout. Maximum length is 40 characters. For example, 112233. You can use this field to store your own transaction ID, if any.

notes
object

User-entered notes for internal reference. This is a key-value pair. You can enter a maximum of 15 key-value pairs. For example, "note_key": "Beam me up Scottyā€¯.

active
boolean

Possible values of Fund Account status:

  • true: active
  • false: inactive

created_at
integer

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

Curl

1
curl -u <YOUR_KEY>:<YOUR_SECRET> \
2
    -X GET https://api.razorpay.com/v1/fund_accounts/validations?account_number=7878780080316316

Success

1
{
2
  "entity":"collection",
3
  "count":2,
4
  "items":[
5
    {
6
     "id": "fav_00000000000001",
7
     "entity": "fund_account.validation",
8
     "status": "completed",
9
     "validation_results": {
10
        "account_status": "valid",
11
        "registered_name": "Gaurav Kumar",
12
        "details": "The beneficiary account is valid." ,
13
        "name_match_score": 100
14
                        },
15
    "status_details": {
16
        "description": "Validation request is completed",
17
        "source": "beneficiary_bank",
18
        "reason": "validation_completed"
19
                    },
20
    "reference_id": "112233",
21
    "notes": {
22
        "random_key_1": "Make it so.",
23
        "random_key_2": "Tea. Earl Grey. Hot."
24
            },
25
    "fund_account": {
26
        "id": "fa_00000000000001",
27
        "entity": "fund_account",
28
        "account_type": "bank_account",
29
        "bank_account": {
30
            "name": "Gaurav Kumar",
31
            "bank_name": "HDFC",
32
            "ifsc": "HDFC0000053",
33
            "account_number": "765432123456789"
34
             },
35
        "active": true,
36
        "created_at": 1567064019,
37
        "contact": {
38
            "id": "cont_00000000000001",
39
            "entity": "contact",
40
            "name":"Gaurav Kumar",
41
            "email":"gaurav.kumar@example.com",
42
            "contact":"9123456789",
43
            "type":"employee",
44
            "reference_id":"Acme Contact ID 12345",
45
            "active": true,
46
            "created_at": 1567064019,
47
            "notes":{
48
            "notes_key_1":"Tea, Earl Grey, Hot",
49
            "notes_key_2":"Tea, Earl Grey... decaf."
50
                }
51
            }
52
        }
53
    },
54
    {
55
     "id": "fav_00000000000002",
56
     "entity": "fund_account.validation",
57
     "status": "completed",
58
     "validation_results": {
59
        "account_status": "valid",
60
        "registered_name": "Gauri Kumari",
61
        "details": "The beneficiary account is valid." ,
62
        "name_match_score": 100
63
        },
64
    "status_details": {
65
        "description": "Validation request is completed",
66
        "source": "beneficiary_bank",
67
        "reason": "validation_completed"
68
        },
69
    "reference_id": "112244",
70
    "notes": {
71
        "random_key_1": "Make it so.",
72
        "random_key_2": "Tea. Earl Grey. Hot."
73
    },
74
    "fund_account": {
75
        "id": "fa_00000000000002",
76
        "entity": "fund_account",
77
        "account_type": "bank_account",
78
        "bank_account": {
79
            "name": "Gauri Kumari",
80
            "bank_name": "HDFC",
81
            "ifsc": "HDFC0000054",
82
            "account_number": "765432123456798"
83
        },
84
        "active": true,
85
        "created_at": 1567064019,
86
        "contact": {
87
            "id": "cont_00000000000002",
88
            "entity": "contact",
89
            "name":"Gauri Kumari",
90
            "email":"gauri.kumari@example.com",
91
            "contact":"9999999999",
92
            "type":"employee",
93
            "reference_id":"Acme Contact ID 12354",
94
            "active": true,
95
            "created_at": 1567064120,
96
            "notes":{
97
            "notes_key_1":"Tea, Earl Grey, Hot",
98
            "notes_key_2":"Tea, Earl Grey... decaf."
99
                }
100
            }
101
        }
102
    }
103
  ]
104
}