Introduction

API Reference Guide

API Changelog

API Basics

Authentication & Sandbox Setup

Entity & Metadata

Pagination & Rate Limiting

Best Practices

Glossary

Payments

Orders

Payments

Downtime

Settlements

Instant Settlements

Refunds

Disputes

Documents

Customers

Payment Links

QR Codes

Invoices

Items

Plans

Subscriptions

Add-on

Linked Account

Stakeholder

Product Configuration

Transfers

Smart Collect

Smart Collect With TPV

Bills

About Bills

Bills Entity

Create a Bill

Update a Bill

Delete a Bill

Partners

Account

Product Configuration

Stakeholder

Terms and Conditions

Documents

Webhooks

Payout APIs

Get Started

Account Validation

Composite Account Validation

Contacts

Fund Accounts

Payouts

Payouts to Cards

Payout Composite

Payouts Approval

Payout Idempotency

Payout Links

Payout Wallet - Amazon

Transactions

Api

X

Fund Accounts

Create

Vpa

API Test Keys

Create a Fund Account of Type VPA

POST
/v1/fund_accounts

Click to copy

Use this endpoint to create a fund account with VPA details.

  • A new fund account is created if any combination of the following details is unique: contact_id and vpa.address.
  • If all the above details match the details of an existing fund account, the API returns details of the existing fund account.
  • You cannot edit the details of a fund account.

Is this page helpful?

Curl

1
curl -u [YOUR_KEY_ID]:[YOUR_KEY_SECRET] \
2
-X POST https://api.razorpay.com/v1/fund_accounts \
3
-H "Content-Type: application/json" \
4
-d '{
5
  "account_type":"vpa",
6
  "contact_id":"cont_00000000000001",
7
  "vpa":{
8
    "address":"gaurav.kumar@exampleupi"
9
  }
10
}'

Success

1
{
2
  "id": "fa_00000000000002",
3
  "entity": "fund_account",
4
  "contact_id": "cont_00000000000001",
5
  "account_type": "vpa",
6
  "vpa": {
7
    "username": "gaurav.kumar",
8
    "handle": "exampleupi",
9
    "address": "gaurav.kumar@exampleupi"
10
  },
11
  "active": true,
12
  "batch_id": null,
13
  "created_at": 1545223741
14
}
Request Parameters
contact_id

*

string

This is the unique identifier linked to a contact. For example, cont_00000000000001.

account_type

*

string

The fund account type you want to link to the contact ID. Here it is vpa.

vpa

*

object

The contact's virtual payment address (VPA) details.

Show child parameters (1)

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.

Errors

The contact ID provided does not exist.

Error Status: 4xx

The contact id provided is incorrect.

Solution

Create a Fund Account of Type VPA

POST
/v1/fund_accounts

Click to copy

Use this endpoint to create a fund account with VPA details.

  • A new fund account is created if any combination of the following details is unique: contact_id and vpa.address.
  • If all the above details match the details of an existing fund account, the API returns details of the existing fund account.
  • You cannot edit the details of a fund account.

Is this page helpful?

Request Parameters
contact_id

*

string

This is the unique identifier linked to a contact. For example, cont_00000000000001.

account_type

*

string

The fund account type you want to link to the contact ID. Here it is vpa.

vpa

*

object

The contact's virtual payment address (VPA) details.

Show child parameters (1)

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.

Errors

The contact ID provided does not exist.

Error Status: 4xx

The contact id provided is incorrect.

Solution

Curl

1
curl -u [YOUR_KEY_ID]:[YOUR_KEY_SECRET] \
2
-X POST https://api.razorpay.com/v1/fund_accounts \
3
-H "Content-Type: application/json" \
4
-d '{
5
  "account_type":"vpa",
6
  "contact_id":"cont_00000000000001",
7
  "vpa":{
8
    "address":"gaurav.kumar@exampleupi"
9
  }
10
}'

Success

1
{
2
  "id": "fa_00000000000002",
3
  "entity": "fund_account",
4
  "contact_id": "cont_00000000000001",
5
  "account_type": "vpa",
6
  "vpa": {
7
    "username": "gaurav.kumar",
8
    "handle": "exampleupi",
9
    "address": "gaurav.kumar@exampleupi"
10
  },
11
  "active": true,
12
  "batch_id": null,
13
  "created_at": 1545223741
14
}