Delete Beneficiary (Atlas)

Overview

The DELETE /banking/ibans/v2/recipients/{recipientId} endpoint deletes an existing beneficiary record from your organization.

Once deleted:

• The recipient can no longer be used as a payout destination in new payment transfers.
• Historical payment records and compliance audit logs referencing this recipient remain intact for auditing purposes.

Resource Access

• HTTP Method: DELETE
• Endpoint: /banking/ibans/v2/recipients/{recipientId}
• Authentication: Bearer token required

Request Headers

Header	Value	Required	Description
Authorization	Bearer {access_token}	Yes	JWT Bearer access token
Accept	application/json	Yes	Response payload format
x-api-key	string	No	Optional API key

Path Parameters

Parameter	Type	Required	Description
recipientId	string	Yes	Unique identifier of the beneficiary record to remove.

Response

Success Response (200 OK)

{
  "success": true
}

Response Fields

Field	Type	Description
success	boolean	Returns true upon successful deletion.

Error Responses

• 400 Bad Request: Invalid recipientId parameter format.
• 401 Unauthorized: Missing or expired Bearer token.
• 404 Not Found: Beneficiary ID not found or already deleted.
• 500 Internal Server Error: Internal platform error.

Code Examples

cURL

curl -X DELETE "https://gateway.ahrvo.network/banking/ibans/v2/recipients/948201" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Accept: application/json"

Python

import requests

url = "https://gateway.ahrvo.network/banking/ibans/v2/recipients/948201"
headers = {
    "Authorization": "Bearer YOUR_ACCESS_TOKEN",
    "Accept": "application/json"
}

response = requests.delete(url, headers=headers)
print(response.status_code, response.json())

JavaScript (Node.js)

const axios = require('axios');

const url = 'https://gateway.ahrvo.network/banking/ibans/v2/recipients/948201';
const headers = {
  'Authorization': 'Bearer YOUR_ACCESS_TOKEN',
  'Accept': 'application/json'
};

axios.delete(url, { headers })
  .then(res => console.log('Deletion status:', res.data))
  .catch(err => console.error(err.response ? err.response.data : err.message));

Interactive API Explorer