Create Beneficiary Account

POST /beneficiaries

Description

Create a new beneficiary account.

Path Parameters

Name	Type	Description
None		No parameters

Request Headers

Name	Type	Description
countryCode	string	The country code (header)
tenantId	string	The tenant ID (header)
userId	string	The user ID (header)

Request Body

• Content Type: application/json

{
  "firstName": "string",
  "lastName": "string",
  "middleName": "string",
  "bankName": "string",
  "bankCode": "string",
  "accountNumber": "string",
  "phoneNumber": "string",
  "accountId": "string",
  "userId": "string",
  "beneficiaryTag": "string",
  "deleted": true,
  "alias": "string"
}

Example

POST /beneficiaries
Content-Type: application/json
countryCode: string
tenantId: string
userId: string

{
  "firstName": "John",
  "lastName": "Doe",
  "middleName": "M",
  "bankName": "Sample Bank",
  "bankCode": "001",
  "accountNumber": "123456789",
  "phoneNumber": "9876543210",
  "accountId": "acc123",
  "userId": "usr456",
  "beneficiaryTag": "friend",
  "deleted": false,
  "alias": "Johnny"
}

Response Code: 200 - OK

Description

Beneficiary created successfully.

Response Fields

Field	Type	Description
status	boolean	Indicates if the operation was successful
statusCode	integer	Status code
message	string	Response message
data	object	Data related to the beneficiary account
errors	array	List of error messages, if any

Example

{
  "status": true,
  "statusCode": 0,
  "message": "Beneficiary created successfully",
  "data": {},
  "errors": [
    {
      "message": "Some error occurred",
      "descriptiveMessage": "Detailed error message"
    }
  ]
}

Headers

Content-Type	Value
apiKey	{{apiKey}}
countryCode	string
tenantId	string
userId	string

Body

{
  "firstName": "John",
  "lastName": "Doe",
  "middleName": "M",
  "bankName": "Sample Bank",
  "bankCode": "001",
  "accountNumber": "123456789",
  "phoneNumber": "9876543210",
  "accountId": "acc123",
  "userId": "usr456",
  "beneficiaryTag": "friend",
  "deleted": false,
  "alias": "Johnny"
}

🔑 Authentication bearer

Param	Value	Type
token	{{accessCode}}	string