Personal Message

The personalMessage API call is used to send an email message to a Vault customer.

The message will need to be base64 encoded to prevent certain characters in your message from breaking the JSON.

This is only possible if the user has approved your access.
(see Listing Accounts and Account Details)

JSON request

Parameters:
uid: the unique reference used when creating the account.
message: Base64 encoded message to your customer.
{
  "action": "personalMessage",
  "uid": 1001,
  "message": "-- Base64 encoded string --"
}

JSON response

Success:

{
  "error": "",
  "status": "success",
  "data": "-- Base64 encoded AES-256-CBC encrypted JSON --",
  "action": "personalMessage",
  "version": "1.07",
  "proc_time": 1651428510,
  "proc_id": 86
}

"data" (decrypted)
{}

Failure:

{
  "error": "invalid uid",
  "status": "failure",
  "data": "-- Base64 encoded AES-256-CBC encrypted JSON --",
  "action": "personalMessage",
  "version": "1.07",
  "proc_time": 1651428362,
  "proc_id": 85
}

"data" (decrypted)
{}

Common errors

no uid: uid missing

invalid uid: account uid unauthorised or invalid

not approved: The the user hasn't approved your access.

no message: message empty or missing

<?php
	print_r(request([
		'action'=>'personalMessage',  
		'uid'=>1001,
		'message'=>base64_encode('Hello World')
	]));

    /*############### OUTPUT ##################
	
	Array(
        [error] => 
        [status] => success
        [data] => {}
        [action] => personalMessage
        [version] => 1.07
        [proc_time] => 1651428510
        [proc_id] => 86
    )

    #########################################*/

?>
Copy Code