Fund Accounts

Fund accounts

are accounts associated with a contact. Payouts are made to fund accounts.

Watch Out!

It is mandatory to

allowlist IPs

that you use while making payouts via APIs or the request will fail.

Explore the Fund Account API collection in the Razorpay Postman Public Workspace. Fork the workspace and test the APIs with your

Test API Keys

How it Works

Currently, RazorpayX supports 4 types of fund accounts:

bank_account: Make payouts to a beneficiary's bank account via bank transfer using one of the available such as NEFT, IMPS or RTGS.
vpa (Virtual Payment Address): Make payouts to a beneficiary's UPI ID via a UPI transfer.
cards: Make payouts directly to a beneficiary's card via a bank transfer using one of the available such as NEFT, IMPS, UPI or card mode. Know more about
Payouts to Cards
.
wallet: Make payouts directly to a beneficiary's wallet. Currently, you can make payouts to a beneficiary via an Amazon Pay Gift Card. Know more about
Payouts to Amazon Pay Wallet
.

Know more about the

Payout modes available for each fund account type

Handy Tips

You can improve payout processing times by creating fund accounts a few hours before you make payouts to the fund account.

Prerequisites

Before you create a Fund account or

use the below listed APIs

, you must:

Create a Contact
.

Or, if you already know for which Contact you want to create a Fund account, keep their Contact id (for example, contact_id cont_00000000000001) available.

You can refer to the Request Parameters of each API for more information.

List of Endpoints

Before you fire APIs, keep your Key id and Key Secret available. You can

generate API keys

in Live Mode or in

Test Mode

on the

RazorpayX Dashboard

API Endpoint	Description
Create a Fund Account of the type Bank Account details	Creates a new fund account using bank account details.
Create a Fund Account of the type VPA	Creates a new fund account using VPA details.
Fetch all Fund Accounts	Retrieves all the fund accounts.
Fetch a Fund Account with ID	Retrieves a single fund account with ID.
Activate or Deactivate a Fund Account	Activates or deactivates an existing fund account.

Fund Account Entity

The Fund Accounts entity has the following fields:

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.

bank_account

object The contact's bank account details.

ifsc

string Beneficiary bank IFSC. For example, HDFC0000053.

bank_name

string The contact's bank name. For example, HDFC.

name

string Account holder's name. For example,Gaurav Kumar.

account_number

string Beneficiary account number. For example, 765432123456789.

vpa

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

username

string The username portion of the virtual payment address. For example, gaurav.kumar.

handle

string The handle portion of the virtual payment address. For example, exampleupi.

address

string The virtual payment address. For example, gaurav.kumar@exampleupi.

card

object The details of the card used.

name

string The name of the cardholder. For example, Gauri Kumari.

last4

string The last four digits of the card. For example, 0011.

network

string The network issuer of the card.
Possible values are Visa or Mastercard.

type

string The type of card details provided. For example, credit or debit.

issuer

string The name of the aggregator/bank that has issued the card. For example, HDFC, ICICI and more.

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

account_status

string Displays if the account is valid or not. Possible values:

active
null

registered_name

string The name linked to the account. For example,Gaurav Kumar or null.

created_at

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

{
  "id" : "fa_00000000000001",
  "entity": "fund_account",
  "contact_id" : "cont_00000000000001",
  "account_type": "bank_account",
  "bank_account": {
    "ifsc": "HDFC0000053",
    "bank_name": "HDFC Bank",
    "name": "Gaurav Kumar",
    "account_number": "765432123456789",
    "notes": []
  },
  "active": true,
  "batch_id": null,
  "created_at": 1543650891
}

Error Codes

If there are errors when firing the

Fund Account APIs

, refer to

Fund Account API Error Codes

to resolve them.

Webhooks

Set up RazorpayX Webhooks

to configure and receive notifications when a specific

event

occurs. When one of these events is triggered, we send an HTTP POST

payload

in JSON to the webhook's configured URL.