Create a Beneficiary

Overview

Registers a new individual or corporate payout beneficiary account, validating bank routing numbers, SWIFT/BIC codes, and entity details prior to initiating payouts.

HTTP Request

POST /banking/ibans/v2/profile/v2.1/beneficiaries

Authentication

This endpoint requires an active Bearer JWT token in the Authorization header obtained via POST /banking/ibans/v2/users/login:

Authorization: Bearer <your_access_token>

Request Body Fields

Field	Type	Description
beneficiaryEntityType	str	Sample value: company
beneficiaryFirstName	str	Sample value: ``
beneficiaryLastName	str	Sample value: ``
beneficiaryCompanyName	str	Sample value: OLSEN INDUSTRIA E COMERCIO SA
currency	str	Sample value: NGN
beneficiaryCountryCode	str	Sample value: NG
accountNumber	str	Sample value: 2000293918130
nationalId	str	Sample value: PUNB0644100
country	str	Sample value: India
clientReference	str	Sample value: Test-Bene100

Code Examples

cURL

curl -X POST "https://api.ahrvo.network/banking/ibans/v2/profile/v2.1/beneficiaries" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <your_access_token>" \
  -d '{
  "beneficiaryEntityType": "company",
  "beneficiaryFirstName": "",
  "beneficiaryLastName": "",
  "beneficiaryCompanyName": "OLSEN INDUSTRIA E COMERCIO SA",
  "currency": "NGN",
  "beneficiaryCountryCode": "NG",
  "accountNumber": "2000293918130",
  "nationalId": "PUNB0644100",
  "country": "India",
  "clientReference": "Test-Bene100"
}'

JavaScript (Axios)

import axios from 'axios';

const response = await axios.post('https://api.ahrvo.network/banking/ibans/v2/profile/v2.1/beneficiaries', {
  "beneficiaryEntityType": "company",
  "beneficiaryFirstName": "",
  "beneficiaryLastName": "",
  "beneficiaryCompanyName": "OLSEN INDUSTRIA E COMERCIO SA",
  "currency": "NGN",
  "beneficiaryCountryCode": "NG",
  "accountNumber": "2000293918130",
  "nationalId": "PUNB0644100",
  "country": "India",
  "clientReference": "Test-Bene100"
}, {
  headers: {
    'Content-Type': 'application/json',
    'Authorization': 'Bearer <your_access_token>'
  }
});

console.log(response.data);

Python (Requests)

import requests

url = "https://api.ahrvo.network/banking/ibans/v2/profile/v2.1/beneficiaries"
headers = {
    "Content-Type": "application/json",
    "Authorization": "Bearer <your_access_token>" 
}
payload = {
  "beneficiaryEntityType": "company",
  "beneficiaryFirstName": "",
  "beneficiaryLastName": "",
  "beneficiaryCompanyName": "OLSEN INDUSTRIA E COMERCIO SA",
  "currency": "NGN",
  "beneficiaryCountryCode": "NG",
  "accountNumber": "2000293918130",
  "nationalId": "PUNB0644100",
  "country": "India",
  "clientReference": "Test-Bene100"
}

response = requests.post(url, json=payload, headers=headers)
print(response.json())

Response (201)

{
  "success": true,
  "account": {
    "id": 284,
    "accountNumber": "2000293918130",
    "bankName": "PUNJAB NATIONAL BANK",
    "beneficiaryAddress": "INSTITUTIONAL AREA, PLOT, NO.05 PNB SWIFT CENTRE - FLOOR 1 GURUGRAM - SECTOR 32",
    "beneficiaryCity": "HARYANA",
    "beneficiaryCompanyName": "OLSEN INDUSTRIA E COMERCIO SA",
    "beneficiaryCountryCode": "IN",
    "beneficiaryEntityType": "company",
    "country": "India",
    "reference": "RP-09062022-003",
    "beneficiaryFirstName": "",
    "beneficiaryLastName": "",
    "nationalId": "PUNB0644100",
    "currency": "INR",
    "clientReference": "Test-Bene100",
    "status": "approved"
  }
}

Interactive API Explorer

Test this endpoint live against the Ahrvo gateway and Verto sandbox environments: