Create a scheduled payment

curl --request POST \
  --url https://int-data.moneydesktop.com/scheduled_payments \
  --header 'Content-Type: application/vnd.mx.nexus.v1+json' \
  --header 'MD-SESSION-TOKEN: <api-key>' \
  --data '{}'

import requests

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

payload = {}
headers = {
    "MD-SESSION-TOKEN": "<api-key>",
    "Content-Type": "application/vnd.mx.nexus.v1+json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'MD-SESSION-TOKEN': '<api-key>',
    'Content-Type': 'application/vnd.mx.nexus.v1+json'
  },
  body: JSON.stringify({})
};

fetch('https://int-data.moneydesktop.com/scheduled_payments', 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/scheduled_payments",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/vnd.mx.nexus.v1+json",
    "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"
	"strings"
	"net/http"
	"io"
)

func main() {

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

	payload := strings.NewReader("{}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("MD-SESSION-TOKEN", "<api-key>")
	req.Header.Add("Content-Type", "application/vnd.mx.nexus.v1+json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://int-data.moneydesktop.com/scheduled_payments")
  .header("MD-SESSION-TOKEN", "<api-key>")
  .header("Content-Type", "application/vnd.mx.nexus.v1+json")
  .body("{}")
  .asString();

require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Post.new(url)
request["MD-SESSION-TOKEN"] = '<api-key>'
request["Content-Type"] = 'application/vnd.mx.nexus.v1+json'
request.body = "{}"

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

{
  "scheduled_payment": {
    "amount": 10.97,
    "created_at": "2015-04-13T12:01:23-00:00",
    "description": "Power bill",
    "guid": "SCH-e386a323-e452-47f2-b2fd-1ac3c18533de",
    "is_completed": false,
    "is_recurring": true,
    "merchant_guid": "MCH-5005cd15-c3e5-0e69-ec98-c95147860a45",
    "occurs_on": "2018-12-13T00:00:00.000Z",
    "recurrence_day": 3,
    "recurrence_type": 3,
    "recurrence_type_name": "EVERY_MONTH",
    "transaction_type": 2,
    "transaction_type_name": "DEBIT",
    "updated_at": "2015-04-13T12:01:23.000Z",
    "user_guid": "USR-11141024-90b3-1bce-cac9-c06ced52ab4c"
  }
}

POST

scheduled_payments

Create a scheduled payment

curl --request POST \
  --url https://int-data.moneydesktop.com/scheduled_payments \
  --header 'Content-Type: application/vnd.mx.nexus.v1+json' \
  --header 'MD-SESSION-TOKEN: <api-key>' \
  --data '{}'

import requests

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

payload = {}
headers = {
    "MD-SESSION-TOKEN": "<api-key>",
    "Content-Type": "application/vnd.mx.nexus.v1+json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'MD-SESSION-TOKEN': '<api-key>',
    'Content-Type': 'application/vnd.mx.nexus.v1+json'
  },
  body: JSON.stringify({})
};

fetch('https://int-data.moneydesktop.com/scheduled_payments', 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/scheduled_payments",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/vnd.mx.nexus.v1+json",
    "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"
	"strings"
	"net/http"
	"io"
)

func main() {

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

	payload := strings.NewReader("{}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("MD-SESSION-TOKEN", "<api-key>")
	req.Header.Add("Content-Type", "application/vnd.mx.nexus.v1+json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://int-data.moneydesktop.com/scheduled_payments")
  .header("MD-SESSION-TOKEN", "<api-key>")
  .header("Content-Type", "application/vnd.mx.nexus.v1+json")
  .body("{}")
  .asString();

require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Post.new(url)
request["MD-SESSION-TOKEN"] = '<api-key>'
request["Content-Type"] = 'application/vnd.mx.nexus.v1+json'
request.body = "{}"

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

{
  "scheduled_payment": {
    "amount": 10.97,
    "created_at": "2015-04-13T12:01:23-00:00",
    "description": "Power bill",
    "guid": "SCH-e386a323-e452-47f2-b2fd-1ac3c18533de",
    "is_completed": false,
    "is_recurring": true,
    "merchant_guid": "MCH-5005cd15-c3e5-0e69-ec98-c95147860a45",
    "occurs_on": "2018-12-13T00:00:00.000Z",
    "recurrence_day": 3,
    "recurrence_type": 3,
    "recurrence_type_name": "EVERY_MONTH",
    "transaction_type": 2,
    "transaction_type_name": "DEBIT",
    "updated_at": "2015-04-13T12:01:23.000Z",
    "user_guid": "USR-11141024-90b3-1bce-cac9-c06ced52ab4c"
  }
}

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.

Body

application/vnd.mx.nexus.v1+json

scheduled_payment

object

Hide child attributes

scheduled_payment.amount

integer

required

The amount of the scheduled_payment.

Example:

10.97

scheduled_payment.description

string

required

A human-readable description of the scheduled_payment, e.g., Power bill.

Example:

"Power bill"

scheduled_payment.is_recurring

boolean

required

Indicates whether the scheduled_payment is expected to repeat.

Example:

true

scheduled_payment.occurs_on

string

required

The date on which the payment is scheduled to occur, given in ISO 8601 format without a timestamp.

Example:

"2018-12-13T00:00:00.000Z"

scheduled_payment.is_completed

boolean

Indicates whether the scheduled_payment has been paid or not. This field is only applicable to one-time transactions.

Example:

false

scheduled_payment.merchant_guid

string

The unique identifier for the merchant identified in the scheduled_payment.

Example:

"MCH-5005cd15-c3e5-0e69-ec98-c95147860a45"

scheduled_payment.recurrence_day

integer

The day of the month where the next payment is expected to occur.

Example:

3

scheduled_payment.recurrence_type

integer

The repeatable pattern for the scheduled_payment, given as an integer.

Example:

3

scheduled_payment.transaction_type

number

Indicates whether the transaction is a credit or a debit. 1 = CREDIT, 2 = DEBIT.

Example:

2

scheduled_payment.transaction_type_name

string

Indicates whether the transaction is a credit or a debit. 1 = CREDIT, 2 = DEBIT.

Example:

"DEBIT"

Response

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

scheduled_payment

object

Hide child attributes

scheduled_payment.amount

integer

The amount of the scheduled_payment.

Example:

10.97

scheduled_payment.created_at

string

Date and time the scheduled_payment was created, represented in ISO 8601 format with timestamp (e.g., 2015-04-13T12:01:23-00:00).

Example:

"2015-04-13T12:01:23-00:00"

scheduled_payment.description

string

A human-readable description of the scheduled_payment, e.g., Power bill.

Example:

"Power bill"

scheduled_payment.guid

string

The unique identifier for the scheduled_payment, such as a recurring utility bill or streaming subscription. Defined by MX.

Example:

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

scheduled_payment.is_completed

boolean

Indicates whether the scheduled_payment has been paid or not. This field is only applicable to one-time transactions.

Example:

false

scheduled_payment.is_recurring

boolean

Indicates whether the scheduled_payment is expected to repeat.

Example:

true

scheduled_payment.merchant_guid

string

The unique identifier for the merchant identified in the scheduled_payment.

Example:

"MCH-5005cd15-c3e5-0e69-ec98-c95147860a45"

scheduled_payment.occurs_on

string

The date on which the payment is scheduled to occur, given in ISO 8601 format without a timestamp.

Example:

"2018-12-13T00:00:00.000Z"

scheduled_payment.recurrence_day

integer

The day of the month where the next payment is expected to occur.

Example:

3

scheduled_payment.recurrence_type

integer

The repeatable pattern for the scheduled_payment, given as an integer.

Example:

3

scheduled_payment.recurrence_type_name

string

The repeatable pattern for the scheduled_payment, given as a string.

Example:

"EVERY_MONTH"

scheduled_payment.transaction_type

integer

Indicates whether the transaction is a credit or a debit. 1 = CREDIT, 2 = DEBIT.

Example:

2

scheduled_payment.transaction_type_name

string

Indicates whether the transaction is a credit or a debit. 1 = CREDIT, 2 = DEBIT.

Example:

"DEBIT"

scheduled_payment.updated_at

string

Date and time the scheduled_payment was last updated, represented in ISO 8601 format with timestamp (e.g. 2015-04-13T12:01:23-00:00).

Example:

"2015-04-13T12:01:23.000Z"

scheduled_payment.user_guid

string

The unique identifier for the user associated with a scheduled_payment. Scheduled payments are attached to the user_guid, not individual accounts held by the user. Defined by MX.

Example:

"USR-11141024-90b3-1bce-cac9-c06ced52ab4c"

List scheduled payments

Delete a scheduled payment