API Test Keys

Validate a VPA

POST

/v1/fund_accounts/validations

Click to copy

Use this endpoint to create a VPA (UPI) account validation transaction.

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  "account_number": "7878780080316316",
6  "fund_account": {
7    "id": "fa_00000000000002"
8  },
9  "notes": {
10    "random_key_1": "Make it so.",
11    "random_key_2": "Tea. Earl Grey. Hot."
12  }
13}'

Created

Completed

Failed

1{
2  "id": "fav_00000000000002",
3  "entity": "fund_account.validation",
4  "fund_account": {
5    "id": "fa_00000000000002",
6    "entity": "fund_account",
7    "contact_id": "cont_00000000000001",
8    "account_type": "vpa",
9    "vpa": {
10      "username": "gaurav.kumar",
11      "handle": "exampleupi",
12      "address": "gaurav.kumar@exampleupi"
13    },
14    "batch_id": null,
15    "active": true,
16    "created_at": 1573110860
17  },
18  "status": "created",
19  "amount": null,
20  "currency": null,
21  "notes": {
22    "random_key_1": "Make it so.",
23    "random_key_2": "Tea. Earl Grey. Hot."
24  },
25  "results": {
26    "account_status": null,
27    "registered_name": null
28  },
29  "created_at": 1574244676,
30  "utr": null
31}

Request Parameters

account_number

string

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

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.

fund_account

object

The fund account id you want to validate.

Show child parameters (1)

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”.

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 invalid.

Show child parameters (2)

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 a VPA (UPI) account validation transaction.

Is this page helpful?

Request Parameters

account_number

string

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

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.

fund_account

object

The fund account id you want to validate.

Show child parameters (1)

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”.

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 invalid.

Show child parameters (2)

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  "account_number": "7878780080316316",
6  "fund_account": {
7    "id": "fa_00000000000002"
8  },
9  "notes": {
10    "random_key_1": "Make it so.",
11    "random_key_2": "Tea. Earl Grey. Hot."
12  }
13}'

Created

Completed

Failed

1{
2  "id": "fav_00000000000002",
3  "entity": "fund_account.validation",
4  "fund_account": {
5    "id": "fa_00000000000002",
6    "entity": "fund_account",
7    "contact_id": "cont_00000000000001",
8    "account_type": "vpa",
9    "vpa": {
10      "username": "gaurav.kumar",
11      "handle": "exampleupi",
12      "address": "gaurav.kumar@exampleupi"
13    },
14    "batch_id": null,
15    "active": true,
16    "created_at": 1573110860
17  },
18  "status": "created",
19  "amount": null,
20  "currency": null,
21  "notes": {
22    "random_key_1": "Make it so.",
23    "random_key_2": "Tea. Earl Grey. Hot."
24  },
25  "results": {
26    "account_status": null,
27    "registered_name": null
28  },
29  "created_at": 1574244676,
30  "utr": null
31}