Create recurring transaction

curl --request POST \
  --url https://app.sure.am/api/v1/recurring_transactions \
  --header 'Content-Type: application/json' \
  --header 'X-Api-Key: <api-key>' \
  --data '
{
  "recurring_transaction": {
    "name": "<string>",
    "amount": 123,
    "currency": "<string>",
    "expected_day_of_month": 16,
    "last_occurrence_date": "2023-12-25",
    "next_expected_date": "2023-12-25",
    "account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "merchant_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "occurrence_count": 1,
    "manual": true,
    "expected_amount_min": 123,
    "expected_amount_max": 123,
    "expected_amount_avg": 123
  }
}
'

import requests

url = "https://app.sure.am/api/v1/recurring_transactions"

payload = { "recurring_transaction": {
        "name": "<string>",
        "amount": 123,
        "currency": "<string>",
        "expected_day_of_month": 16,
        "last_occurrence_date": "2023-12-25",
        "next_expected_date": "2023-12-25",
        "account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "merchant_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "occurrence_count": 1,
        "manual": True,
        "expected_amount_min": 123,
        "expected_amount_max": 123,
        "expected_amount_avg": 123
    } }
headers = {
    "X-Api-Key": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-Api-Key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    recurring_transaction: {
      name: '<string>',
      amount: 123,
      currency: '<string>',
      expected_day_of_month: 16,
      last_occurrence_date: '2023-12-25',
      next_expected_date: '2023-12-25',
      account_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
      merchant_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
      occurrence_count: 1,
      manual: true,
      expected_amount_min: 123,
      expected_amount_max: 123,
      expected_amount_avg: 123
    }
  })
};

fetch('https://app.sure.am/api/v1/recurring_transactions', 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://app.sure.am/api/v1/recurring_transactions",
  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([
    'recurring_transaction' => [
        'name' => '<string>',
        'amount' => 123,
        'currency' => '<string>',
        'expected_day_of_month' => 16,
        'last_occurrence_date' => '2023-12-25',
        'next_expected_date' => '2023-12-25',
        'account_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
        'merchant_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
        'occurrence_count' => 1,
        'manual' => true,
        'expected_amount_min' => 123,
        'expected_amount_max' => 123,
        'expected_amount_avg' => 123
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-Api-Key: <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://app.sure.am/api/v1/recurring_transactions"

	payload := strings.NewReader("{\n  \"recurring_transaction\": {\n    \"name\": \"<string>\",\n    \"amount\": 123,\n    \"currency\": \"<string>\",\n    \"expected_day_of_month\": 16,\n    \"last_occurrence_date\": \"2023-12-25\",\n    \"next_expected_date\": \"2023-12-25\",\n    \"account_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n    \"merchant_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n    \"occurrence_count\": 1,\n    \"manual\": true,\n    \"expected_amount_min\": 123,\n    \"expected_amount_max\": 123,\n    \"expected_amount_avg\": 123\n  }\n}")

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

	req.Header.Add("X-Api-Key", "<api-key>")
	req.Header.Add("Content-Type", "application/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://app.sure.am/api/v1/recurring_transactions")
  .header("X-Api-Key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"recurring_transaction\": {\n    \"name\": \"<string>\",\n    \"amount\": 123,\n    \"currency\": \"<string>\",\n    \"expected_day_of_month\": 16,\n    \"last_occurrence_date\": \"2023-12-25\",\n    \"next_expected_date\": \"2023-12-25\",\n    \"account_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n    \"merchant_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n    \"occurrence_count\": 1,\n    \"manual\": true,\n    \"expected_amount_min\": 123,\n    \"expected_amount_max\": 123,\n    \"expected_amount_avg\": 123\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://app.sure.am/api/v1/recurring_transactions")

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

request = Net::HTTP::Post.new(url)
request["X-Api-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"recurring_transaction\": {\n    \"name\": \"<string>\",\n    \"amount\": 123,\n    \"currency\": \"<string>\",\n    \"expected_day_of_month\": 16,\n    \"last_occurrence_date\": \"2023-12-25\",\n    \"next_expected_date\": \"2023-12-25\",\n    \"account_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n    \"merchant_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n    \"occurrence_count\": 1,\n    \"manual\": true,\n    \"expected_amount_min\": 123,\n    \"expected_amount_max\": 123,\n    \"expected_amount_avg\": 123\n  }\n}"

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

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "amount": "<string>",
  "amount_cents": 123,
  "currency": "<string>",
  "expected_day_of_month": 16,
  "last_occurrence_date": "2023-12-25",
  "next_expected_date": "2023-12-25",
  "status": "active",
  "occurrence_count": 1,
  "manual": true,
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "name": "<string>",
  "expected_amount_min": "<string>",
  "expected_amount_min_cents": 123,
  "expected_amount_max": "<string>",
  "expected_amount_max_cents": 123,
  "expected_amount_avg": "<string>",
  "expected_amount_avg_cents": 123,
  "account": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "account_type": "<string>",
    "status": "<string>"
  },
  "merchant": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>"
  }
}

{
  "error": "<string>",
  "message": "<string>",
  "details": [
    "<string>"
  ],
  "errors": [
    "<string>"
  ]
}

{
  "error": "<string>",
  "message": "<string>",
  "details": [
    "<string>"
  ],
  "errors": [
    "<string>"
  ]
}

{
  "error": "<string>",
  "message": "<string>",
  "details": [
    "<string>"
  ],
  "errors": [
    "<string>"
  ]
}

{
  "error": "<string>",
  "message": "<string>",
  "details": [
    "<string>"
  ],
  "errors": [
    "<string>"
  ]
}

POST

api

recurring_transactions

Create recurring transaction

curl --request POST \
  --url https://app.sure.am/api/v1/recurring_transactions \
  --header 'Content-Type: application/json' \
  --header 'X-Api-Key: <api-key>' \
  --data '
{
  "recurring_transaction": {
    "name": "<string>",
    "amount": 123,
    "currency": "<string>",
    "expected_day_of_month": 16,
    "last_occurrence_date": "2023-12-25",
    "next_expected_date": "2023-12-25",
    "account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "merchant_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "occurrence_count": 1,
    "manual": true,
    "expected_amount_min": 123,
    "expected_amount_max": 123,
    "expected_amount_avg": 123
  }
}
'

import requests

url = "https://app.sure.am/api/v1/recurring_transactions"

payload = { "recurring_transaction": {
        "name": "<string>",
        "amount": 123,
        "currency": "<string>",
        "expected_day_of_month": 16,
        "last_occurrence_date": "2023-12-25",
        "next_expected_date": "2023-12-25",
        "account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "merchant_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "occurrence_count": 1,
        "manual": True,
        "expected_amount_min": 123,
        "expected_amount_max": 123,
        "expected_amount_avg": 123
    } }
headers = {
    "X-Api-Key": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-Api-Key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    recurring_transaction: {
      name: '<string>',
      amount: 123,
      currency: '<string>',
      expected_day_of_month: 16,
      last_occurrence_date: '2023-12-25',
      next_expected_date: '2023-12-25',
      account_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
      merchant_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
      occurrence_count: 1,
      manual: true,
      expected_amount_min: 123,
      expected_amount_max: 123,
      expected_amount_avg: 123
    }
  })
};

fetch('https://app.sure.am/api/v1/recurring_transactions', 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://app.sure.am/api/v1/recurring_transactions",
  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([
    'recurring_transaction' => [
        'name' => '<string>',
        'amount' => 123,
        'currency' => '<string>',
        'expected_day_of_month' => 16,
        'last_occurrence_date' => '2023-12-25',
        'next_expected_date' => '2023-12-25',
        'account_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
        'merchant_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
        'occurrence_count' => 1,
        'manual' => true,
        'expected_amount_min' => 123,
        'expected_amount_max' => 123,
        'expected_amount_avg' => 123
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-Api-Key: <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://app.sure.am/api/v1/recurring_transactions"

	payload := strings.NewReader("{\n  \"recurring_transaction\": {\n    \"name\": \"<string>\",\n    \"amount\": 123,\n    \"currency\": \"<string>\",\n    \"expected_day_of_month\": 16,\n    \"last_occurrence_date\": \"2023-12-25\",\n    \"next_expected_date\": \"2023-12-25\",\n    \"account_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n    \"merchant_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n    \"occurrence_count\": 1,\n    \"manual\": true,\n    \"expected_amount_min\": 123,\n    \"expected_amount_max\": 123,\n    \"expected_amount_avg\": 123\n  }\n}")

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

	req.Header.Add("X-Api-Key", "<api-key>")
	req.Header.Add("Content-Type", "application/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://app.sure.am/api/v1/recurring_transactions")
  .header("X-Api-Key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"recurring_transaction\": {\n    \"name\": \"<string>\",\n    \"amount\": 123,\n    \"currency\": \"<string>\",\n    \"expected_day_of_month\": 16,\n    \"last_occurrence_date\": \"2023-12-25\",\n    \"next_expected_date\": \"2023-12-25\",\n    \"account_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n    \"merchant_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n    \"occurrence_count\": 1,\n    \"manual\": true,\n    \"expected_amount_min\": 123,\n    \"expected_amount_max\": 123,\n    \"expected_amount_avg\": 123\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://app.sure.am/api/v1/recurring_transactions")

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

request = Net::HTTP::Post.new(url)
request["X-Api-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"recurring_transaction\": {\n    \"name\": \"<string>\",\n    \"amount\": 123,\n    \"currency\": \"<string>\",\n    \"expected_day_of_month\": 16,\n    \"last_occurrence_date\": \"2023-12-25\",\n    \"next_expected_date\": \"2023-12-25\",\n    \"account_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n    \"merchant_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n    \"occurrence_count\": 1,\n    \"manual\": true,\n    \"expected_amount_min\": 123,\n    \"expected_amount_max\": 123,\n    \"expected_amount_avg\": 123\n  }\n}"

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

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "amount": "<string>",
  "amount_cents": 123,
  "currency": "<string>",
  "expected_day_of_month": 16,
  "last_occurrence_date": "2023-12-25",
  "next_expected_date": "2023-12-25",
  "status": "active",
  "occurrence_count": 1,
  "manual": true,
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "name": "<string>",
  "expected_amount_min": "<string>",
  "expected_amount_min_cents": 123,
  "expected_amount_max": "<string>",
  "expected_amount_max_cents": 123,
  "expected_amount_avg": "<string>",
  "expected_amount_avg_cents": 123,
  "account": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "account_type": "<string>",
    "status": "<string>"
  },
  "merchant": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>"
  }
}

{
  "error": "<string>",
  "message": "<string>",
  "details": [
    "<string>"
  ],
  "errors": [
    "<string>"
  ]
}

{
  "error": "<string>",
  "message": "<string>",
  "details": [
    "<string>"
  ],
  "errors": [
    "<string>"
  ]
}

{
  "error": "<string>",
  "message": "<string>",
  "details": [
    "<string>"
  ],
  "errors": [
    "<string>"
  ]
}

{
  "error": "<string>",
  "message": "<string>",
  "details": [
    "<string>"
  ],
  "errors": [
    "<string>"
  ]
}

Authorizations

X-Api-Key

string

header

required

API key for authentication. Generate one from your account settings.

Body

application/json

recurring_transaction

object

required

Option 1
Option 2

Show child attributes

Response

recurring transaction created

string<uuid>

required

amount

string

required

amount_cents

integer

required

Amount in currency minor units

currency

string

required

expected_day_of_month

integer

required

Required range: 1 <= x <= 31

last_occurrence_date

string<date>

required

next_expected_date

string<date>

required

status

enum<string>

required

Available options:

active,

inactive

occurrence_count

integer

required

Required range: x >= 0

manual

boolean

required

created_at

string<date-time>

required

updated_at

string<date-time>

required

name

string | null

expected_amount_min

string | null

expected_amount_min_cents

integer | null

Minimum expected amount in currency minor units

expected_amount_max

string | null

expected_amount_max_cents

integer | null

Maximum expected amount in currency minor units

expected_amount_avg

string | null

expected_amount_avg_cents

integer | null

Average expected amount in currency minor units

account

object | null

Show child attributes

merchant

object | null

Show child attributes

⌘I

Auth

Accounts

Balance Sheet

Balances

Budget Categories

Budgets

Categories

Chats

Family Exports

Family Settings

Holdings

Import Sessions

Imports

Merchants

Provider Connections

Recurring Transactions

Rejected Transfers

Rule Runs

Rules

Securities

Security Prices

Sync

Tags

Trades

Transactions

Transfers

Valuations

Users

Create recurring transaction

Authorizations

Body

Response