m2pfintech
API LibraryBeneficiary

Delete Beneficiary

Deletes an IMPS beneficiary by account number and IFSC code, with OTP verification.

DELETE
/v1/imps/beneficiary/delete

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

Header Parameters

X-TENANT-ID*string

Your unique tenant identifier assigned during partner onboarding

Request Body

application/json

entityId*string

Required. Customer entity ID

Length1 <= length
accountNumber*string

Required. Account number of beneficiary to delete

Length1 <= length
ifscCode*string

Required. IFSC code of beneficiary to delete

Length1 <= length
otpDetails?

OTP verification details

Response Body

application/json

application/json

curl -X DELETE "https://sandbox-api.m2pprepaid.com/prepaid/customer/v1/imps/beneficiary/delete" \  -H "X-TENANT-ID: ACME_CORP" \  -H "Content-Type: application/json" \  -d '{    "entityId": "string",    "accountNumber": "string",    "ifscCode": "string"  }'
{
  "result": {},
  "pagination": {
    "list": true,
    "pageSize": 0,
    "pageNo": 0,
    "totalPages": 0,
    "totalElements": 0
  }
}
{
  "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.http.400",
  "businessCode": "PPCUST_002",
  "cause": {},
  "errorCode": "string",
  "errors": [
    "string"
  ],
  "languageCode": "string",
  "localizedMessage": "string",
  "suppressed": [
    {}
  ]
}

Validate OTP POST

Validates the OTP entered by the customer against the previously generated OTP. ### Flow 1. Call Generate OTP → get `traceNumber` 2. Customer enters OTP 3. Call this endpoint with `traceNumber` + OTP ### Validation Limits - Maximum **3 validation attempts** per OTP within 24 hours - After 3 failed attempts, a new OTP must be generated ### Response On success, returns a `messageHash` that may be required by subsequent operations as proof of OTP verification.

Fetch All Beneficiaries for Cardholder GET

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)