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 Transactions With Id

API Test keys

Api

X

Composite Account Validation

Fetch Transactions With Id

Fetch Account Validation Transactions With ID

GET
/v1/fund_accounts/validations/:id

Click to copy

Use this endpoint to retrieve a particular Fund Account Validation transaction with its id.

Is this page helpful?

Curl

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

Success

1
{
2
    "id": "fav_00000000000001",
3
    "entity": "fund_account.validation",
4
    "status": "completed",
5
    "validation_results": {
6
        "account_status": "valid",
7
        "registered_name": "Gaurav Kumar",
8
        "details": "The beneficiary account is valid." ,
9
        "name_match_score": 100
10
                        },
11
    "status_details": {
12
        "description": "Validation request is completed",
13
        "source": "beneficiary_bank",
14
        "reason": "validation_completed"
15
                },
16
    "reference_id": "112233",
17
    "notes": {
18
        "random_key_1": "Make it so.",
19
        "random_key_2": "Tea. Earl Grey. Hot."
20
         },
21
    "fund_account": {
22
        "id": "fa_00000000000001",
23
        "entity": "fund_account",
24
        "account_type": "bank_account",
25
        "bank_account": {
26
            "name": "Gaurav Kumar",
27
            "bank_name": "HDFC",
28
            "ifsc": "HDFC0000053",
29
            "account_number": "765432123456789"
30
                },
31
        "active": true,
32
        "created_at": 1567064019,
33
        "contact": {
34
            "id": "cont_00000000000001",
35
            "entity": "contact",
36
            "name":"Gaurav Kumar",
37
            "email":"gaurav.kumar@example.com",
38
            "contact":"9123456789",
39
            "type":"employee",
40
            "reference_id":"Acme Contact ID 12345",
41
            "active": true,
42
            "created_at": 1567064019,
43
            "notes":{
44
            "notes_key_1":"Tea, Earl Grey, Hot",
45
            "notes_key_2":"Tea, Earl Grey... decaf."
46
                }
47
        }
48
    }
49
}
Path Parameters
id

*

string

This is the unique identifier linked to the account validation transaction. For example, fav_00000000000001.

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 Account Validation Transactions With ID

GET
/v1/fund_accounts/validations/:id

Click to copy

Use this endpoint to retrieve a particular Fund Account Validation transaction with its id.

Is this page helpful?

Path Parameters
id

*

string

This is the unique identifier linked to the account validation transaction. For example, fav_00000000000001.

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/fav_00000000000001

Success

1
{
2
    "id": "fav_00000000000001",
3
    "entity": "fund_account.validation",
4
    "status": "completed",
5
    "validation_results": {
6
        "account_status": "valid",
7
        "registered_name": "Gaurav Kumar",
8
        "details": "The beneficiary account is valid." ,
9
        "name_match_score": 100
10
                        },
11
    "status_details": {
12
        "description": "Validation request is completed",
13
        "source": "beneficiary_bank",
14
        "reason": "validation_completed"
15
                },
16
    "reference_id": "112233",
17
    "notes": {
18
        "random_key_1": "Make it so.",
19
        "random_key_2": "Tea. Earl Grey. Hot."
20
         },
21
    "fund_account": {
22
        "id": "fa_00000000000001",
23
        "entity": "fund_account",
24
        "account_type": "bank_account",
25
        "bank_account": {
26
            "name": "Gaurav Kumar",
27
            "bank_name": "HDFC",
28
            "ifsc": "HDFC0000053",
29
            "account_number": "765432123456789"
30
                },
31
        "active": true,
32
        "created_at": 1567064019,
33
        "contact": {
34
            "id": "cont_00000000000001",
35
            "entity": "contact",
36
            "name":"Gaurav Kumar",
37
            "email":"gaurav.kumar@example.com",
38
            "contact":"9123456789",
39
            "type":"employee",
40
            "reference_id":"Acme Contact ID 12345",
41
            "active": true,
42
            "created_at": 1567064019,
43
            "notes":{
44
            "notes_key_1":"Tea, Earl Grey, Hot",
45
            "notes_key_2":"Tea, Earl Grey... decaf."
46
                }
47
        }
48
    }
49
}