Get All Beneficiary API

GET

https://api.staging.indiconnect.in/openPayout/getAllBeneficiary

Last modified:2025-03-01 09:37:25

This API retrieves a list of all beneficiaries added to the system. It provides details of each beneficiary, such as their bank account or VPA, making it easier to manage and track all linked beneficiaries.

Request

Query Params

Header Params

Responses

🟢200Get All Beneficiary Example

application/json

Body

🟢200Filter With Bank Account Number Example

🟢200Filter VPA from Beneficiary API Example

🟢200Get All Beneficiary Using Beneficiary Type Example

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET 'https://api.staging.indiconnect.in/openPayout/getAllBeneficiary?bankAccountNumber=30142708080&vpa=9823676512@paytm&beneficiaryType=account_number' \
--header 'Authorization: x-api-access indc_test_8c8574b6254b184e:ac_test_8f42a996a39a7ce4' \
--header 'service-key: sk_test_922bb2b90f90afac'

Response Example

200 - Get All Beneficiary Example - Get All Beneficiary Example

{
    "status": "SUCCESS",
    "message": "Data fetched successfully",
    "data": [
        {
            "bankIfscCode": "SBIN0001135",
            "beneficiaryId": "vab_2wO4vt4v0KllckpE2PYVLJInx",
            "beneficiaryType": "account_number",
            "createdAt": 1703232823367,
            "bankAccountNumber": "35115392897",
            "walletId": "2423f8b8-ec47-4756-b89f-af9170131400",
            "email": "ruturaj.singareh@example.com",
            "name": "ruturaj singare",
            "clientId": "ae62dd0b-760a-481c-8746-021b42ffad7d",
            "virtualWalletId": "VW_6885137768",
            "beneficiaryObject": "beneficiary.account_number",
            "bankName": null,
            "primaryAccountId": "va_j4nWhb2i4QVWjOBPrc52zvYTA",
            "beneficiaryStatus": "active"
        },
        {
            "bankIfscCode": "BKID0000123",
            "beneficiaryId": "vab_BwjHCcxP1NVtITZeZNMLBkPpB",
            "beneficiaryType": "account_number",
            "createdAt": 1703232503422,
            "bankAccountNumber": "598994038173",
            "walletId": "2423f8b8-ec47-4756-b89f-af9170131400",
            "email": "vaish.deshmukh@example.com",
            "name": "vaish deshmukh",
            "clientId": "ae62dd0b-760a-481c-8746-021b42ffad7d",
            "virtualWalletId": "VW_6885137768",
            "beneficiaryObject": "beneficiary.account_number",
            "bankName": null,
            "primaryAccountId": "va_j4nWhb2i4QVWjOBPrc52zvYTA",
            "beneficiaryStatus": "active"
        },
        {
            "bankIfscCode": "ABCD0000123",
            "beneficiaryId": "vab_Ccd8T2Y5Opxyyc7t1Ni91CnBp",
            "beneficiaryType": "account_number",
            "createdAt": 1703232394505,
            "bankAccountNumber": "59817294038173",
            "walletId": "2423f8b8-ec47-4756-b89f-af9170131400",
            "email": "anil.reddy@example.com",
            "name": "Anil Reddy",
            "clientId": "ae62dd0b-760a-481c-8746-021b42ffad7d",
            "virtualWalletId": "VW_6885137768",
            "beneficiaryObject": "beneficiary.account_number",
            "bankName": null,
            "primaryAccountId": "va_j4nWhb2i4QVWjOBPrc52zvYTA",
            "beneficiaryStatus": "active"
        },
        {
            "bankIfscCode": "SBIN0001135",
            "beneficiaryId": "vab_bVvFaQAyJ6fA65an21vowrOh2",
            "beneficiaryType": "account_number",
            "createdAt": 1703232795944,
            "bankAccountNumber": "35115392567",
            "walletId": "2423f8b8-ec47-4756-b89f-af9170131400",
            "email": "ruturaj.singareh@example.com",
            "name": "ruturaj singare",
            "clientId": "ae62dd0b-760a-481c-8746-021b42ffad7d",
            "virtualWalletId": "VW_6885137768",
            "beneficiaryObject": "beneficiary.account_number",
            "bankName": null,
            "primaryAccountId": "va_j4nWhb2i4QVWjOBPrc52zvYTA",
            "beneficiaryStatus": "active"
        }
    ],
    "code": 200
}

Modified at 2025-03-01 09:37:25

Create Transfer to VPA

Get All Transfer Details