Get a Beneficiary (Legacy)

Overview

This service is used to get the complete details of a specific beneficiary by their unique beneficiaryId, including bank information, addresses, and current status.

Resource Access

• HTTP Method: GET
• Endpoint: /profile/v2.1/beneficiaries/{beneficiaryId}
• Authentication: Bearer token required

Request Headers

Header	Value	Required	Description
Accept	application/json	Yes	Content type for the response
Authorization	Bearer {access_token}	Yes	Bearer token for authentication
x-api-key	string	No	API key for additional authentication

Path Parameters

Parameter	Type	Required	Description
beneficiaryId	number	Yes	The unique ID of the beneficiary (e.g. 284).

Response

Success Response (200 OK)

{
  "success": true,
  "account": {
    "id": 284,
    "accountNumber": "2000293918130",
    "bankName": "PUNJAB NATIONAL BANK",
    "beneficiaryAddress": "INSTITUTIONAL AREA, PLOT, NO.05 PNB SWIFT CENTRE",
    "beneficiaryCity": "HARYANA",
    "beneficiaryCompanyName": "Ahrvo",
    "beneficiaryCountryCode": "IN",
    "beneficiaryEntityType": "company",
    "beneficiaryPostcode": "122001",
    "country": "India",
    "reference": "RP-16062022-001",
    "beneficiaryFirstName": "Jon",
    "beneficiaryLastName": "Doe",
    "nationalId": "PUNB0644100",
    "currency": "INR",
    "clientReference": "string",
    "status": "approved"
  }
}

Response Fields

Field	Type	Description
success	boolean	Indicates whether the request was successful.
account.id	number	Unique ID of the beneficiary.
account.accountNumber	string	Account number on file.
account.bankName	string	Bank name.
account.status	string	Current status (approved, pending, etc.).

Error Responses

• 400 Bad Request: Invalid parameters or malformed request
• 401 Unauthorized: Missing or invalid Bearer authentication token
• 403 Forbidden: Insufficient account permissions
• 404 Not Found: Resource not found
• 500 Internal Server Error: An internal server error occurred

Code Examples

Base URL

Production: https://api.ahrvo.network
Staging:    https://gateway.ahrvo.network

cURL

curl -X GET \
  'https://gateway.ahrvo.network/banking/ibans/v2/profile/v2.1/beneficiaries/284' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Python

import requests

url = "https://gateway.ahrvo.network/banking/ibans/v2/profile/v2.1/beneficiaries/284"
headers = {
    "Accept": "application/json",
    "Authorization": "Bearer YOUR_ACCESS_TOKEN"
}

response = requests.get(url, headers=headers)
print(response.json())

JavaScript (Node.js)

const axios = require('axios');

const beneficiaryId = 284;
const url = `https://gateway.ahrvo.network/banking/ibans/v2/profile/v2.1/beneficiaries/${beneficiaryId}`;
const headers = {
  'Accept': 'application/json',
  'Authorization': 'Bearer YOUR_ACCESS_TOKEN'
};

axios.get(url, { headers })
  .then(response => console.log(response.data))
  .catch(error => console.error(error.response ? error.response.data : error.message));

Usage Notes

• Use this endpoint to verify updated details or approval changes after creating a beneficiary.

Interactive API Explorer