Loading...
Retrieves the list of all saved beneficiaries for the authenticated user. This endpoint provides access to previously saved recipient details for easy selection during transfers.
KEY | VALUE | DESCRIPTION |
---|---|---|
X-API-Key | X-API-Key | - |
X-API-Secret | X-API-Secret | - |
// Using fetch API
const response = await fetch("http://localhost:5000/api/v1/developer/beneficiaries/list", {
method: "GET",
headers: {
"X-API-Key": "X-API-Key",
"X-API-Secret": "X-API-Secret"
}
});
const data = await response.json();
console.log(data);
Parameter | Type | Required | Description |
---|
{}
Success response
{
"statusCode": 200
"message": "Beneficiaries retrieved successfully"
"data" [
{
"_id": "65f8a123b42c87e1234a9876"
"userId": "65f8a123b42c87e1234a5432"
"accountName": "John Doe"
"accountNumber": "0123456789"
"bankCode": "044"
"bankName": "Access Bank"
"nameEnquiryReference": "NEQ123456789"
"nickname": "John's Account"
"isFavorite": false
"createdAt": "2024-03-18T14:23:45.000Z"
"updatedAt": "2024-03-18T14:23:45.000Z"
},
{
"_id": "65f8a123b42c87e1234a9877"
"userId": "65f8a123b42c87e1234a5432"
"accountName": "Jane Smith"
"accountNumber": "9876543210"
"bankCode": "058"
"bankName": "Guaranty Trust Bank"
"nameEnquiryReference": "NEQ987654321"
"nickname": "Jane"
"isFavorite": true
"createdAt": "2024-03-17T10:15:30.000Z"
"updatedAt": "2024-03-17T10:15:30.000Z"
}
]
}