Beneficiary

This set of APIs pertains to wallet beneficiaries, essentially enabling the consumers to add beneficiaries (and fetch their details) against their wallets as intended recipients of outgoing transfers.

Add Beneficiary

This API allows creation of a beneficiary against the wallet associated with the specified mobile and responds with a PPI provider assigned beneficiary code.

Both the involved wallets/ holder wallet (in case the intended beneficiary is a bank account) having Full KYC enabled is a pre-requisite for the success of this API.

Different providers place different limits on the number of beneficiaries that can be created per day per wallet:

ProviderNumber of beneficiaries which can be successfully added per day per wallet
Yes Bank5
curl --location --request POST 'https://in.staging.decentro.tech/v2/prepaid/wallet/9000000009/beneficiary' \
--header 'client_id: YOUR_CLIENT_ID' \
--header 'client_secret: YOUR_CLIENT_SECRET' \
--header 'module_secret: YOUR_PREPAID_MODULE_SECRET' \
--header 'provider_secret: YOUR_CHOSEN_PROVIDER_SECRET' \
--header 'Content-Type: application/json' \
--data-raw '{
    "reference_id": "GGG",
    "purpose": "test_purpose",
    "consent": true,
    "name": {
        "first": "first",
        "middle": "middle",
        "last": "last",
        "nickname": "test acc bene"
    },
    "account": {
        "number": "XXXXXXXXXXXXXXXXXX",
        "ifsc": "QWER0000PQR",
        "type": "SAVINGS"
    }
}'
{
  "decentroTxnId": "DECXXXXXXXXXXXXXXXXXXXXXXXXXXX",
  "status": "SUCCESS",
  "responseCode": "S00000",
  "message": "Transaction successful",
  "data": {
    "transactionStatus": "SUCCESS",
    "transactionDescription": "Wallet beneficiary added successfully",
    "beneficiaryCode": "123XXX"
  }
}

Fetch Beneficiary Details

This API allows fetching of the details of the provided beneficiary connected with the wallet associated with the specified mobile.

curl --location --request GET 'https://in.staging.decentro.tech/v2/prepaid/wallet/9000000009/beneficiary/some_beneficiary_code' \
--header 'client_id: YOUR_CLIENT_ID' \
--header 'client_secret: YOUR_CLIENT_SECRET' \
--header 'module_secret: YOUR_PREPAID_MODULE_SECRET' \
--header 'provider_secret: YOUR_CHOSEN_PROVIDER_SECRET'
{
  "decentroTxnId": "DECXXXXXXXXXXXXXXXXXXXXXXXXXXX",
  "status": "SUCCESS",
  "responseCode": "S00000",
  "message": "Transaction successful",
  "data": {
    "transactionStatus": "SUCCESS",
    "transactionDescription": "Beneficiary details fetched successfully",
    "count": 1,
    "details": [
      {
        "beneficiaryCode": "00A",
        "beneficiaryName": "John Doe",
        "beneficiaryNickname": "JD",
        "accountNumber": "1234XXXXXX",
        "ifsc": "ICIC00XXXXX",
        "accountType": "SAVINGS",
        "mobile": "NA",
        "type": "ACCOUNT",
        "status": "ACTIVE"
      }
    ]
  }
}

Fetch Consolidated Details

This API allows to fetching of the details of all the beneficiaries connected with the wallet associated with the specified mobile.

curl --location --request GET 'https://in.staging.decentro.tech/v2/prepaid/wallet/9000000009/beneficiary' \
--header 'client_id: YOUR_CLIENT_ID' \
--header 'client_secret: YOUR_CLIENT_SECRET' \
--header 'module_secret: YOUR_PREPAID_MODULE_SECRET' \
--header 'provider_secret: YOUR_CHOSEN_PROVIDER_SECRET'
{
  "decentroTxnId": "DECXXXXXXXXXXXXXXXXXXXXXXXXXXX",
  "status": "SUCCESS",
  "responseCode": "S00000",
  "message": "Transaction successful",
  "data": {
    "transactionStatus": "SUCCESS",
    "transactionDescription": "Beneficiary details fetched successfully",
    "count": 3,
    "details": [
      {
        "beneficiaryCode": "00A",
        "beneficiaryName": "John Doe",
        "beneficiaryNickname": "JD",
        "accountNumber": "1234XXXXXX",
        "ifsc": "ICIC00XXXXX",
        "accountType": "SAVINGS",
        "mobile": "NA",
        "type": "ACCOUNT",
        "status": "ACTIVE"
      },
      {
        "beneficiaryCode": "00B",
        "beneficiaryName": "John Doe 1",
        "beneficiaryNickname": "JD1",
        "accountNumber": "1234XXXXX1",
        "ifsc": "ICIC00XXXXX",
        "accountType": "BUSINESS",
        "mobile": "NA",
        "type": "ACCOUNT",
        "status": "ACTIVE"
      },
      {
        "beneficiaryCode": "00C",
        "beneficiaryName": "John Doe 2",
        "beneficiaryNickname": "1234XXXXX2",
        "accountNumber": "NA",
        "ifsc": "NA",
        "accountType": "NA",
        "mobile": "XXXXXXXXXX",
        "type": "WALLET",
        "status": "ACTIVE"
      }
    ]
  }
}