Add New Beneficiary to Account

Prerequisites

The following data is required to make a successful API request:

1. Bearer Token of current User (refer to Get a Bearer Token – Equaze Help Documentation).
2. AccountERN of the Account you want to get the list of beneficiaries linked to it (refer to Get Information of User’s Account – Equaze Help Documentation).

Set Authorization to:

• Auth Type = Bearer Token
• Token = YourBearerToken

Use the following API URL with method = POST:

https://api.prd.enumis.co.uk/onlineaccount-api/beneficiary

If you want to add a personal beneficiary, use the following body:

{
    “beneficiary”: {
        “beneficiaryType”: “Person”,
        “accountName”: “BeneAccountName”,
        “firstName”: “BeneFirstName”,
        “lastName”: “BeneLastName”,
        “nickName”: “BeneNickName”,
        “bankName”: “BeneBankName”,
        “sortCode”: “111111”,
        “accountNumber”: “00001234”
    },
    “linkToAccountERN”: “YourAccountERN”
}

If you want to add a business beneficiary, use the following body:

{
    “beneficiary”: {
        “beneficiaryType”: “Business”,
        “accountName”: “BeneAccountName”,
        “businessName”: “BeneBusinessName”,
        “nickName”: “BeneNickName”,
        “bankName”: “BeneBankName”,
        “sortCode”: “111111”,
        “accountNumber”: “00001234”
    },
    “linkToAccountERN”: “YourAccountERN”
}

If you want a beneficiary having postal address to use CHAPS payment, use the following body which includes the postalAddress section:

{
    “beneficiary”: {
        “beneficiaryType”: “Person”,
        “firstName”: “BeneFirstName”,
        “lastName”: “BeneLastName”,
        “postalAddress”: {
                 “buildingNumber”: “BeneBuildingNumber”,
                 “buildingName”: “BeneBuildingName”,
                 “streetName”: “BeneStreetName”,
                 “townName”: “BeneTownName”,
                 “country”: “GB”,
                 “postCode”: “BenePostCode”
},
        “bankName”: “BeneBankName”,
        “sortCode”: “BeneSortCode”,
        “accountNumber”: “BeneAccountNumber”,
        “accountName”: “BeneAccountName”,
        “nickName”: “BeneNickName”
},
    “linkToAccountERN”:”YourAccountERN”
}

This will return true if the add request is successful:

{"result": true}

If your beneficiary already exists, system will return:

{
    “responseStatus”: {
        “errorCode”: “Exception”,
        “message”: “The Beneficiary Nickname Already Exists.”,
        “errors”: []
    },
    “result”: false
}

Fields validation:

Field	Max Length	(a-z & A-Z & 0-9)	Single Quote (‘) and Hyphen (-)	Ampersand (&)	Period (.)	Forward Slash (/)	Comma (,)
firstName	1-100	(a-z & A-Z)	Yes	No	No	No	No
lastName	1-100	(a-z & A-Z)	Yes	No	No	No	No
businessName	2-150	Yes	Yes	Yes	Yes	Yes	Yes
accountName	2-150	Yes	Yes	Yes	Yes	Yes	Yes
iBAN	22
accountNumber	8
sortCode	6
nickName	100	Yes	Yes	Yes	Yes	Yes	Yes
bankName	255	Yes	Yes	Yes	Yes	Yes	Yes