API LibraryBeneficiary
Fetch All Beneficiaries for Cardholder
Retrieves all registered IMPS beneficiaries for a cardholder. Returns both active and inactive beneficiaries. Use this endpoint to:
- Display the list of saved beneficiaries in your fund transfer UI
- Check if a beneficiary is already registered before attempting to add a new one
- Show the cardholder their beneficiary management dashboard
Response Details
Each beneficiary in the list includes:
- Bank account details (masked account number, IFSC, account name)
- Beneficiary type (SELF/OTHER)
- Current status (ACTIVE/INACTIVE)
Authorization
bearerAuth tenantId AuthorizationBearer <token>
JWT Bearer token from the Authentication API
In: header
X-TENANT-ID<token>
Your unique tenant identifier assigned during onboarding
In: header
Path Parameters
id*string
Unique entity identifier for the cardholder whose beneficiaries you want to fetch. This ID is returned during card issuance or can be obtained from the Customer Fetch API.
Header Parameters
X-TENANT-ID*string
Your unique tenant identifier assigned during partner onboarding
Response Body
application/json
application/json
curl -X GET "https://sandbox-api.m2pprepaid.com/prepaid/customer/v1/imps/beneficiary/fetch/entity/798782647420001622070825" \ -H "X-TENANT-ID: ACME_CORP"Cardholder with both active and inactive beneficiaries
{
"result": [
{
"entityId": "798782647420001622070825",
"accountNumber": "912010036724556",
"ifscCode": "UTIB0001234",
"accountName": "Rajesh Kumar",
"beneType": "SELF",
"status": "ACTIVE"
},
{
"entityId": "798782647420001622070825",
"accountNumber": "10234567891234",
"ifscCode": "SBIN0001234",
"accountName": "Priya Sharma",
"beneType": "OTHER",
"status": "ACTIVE"
},
{
"entityId": "798782647420001622070825",
"accountNumber": "50100123456789",
"ifscCode": "HDFC0001234",
"accountName": "Rajesh Kumar",
"beneType": "SELF",
"status": "INACTIVE"
}
],
"pagination": null
}{
"type": "https://www.m2pfintech.com/problem/problem-with-message",
"title": "Customer does not exist",
"status": 409,
"detail": "Customer does not exist for id: 798782647420001622070825",
"message": "error.business",
"businessCode": "PPCUST_002"
}