Get get_beneficiary_by_uuid

GET /beneficiaries/{uuId}

Description

Get a beneficiary by UUID.

Path Parameters

Name	Type	Description
uuId	string	The UUID of the beneficiary (path)

Request Headers

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

Query Parameters

Name	Type	Description
userId	string	The user ID (query)

Example

GET /beneficiaries/{uuId}
Content-Type: application/json
countryCode: string
tenantId: string
userId: string

{
  "userId": "usr456"
}

Response Code: 200 - OK

Description

Successful.

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 retrieved successfully",
  "data": {},
  "errors": [
    {
      "message": "Some error occurred",
      "descriptiveMessage": "Detailed error message"
    }
  ]
}

Headers

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

Query Parameters

Name	Value	Type
userId	usr456	string

🔑 Authentication bearer

Param	Value	Type
token	{{accessCode}}