List notifications

curl --request GET \
  --url https://int-data.moneydesktop.com/notifications \
  --header 'MD-SESSION-TOKEN: <api-key>'

import requests

url = "https://int-data.moneydesktop.com/notifications"

headers = {"MD-SESSION-TOKEN": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {'MD-SESSION-TOKEN': '<api-key>'}};

fetch('https://int-data.moneydesktop.com/notifications', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://int-data.moneydesktop.com/notifications",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "MD-SESSION-TOKEN: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://int-data.moneydesktop.com/notifications"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("MD-SESSION-TOKEN", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://int-data.moneydesktop.com/notifications")
  .header("MD-SESSION-TOKEN", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://int-data.moneydesktop.com/notifications")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["MD-SESSION-TOKEN"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "notifications": [
    {
      "created_on": "2022-04-01T12:58:08.000Z",
      "deep_link_guid": "BGT-e386a323-e452-47f2-b2fd-1ac3c18533de",
      "entity_guid": "BGT-e386a323-e452-47f2-b2fd-1ac3c18533de",
      "guid": "TF-b53294f5-2356-4782-9f81-ae064c42b40a",
      "has_been_viewed": false,
      "notification_type": 2,
      "notification_type_name": "BUDGET_OFF_TARGET",
      "subject": "You're projected to spend $1,920.07 more than you've budgeted for Fees & Charges. You've already spent $65.67 of $316.00.",
      "threshold": null
    }
  ]
}

GET

notifications

List notifications

curl --request GET \
  --url https://int-data.moneydesktop.com/notifications \
  --header 'MD-SESSION-TOKEN: <api-key>'

import requests

url = "https://int-data.moneydesktop.com/notifications"

headers = {"MD-SESSION-TOKEN": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {'MD-SESSION-TOKEN': '<api-key>'}};

fetch('https://int-data.moneydesktop.com/notifications', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://int-data.moneydesktop.com/notifications",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "MD-SESSION-TOKEN: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://int-data.moneydesktop.com/notifications"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("MD-SESSION-TOKEN", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://int-data.moneydesktop.com/notifications")
  .header("MD-SESSION-TOKEN", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://int-data.moneydesktop.com/notifications")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["MD-SESSION-TOKEN"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "notifications": [
    {
      "created_on": "2022-04-01T12:58:08.000Z",
      "deep_link_guid": "BGT-e386a323-e452-47f2-b2fd-1ac3c18533de",
      "entity_guid": "BGT-e386a323-e452-47f2-b2fd-1ac3c18533de",
      "guid": "TF-b53294f5-2356-4782-9f81-ae064c42b40a",
      "has_been_viewed": false,
      "notification_type": 2,
      "notification_type_name": "BUDGET_OFF_TARGET",
      "subject": "You're projected to spend $1,920.07 more than you've budgeted for Fees & Charges. You've already spent $65.67 of $316.00.",
      "threshold": null
    }
  ]
}

List all notifications.

Authorizations

MD-SESSION-TOKEN

string

header

required

MX Session Token

Request an API token using the read API token endpoint in the MX SSO API.
Exchange an API token for a session token.
- A session token is obtained by sending a POST request to /sessions
- The session token will be used in each request made for the user. It should be passed in an MD-SESSION-TOKEN HTTP header as shown below.
- This session token is valid for 30 minutes from the time it was created. The 30 minute expiration counter is refreshed with each call.
- If you send a request with an expired session token you'll receive an error code of 4011.

curl -i https://int-data.moneydesktop.com/accounts \
-H 'MD-SESSION-TOKEN: CWforZl1Vn2vC_v6H4rnQRT1DoWpDouJAV-_5TBmiQRAtA8rsOG_BoajTiOSsL0A3bd-bmHXlA-eQzc9ywItKg' \
-H 'Content-Type: application/vnd.mx.nexus.v1+json' \
-H 'Accept: application/vnd.mx.nexus.v1+json'

In documentation code examples, replace <API_KEY_VALUE> with the session token.

Query Parameters

from_date

string

Return transactions starting from this day. Defaults to 120 days ago if not provided. Format should be ISO 8601 format (2013-05-28).

to_date

string

Return transactions ending with this day. Defaults to 5 days forward from the day the request is made so as to capture pending transactions. Format should be ISO 8601 format (2013-05-28).

page

string

Results are returned in paginated sets, this is the page of the results you would like to view. Defaults to page 1 if no page is specified.

records_per_age

string

The supported range is from 10 to 1000. If the records_per_page parameter is not specified or is outside this range, a default of 25 records per page will be used.

Response

200 - application/vnd.mx.nexus.v1+json

notifications

object[]

Hide child attributes

notifications.created_on

string

Date the notification was created, as provided by our data feed. Represented in ISO 8601 format (e.g. 2011-03-28).

Example:

"2022-04-01T12:58:08.000Z"

notifications.deep_link_guid

string

The unique identifier for objects that directly trigger a notification. EX: TRANSACTION_FEE_CHARGE and TRANSACTION_EXPENSE_LARGE notification types will have a transaction guid in this field.

Example:

"BGT-e386a323-e452-47f2-b2fd-1ac3c18533de"

notifications.entity_guid

string

The unique identifier of the entity that the notification is attached to.

Example:

"BGT-e386a323-e452-47f2-b2fd-1ac3c18533de"

notifications.guid

string

Unique identifier for the notification. Defined by MX.

Example:

"TF-b53294f5-2356-4782-9f81-ae064c42b40a"

notifications.has_been_viewed

boolean

If the notification has been viewed, this field will be true. Otherwise, this field will be false.

Example:

false

notifications.notification_type

integer

Specific type of notification being sent. See notification types for more information.

Example:

2

notifications.notification_type_name

string

The name of the notification type. See notification types for more information.

Example:

"BUDGET_OFF_TARGET"

notifications.subject

string

The notification summary text. Usually the same text used for "in-app" or SMS deliverables.

Example:

"You're projected to spend $1,920.07 more than you've budgeted for Fees & Charges. You've already spent $65.67 of $316.00."

notifications.threshold

integer | null

The amount that needs to be succeeded before the user receives the notification.

Example:

null

Create notification

Read notification