List all scheduled payments associated with an insight

curl --request GET \
  --url https://int-api.mx.com/users/{user_guid}/insights/{insight_guid}/scheduled_payments \
  --header 'Accept-Version: <accept-version>' \
  --header 'Authorization: Basic <encoded-value>'

import requests

url = "https://int-api.mx.com/users/{user_guid}/insights/{insight_guid}/scheduled_payments"

headers = {
    "Accept-Version": "<accept-version>",
    "Authorization": "Basic <encoded-value>"
}

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

print(response.text)

const options = {
  method: 'GET',
  headers: {'Accept-Version': '<accept-version>', Authorization: 'Basic <encoded-value>'}
};

fetch('https://int-api.mx.com/users/{user_guid}/insights/{insight_guid}/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-api.mx.com/users/{user_guid}/insights/{insight_guid}/scheduled_payments",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Accept-Version: <accept-version>",
    "Authorization: Basic <encoded-value>"
  ],
]);

$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-api.mx.com/users/{user_guid}/insights/{insight_guid}/scheduled_payments"

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

	req.Header.Add("Accept-Version", "<accept-version>")
	req.Header.Add("Authorization", "Basic <encoded-value>")

	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-api.mx.com/users/{user_guid}/insights/{insight_guid}/scheduled_payments")
  .header("Accept-Version", "<accept-version>")
  .header("Authorization", "Basic <encoded-value>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://int-api.mx.com/users/{user_guid}/insights/{insight_guid}/scheduled_payments")

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

request = Net::HTTP::Get.new(url)
request["Accept-Version"] = '<accept-version>'
request["Authorization"] = 'Basic <encoded-value>'

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

{
  "scheduled_payments": [
    {
      "amount": 61.11,
      "created_at": "2025-02-13T18:08:00+00:00",
      "description": "Netflix",
      "guid": "SPA-c76e4a85-b2c4-4335-82b7-8f8b8f28c35a",
      "is_completed": false,
      "is_recurring": true,
      "merchant_guid": "MCH-b8a2624c-2176-59ec-c150-37854bc38aa8",
      "occurs_on": "2022-01-15",
      "recurrence_day": 15,
      "recurrence_type": "EVERY_MONTH",
      "transaction_type": "DEBIT",
      "updated_at": "2025-02-13T18:09:00+00:00",
      "user_guid": "USR-fa7537f3-48aa-a683-a02a-b18940482f54"
    }
  ],
  "pagination": {
    "current_page": 1,
    "per_page": 25,
    "total_entries": 1,
    "total_pages": 1
  }
}

GET

users

{user_guid}

insights

{insight_guid}

scheduled_payments

List all scheduled payments associated with an insight

curl --request GET \
  --url https://int-api.mx.com/users/{user_guid}/insights/{insight_guid}/scheduled_payments \
  --header 'Accept-Version: <accept-version>' \
  --header 'Authorization: Basic <encoded-value>'

import requests

url = "https://int-api.mx.com/users/{user_guid}/insights/{insight_guid}/scheduled_payments"

headers = {
    "Accept-Version": "<accept-version>",
    "Authorization": "Basic <encoded-value>"
}

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

print(response.text)

const options = {
  method: 'GET',
  headers: {'Accept-Version': '<accept-version>', Authorization: 'Basic <encoded-value>'}
};

fetch('https://int-api.mx.com/users/{user_guid}/insights/{insight_guid}/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-api.mx.com/users/{user_guid}/insights/{insight_guid}/scheduled_payments",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Accept-Version: <accept-version>",
    "Authorization: Basic <encoded-value>"
  ],
]);

$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-api.mx.com/users/{user_guid}/insights/{insight_guid}/scheduled_payments"

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

	req.Header.Add("Accept-Version", "<accept-version>")
	req.Header.Add("Authorization", "Basic <encoded-value>")

	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-api.mx.com/users/{user_guid}/insights/{insight_guid}/scheduled_payments")
  .header("Accept-Version", "<accept-version>")
  .header("Authorization", "Basic <encoded-value>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://int-api.mx.com/users/{user_guid}/insights/{insight_guid}/scheduled_payments")

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

request = Net::HTTP::Get.new(url)
request["Accept-Version"] = '<accept-version>'
request["Authorization"] = 'Basic <encoded-value>'

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

{
  "scheduled_payments": [
    {
      "amount": 61.11,
      "created_at": "2025-02-13T18:08:00+00:00",
      "description": "Netflix",
      "guid": "SPA-c76e4a85-b2c4-4335-82b7-8f8b8f28c35a",
      "is_completed": false,
      "is_recurring": true,
      "merchant_guid": "MCH-b8a2624c-2176-59ec-c150-37854bc38aa8",
      "occurs_on": "2022-01-15",
      "recurrence_day": 15,
      "recurrence_type": "EVERY_MONTH",
      "transaction_type": "DEBIT",
      "updated_at": "2025-02-13T18:09:00+00:00",
      "user_guid": "USR-fa7537f3-48aa-a683-a02a-b18940482f54"
    }
  ],
  "pagination": {
    "current_page": 1,
    "per_page": 25,
    "total_entries": 1,
    "total_pages": 1
  }
}

Authorizations

Authorization

string

header

required

The MX Platform API requires basic access authentication using your client_id and api_key. These credentials must be Base64 encoded and included in the Authorization header of each API request to ensure secure access.

Here's an example using curl to access v20250224. Replace https://int-api.mx.com/endpoint with the actual API endpoint you wish to access and your Base64 encoded client_id and api_key.

curl -L -X POST `https://int-api.mx.com/endpoint' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Accept-Version: v20250224'
-H 'Authorization: Basic BASE_64_ENCODING_OF{client_id:api_key}'

Headers

Accept-Version

string

default:v20250224

required

MX Platform API version.

Example:

"v20250224"

Path Parameters

user_guid

string

required

The unique identifier for a user, beginning with the prefix USR-.

insight_guid

string

required

The unique identifier for the insight. Defined by MX.

Query Parameters

page

integer

Results are paginated. Specify current page.

records_per_page

integer

This specifies the number of records to be returned on each page. Defaults to 25. The valid range is from 10 to 100. If the value exceeds 100, the default value of 25 will be used instead.

Response

200 - application/json

scheduled_payments

object[]

Hide child attributes

scheduled_payments.amount

number

The monetary amount of the transaction.

Example:

61.11

scheduled_payments.created_at

string

The date and time the scheduled payment was created, represented in ISO 8601 format with a timestamp.

Example:

"2025-02-13T18:08:00+00:00"

scheduled_payments.description

string

A human-readable description of the scheduled_payment, for example, Power bill.

Example:

"Netflix"

scheduled_payments.guid

string

The unique identifier for the scheduled payment. Defined by MX.

Example:

"SPA-c76e4a85-b2c4-4335-82b7-8f8b8f28c35a"

scheduled_payments.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_payments.is_recurring

boolean

Deprecated. If required, reach out to MX to discuss an alternative.

Example:

true

scheduled_payments.merchant_guid

string

The unique identifier for the merchant. Defined by MX.

Example:

"MCH-b8a2624c-2176-59ec-c150-37854bc38aa8"

scheduled_payments.occurs_on

string

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

Example:

"2022-01-15"

scheduled_payments.recurrence_day

integer

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

Example:

15

scheduled_payments.recurrence_type

string

The type of recurrence schedule.

Example:

"EVERY_MONTH"

scheduled_payments.transaction_type

enum<string>

The type of transaction.

Available options:

CREDIT,

DEBIT

Example:

"DEBIT"

scheduled_payments.updated_at

string

The date and time the resource was last updated in ISO 8601 format with a timestamp.

For categories, this field will always be null when is_default is true.

Example:

"2025-02-13T18:09:00+00:00"

scheduled_payments.user_guid

string

The unique identifier for the user. Defined by MX.

Example:

"USR-fa7537f3-48aa-a683-a02a-b18940482f54"

pagination

object

Hide child attributes

pagination.current_page

integer

The page delivered by the current response.

Example:

1

pagination.per_page

integer

The number of records delivered with each page.

Example:

25

pagination.total_entries

integer

The total number of records available.

Example:

1

pagination.total_pages

integer

The total number of pages available.

Example:

1

List all merchants associated with an insight

List all transactions associated with an insight