Get a Repeating Transaction

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

import requests

url = "https://int-api.mx.com/users/{user_guid}/repeating_transactions/{repeating_transaction_guid}"

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}/repeating_transactions/{repeating_transaction_guid}', 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}/repeating_transactions/{repeating_transaction_guid}",
  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}/repeating_transactions/{repeating_transaction_guid}"

	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}/repeating_transactions/{repeating_transaction_guid}")
  .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}/repeating_transactions/{repeating_transaction_guid}")

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

{
  "repeating_transactions": [
    {
      "account_guid": "ACT-06d7f44b-caae-0f6e-1384-01f52e75dcb1",
      "amount": 61.11,
      "description": "Dominion Energy",
      "guid": "RPT-a2264e1a-d2e6-41d9-88d2-2cfdf1143959",
      "member_guid": "MBR-7c6f361b-e582-15b6-60c0-358f12466b4b",
      "merchant_guid": "MCH-1b5d7e4d-fa29-95d1-fd0f-540b6f17d986",
      "last_posted_date": "2024-12-09",
      "predicted_occurs_on": "2025-01-09",
      "recurrence_type": "EVERY_MONTH",
      "user_guid": "USR-fa7537f3-48aa-a683-a02a-b18940482f54"
    }
  ]
}

GET

users

{user_guid}

repeating_transactions

{repeating_transaction_guid}

Get a Repeating Transaction

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

import requests

url = "https://int-api.mx.com/users/{user_guid}/repeating_transactions/{repeating_transaction_guid}"

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}/repeating_transactions/{repeating_transaction_guid}', 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}/repeating_transactions/{repeating_transaction_guid}",
  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}/repeating_transactions/{repeating_transaction_guid}"

	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}/repeating_transactions/{repeating_transaction_guid}")
  .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}/repeating_transactions/{repeating_transaction_guid}")

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

{
  "repeating_transactions": [
    {
      "account_guid": "ACT-06d7f44b-caae-0f6e-1384-01f52e75dcb1",
      "amount": 61.11,
      "description": "Dominion Energy",
      "guid": "RPT-a2264e1a-d2e6-41d9-88d2-2cfdf1143959",
      "member_guid": "MBR-7c6f361b-e582-15b6-60c0-358f12466b4b",
      "merchant_guid": "MCH-1b5d7e4d-fa29-95d1-fd0f-540b6f17d986",
      "last_posted_date": "2024-12-09",
      "predicted_occurs_on": "2025-01-09",
      "recurrence_type": "EVERY_MONTH",
      "user_guid": "USR-fa7537f3-48aa-a683-a02a-b18940482f54"
    }
  ]
}

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-.

repeating_transaction_guid

string

required

The unique id for a recurring transaction.

Response

200 - application/json

repeating_transactions

object[]

Hide child attributes

repeating_transactions.account_guid

string

The unique identifier for an account. Defined by MX.

Example:

"ACT-06d7f44b-caae-0f6e-1384-01f52e75dcb1"

repeating_transactions.amount

number | null

The monetary amount of the transaction.

Example:

61.11

repeating_transactions.description

string

Merchant or bill description.

Example:

"Dominion Energy"

repeating_transactions.guid

string

The unique identifier for the repeating transaction. Defined by MX.

Example:

"RPT-a2264e1a-d2e6-41d9-88d2-2cfdf1143959"

repeating_transactions.member_guid

string

The unique identifier for the member. Defined by MX.

Example:

"MBR-7c6f361b-e582-15b6-60c0-358f12466b4b"

repeating_transactions.merchant_guid

string

The unique identifier for the merchant. Defined by MX.

Example:

"MCH-1b5d7e4d-fa29-95d1-fd0f-540b6f17d986"

repeating_transactions.last_posted_date

string

Last occurrence date.

Example:

"2024-12-09"

repeating_transactions.predicted_occurs_on

string

Predicted next occurrence.

Example:

"2025-01-09"

repeating_transactions.recurrence_type

string

The frequency at which a transaction is expected to repeat based on historical patterns. See Supported Recurrence Types for full list. This field appears on transaction endpoints where the optional query parameter is defined.

Example:

"EVERY_MONTH"

repeating_transactions.user_guid

string

The unique identifier for the user. Defined by MX.

Example:

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

repeating_transactions.repeating_transaction_type

enum<string>

The type of repeating transaction. This field appears on transaction endpoints where the optional query parameter is defined.

Available options:

BILL,

SUBSCRIPTION,

INCOME,

UNKNOWN

repeating_transactions.transaction_type

enum<string>

The type of transaction.

Available options:

DEBIT,

CREDIT

List Repeating Transactions

Delete split transactions