API Test Keys

Validate a VPA

POST

/v1/fund_accounts/validations

Click to copy

Use this endpoint to create contact, fund account and validate VPA (UPI) in a single API call.

Is this page helpful?

Curl

1curl -u <YOUR_KEY>:<YOUR_SECRET> \
2-X POST https://api.razorpay.com/v1/fund_accounts/validations \
3-H "Content-Type: application/json" \
4-d '{
5  "source_account_number": "7878780080316316",
6  "reference_id": "112233",
7  "notes": {
8    "random_key_1": "Make it so.",
9    "random_key_2": "Tea. Earl Grey. Hot."
10           }
11  "fund_account": {
12    "account_type":"vpa",
13    "vpa":{
14          "address":"gaurav.kumar@exampleupi"
15          }
16        "contact": {
17            "name":"Gaurav Kumar",
18            "email":"gaurav.kumar@example.com",
19            "contact":"9123456789",
20            "type":"employee",
21            "reference_id":"Acme Contact ID 12345",
22            "notes":{
23                "notes_key_1":"Tea, Earl Grey, Hot",
24                "notes_key_2":"Tea, Earl Grey... decaf."
25        }
26      }
27    }
28  }
29}'

Created

Completed

Failed

1{
2  "id": "fav_00000000000001",
3  "entity": "fund_account.validation",
4  "status": "created",
5  "validation_results": {
6      "account_status": null,
7      "registered_name": null,
8      "details": null,
9      "name_match_score": null
10   },
11  "status_details": {
12    "description": "Validation request is created",
13    "source": "internal",
14    "reason": "validation_request_created"
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":"vpa",
25      "vpa":{
26          "address":"gaurav.kumar@exampleupi"
27        }
28      "active": true,
29      "created_at": 1567064019,
30      "contact": {
31          "id": "cont_00000000000001",
32          "entity": "contact",
33          "name":"Gaurav Kumar",
34          "email":"gaurav.kumar@example.com",
35          "contact":"9123456789",
36          "type":"employee",
37          "reference_id":"Acme Contact ID 12345",
38          "active": true,
39          "created_at": 1567064019,
40          "notes":{
41          "notes_key_1":"Tea, Earl Grey, Hot",
42          "notes_key_2":"Tea, Earl Grey... decaf."
43          }
44      }
45  }
46}

Request Parameters

source_account_number

string

The account from which money should be deducted for the account validation transaction.

fund_account

object

Fund account details to which the payout was made.

Show child parameters (2)

notes

object

Key-value pair that can be used to store additional information about the entity. Maximum 15 key-value pairs, 256 characters (maximum) each. For example, "note_key": "Beam me up Scotty”.

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.

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.

Validate a VPA

POST

/v1/fund_accounts/validations

Click to copy

Use this endpoint to create contact, fund account and validate VPA (UPI) in a single API call.

Is this page helpful?

Request Parameters

source_account_number

string

The account from which money should be deducted for the account validation transaction.

fund_account

object

Fund account details to which the payout was made.

Show child parameters (2)

notes

object

Key-value pair that can be used to store additional information about the entity. Maximum 15 key-value pairs, 256 characters (maximum) each. For example, "note_key": "Beam me up Scotty”.

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.

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

1curl -u <YOUR_KEY>:<YOUR_SECRET> \
2-X POST https://api.razorpay.com/v1/fund_accounts/validations \
3-H "Content-Type: application/json" \
4-d '{
5  "source_account_number": "7878780080316316",
6  "reference_id": "112233",
7  "notes": {
8    "random_key_1": "Make it so.",
9    "random_key_2": "Tea. Earl Grey. Hot."
10           }
11  "fund_account": {
12    "account_type":"vpa",
13    "vpa":{
14          "address":"gaurav.kumar@exampleupi"
15          }
16        "contact": {
17            "name":"Gaurav Kumar",
18            "email":"gaurav.kumar@example.com",
19            "contact":"9123456789",
20            "type":"employee",
21            "reference_id":"Acme Contact ID 12345",
22            "notes":{
23                "notes_key_1":"Tea, Earl Grey, Hot",
24                "notes_key_2":"Tea, Earl Grey... decaf."
25        }
26      }
27    }
28  }
29}'

Created

Completed

Failed

1{
2  "id": "fav_00000000000001",
3  "entity": "fund_account.validation",
4  "status": "created",
5  "validation_results": {
6      "account_status": null,
7      "registered_name": null,
8      "details": null,
9      "name_match_score": null
10   },
11  "status_details": {
12    "description": "Validation request is created",
13    "source": "internal",
14    "reason": "validation_request_created"
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":"vpa",
25      "vpa":{
26          "address":"gaurav.kumar@exampleupi"
27        }
28      "active": true,
29      "created_at": 1567064019,
30      "contact": {
31          "id": "cont_00000000000001",
32          "entity": "contact",
33          "name":"Gaurav Kumar",
34          "email":"gaurav.kumar@example.com",
35          "contact":"9123456789",
36          "type":"employee",
37          "reference_id":"Acme Contact ID 12345",
38          "active": true,
39          "created_at": 1567064019,
40          "notes":{
41          "notes_key_1":"Tea, Earl Grey, Hot",
42          "notes_key_2":"Tea, Earl Grey... decaf."
43          }
44      }
45  }
46}