Beneficiary

Sub-module with APIs for adding and verifying beneficiaries for the linked business account. Some of the key functions that you can do here are -

  • Add a new beneficiary to this account
  • Verify the status of a beneficiary
  • Retrieve the details of all beneficiaries added to the linked business account via these APIs

Add New Beneficiary

Add a new beneficiary for sending money from the business account.

curl --location --request POST 'https://in.staging.decentro.tech/v2/banking/beneficiary' \
--header 'client_id: <YOUR_CLIENT_ID>' \
--header 'client_secret: <YOUR_CLIENT_SECRET>' \
--header 'module_secret: <YOUR_BANKING_MODULE_SECRET>' \
--header 'provider_secret: <YOUR_CHOSEN_PROVIDER_SECRET>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "action": "ADD",
    "sender_account_number": "XXXXXXXXXXXX",
    "account_number": "462515XXXXXXXXXXXX",
    "name": "Decentro Account",
    "ifsc": "YESB0CMSNOC",
    "transfer_type": "IMPS",
    "email": "[email protected]",
    "mobile": "XXXXXXXXXX",
    "nickname": "nickNameForAccount"
}'
{
  "decentroTxnId": "DCTRTXXXXXXXXXXXXXXXXX",
  "status": "SUCCESS",
  "responseCode": "S00000",
  "message": "Beneficiary added successfully.",
  "data": {
    "ifsc": "YESB0CMSNOC",
    "accountNumber": "462515XXXXXXXXXXXX",
    "beneficiaryCode": "DEC462515XXXXXXXXXXXXIMPS",
    "beneficiaryNickname": "nickNameForAccount"
  }
}

Verify Beneficiary

Verify the added beneficiary for sending money from the business account.

curl --location --request POST 'https://in.staging.decentro.tech/v2/banking/beneficiary' \
--header 'client_id: <YOUR_CLIENT_ID>' \
--header 'client_secret: <YOUR_CLIENT_SECRET>' \
--header 'module_secret: <YOUR_BANKING_MODULE_SECRET>' \
--header 'provider_secret: <YOUR_CHOSEN_PROVIDER_SECRET>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "action": "VERIFY",
    "sender_account_number": "XXXXXXXXXXXX",
    "account_number": "462515XXXXXXXXXXXX",
    "ifsc": "YESB0CMSNOC",
    "transfer_type": "IMPS"
}'
{
  "decentroTxnId": "DCTRTXXXXXXXXXXXXXXXXX",
  "status": "SUCCESS",
  "responseCode": "S00000",
  "message": "Beneficiary verified successfully.",
  "data": {
    "ifsc": "YESB0CMSNOC",
    "accountNumber": "462515XXXXXXXXXXXX",
    "beneficiaryCode": "DEC462515XXXXXXXXXXXXIMPS",
    "beneficiaryName": "Decentro Account",
    "beneficiaryNickname": "nickNameForAccount"
  }
}

Get All Beneficiaries

Retrieve the details of all beneficiaries added to the linked business account via these APIs.

curl --location --request GET 'https://in.staging.decentro.tech/v2/banking/account/XXXXXXXXXXXX/beneficiary' \
--header 'client_id: <YOUR_CLIENT_ID>' \
--header 'client_secret: <YOUR_CLIENT_SECRET>' \
--header 'module_secret: <YOUR_BANKING_MODULE_SECRET>' \
--header 'provider_secret: <YOUR_CHOSEN_PROVIDER_SECRET>'
{
  "decentroTxnId": "DCTRTXXXXXXXXXXXXXXXXX",
  "status": "SUCCESS",
  "responseCode": "S00000",
  "message": "Beneficiary list retrieved successfully",
  "data": [
    {
      "ifsc": "YESB0CMSNOC",
      "accountNumber": "462515XXXXXXXXXXXX",
      "beneficiaryCode": "DEC462515XXXXXXXXXXXXIMPS",
      "beneficiaryName": "Decentro YBL Account",
      "beneficiaryNickname": "nickNameForAccount"
    },
    {
      "ifsc": "YESB0CMSNOC",
      "accountNumber": "462515XXXXXXXXXXXX",
      "beneficiaryCode": "DEC462515XXXXXXXXXXXXNEFT",
      "beneficiaryName": "Decentro ICICI Account",
      "beneficiaryNickname": "nickNameForBankAccount"
    }
  ]
}