v1

latestOpenAPI 3.1.02026-07-2414704.6 MB

Beneficiary Registration

This API is used to create the beneficiary.

post/beneficiaryRegistration

Response

200

statuscodestring

{"stackTrail":"paths:/beneficiaryRegistration:post:responses:200:content:application/json:schema:properties:actcode","oasType":"schema","type":"unknown"}

statusstring

timestampstring

ipay_uuidstring

{"stackTrail":"paths:/beneficiaryRegistration:post:responses:200:content:application/json:schema:properties:orderid","oasType":"schema","type":"unknown"}

environmentstring

{"stackTrail":"paths:/beneficiaryRegistration:post:responses:200:content:application/json:schema:properties:internalCode","oasType":"schema","type":"unknown"}

Example response

{
  "statuscode": "TXN",
  "status": "Transaction Successful",
  "data": {
    "id": "649717",
    "mobile": "7428585742",
    "firstName": "Sample Name",
    "gender": "Male",
    "dob": "1995-01-01",
    "address": "Sample Address",
    "city": "City Name",
    "state": "State Name",
    "district": "District Name",
    "nationality": "Nationality",
    "employer": "Business Name",
    "incomeSource": "Business",
    "status": "Unverified",
    "approveStatus": "Commented",
    "approveComment": "PHOTO IS NOT CLEAR",
    "ids": [
      {
        "idType": "Aadhaar Card",
        "idNumber": "XXXXXXXX6077"
      }
    ],
    "transactionCount": {
      "day": "0",
      "month": "0",
      "year": "0"
    },
    "beneficiaries": [
      {
        "id": "1036010",
        "name": "Sample Name",
        "gender": "Male",
        "relationship": "Brother",
        "address": "DELHI",
        "mobile": "9876543210",
        "paymentMode": "Cash Payment"
      }
    ]
  },
  "timestamp": "2022-10-17 10:24:56",
  "ipay_uuid": "h00597852d7b-e20d-4d5b-9686-50e394d0b64f",
  "environment": "LIVE"
}