Get autopay configuration

curl --request GET \
  --url https://api.synctera.com/v1/autopay_configs/{autopay_config_id} \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.synctera.com/v1/autopay_configs/{autopay_config_id}"

headers = {"Authorization": "Bearer <token>"}

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

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.synctera.com/v1/autopay_configs/{autopay_config_id}', 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://api.synctera.com/v1/autopay_configs/{autopay_config_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$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://api.synctera.com/v1/autopay_configs/{autopay_config_id}"

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

	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.synctera.com/v1/autopay_configs/{autopay_config_id}")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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

{
  "config": {
    "amount_rule": "CURRENT_BALANCE",
    "autopay_type": "SCHEDULED",
    "failure_policy": "NO_RETRY",
    "payment_method": "ACH",
    "timing_rule": "DAILY",
    "description_template": "Autopay for account ending in {{.Last4AccountId}}",
    "payment_configs": {
      "ach": {
        "external_account_id": "8f5b4c62-f5a0-4e68-9669-19dbc7a74d8e",
        "is_same_day": true,
        "sec_code": "WEB"
      },
      "internal_transfer": {
        "source_account_id": "8f5b4c62-f5a0-4e68-9669-19dbc7a74d8e",
        "subtype": "autopay_payment"
      }
    },
    "rule_configs": {
      "current_balance": {},
      "days_before_due": {
        "offset_days": 3
      },
      "fixed_amount": {
        "amount": 10000
      },
      "minimum_due": {},
      "statement_balance": {}
    }
  },
  "creation_time": "2024-01-15T10:30:00Z",
  "id": "2d0f7601-ecc6-48b4-b82f-5d64fa84628b",
  "last_updated_time": "2024-01-15T10:30:00Z",
  "lending_account_id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
  "status": "ACTIVE",
  "tenant": "abcdef_ghijkl",
  "business_id": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
  "person_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
}

{
  "code": "BAD_REQUEST_BODY",
  "detail": "Missing required fields: first_name, dob",
  "status": 400
}

{
  "code": "BAD_REQUEST_BODY",
  "detail": "Missing required fields: first_name, dob",
  "status": 400
}

{
  "code": "BAD_REQUEST_BODY",
  "detail": "Missing required fields: first_name, dob",
  "status": 400
}

{
  "code": "BAD_REQUEST_BODY",
  "detail": "Missing required fields: first_name, dob",
  "status": 400
}

GET

autopay_configs

{autopay_config_id}

Get autopay configuration

curl --request GET \
  --url https://api.synctera.com/v1/autopay_configs/{autopay_config_id} \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.synctera.com/v1/autopay_configs/{autopay_config_id}"

headers = {"Authorization": "Bearer <token>"}

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

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.synctera.com/v1/autopay_configs/{autopay_config_id}', 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://api.synctera.com/v1/autopay_configs/{autopay_config_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$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://api.synctera.com/v1/autopay_configs/{autopay_config_id}"

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

	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.synctera.com/v1/autopay_configs/{autopay_config_id}")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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

{
  "config": {
    "amount_rule": "CURRENT_BALANCE",
    "autopay_type": "SCHEDULED",
    "failure_policy": "NO_RETRY",
    "payment_method": "ACH",
    "timing_rule": "DAILY",
    "description_template": "Autopay for account ending in {{.Last4AccountId}}",
    "payment_configs": {
      "ach": {
        "external_account_id": "8f5b4c62-f5a0-4e68-9669-19dbc7a74d8e",
        "is_same_day": true,
        "sec_code": "WEB"
      },
      "internal_transfer": {
        "source_account_id": "8f5b4c62-f5a0-4e68-9669-19dbc7a74d8e",
        "subtype": "autopay_payment"
      }
    },
    "rule_configs": {
      "current_balance": {},
      "days_before_due": {
        "offset_days": 3
      },
      "fixed_amount": {
        "amount": 10000
      },
      "minimum_due": {},
      "statement_balance": {}
    }
  },
  "creation_time": "2024-01-15T10:30:00Z",
  "id": "2d0f7601-ecc6-48b4-b82f-5d64fa84628b",
  "last_updated_time": "2024-01-15T10:30:00Z",
  "lending_account_id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
  "status": "ACTIVE",
  "tenant": "abcdef_ghijkl",
  "business_id": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
  "person_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
}

{
  "code": "BAD_REQUEST_BODY",
  "detail": "Missing required fields: first_name, dob",
  "status": 400
}

{
  "code": "BAD_REQUEST_BODY",
  "detail": "Missing required fields: first_name, dob",
  "status": 400
}

{
  "code": "BAD_REQUEST_BODY",
  "detail": "Missing required fields: first_name, dob",
  "status": 400
}

{
  "code": "BAD_REQUEST_BODY",
  "detail": "Missing required fields: first_name, dob",
  "status": 400
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

autopay_config_id

string<uuid>

required

Autopay configuration ID

Response

Autopay configuration details

Autopay configuration for a lending account

config

object

required

Autopay configuration settings. When autopay_type is SCHEDULED, amount_rule must be CURRENT_BALANCE and timing_rule must be DAILY. When autopay_type is STATEMENT, timing_rule must be ON_DUE_DATE or DAYS_BEFORE_DUE.

Show child attributes

creation_time

string<date-time>

required

Timestamp when the configuration was created

Example:

"2024-01-15T10:30:00Z"

string<uuid>

required

Unique identifier for the autopay configuration

Example:

"2d0f7601-ecc6-48b4-b82f-5d64fa84628b"

last_updated_time

string<date-time>

required

Timestamp when the configuration was last updated

Example:

"2024-01-15T10:30:00Z"

lending_account_id

string<uuid>

required

The lending account ID this configuration belongs to

Example:

"7d943c51-e4ff-4e57-9558-08cab6b963c7"

status

enum<string>

required

Status of the autopay configuration

Available options:

ACTIVE,

DISABLED,

PAUSED

tenant

string

required

The id of the tenant containing the resource.

Example:

"abcdef_ghijkl"

business_id

string<uuid>

The business ID that owns this autopay configuration (mutually exclusive with person_id)

Example:

"b2c3d4e5-f6a7-8901-bcde-f12345678901"

person_id

string<uuid>

The person ID who owns this autopay configuration (mutually exclusive with business_id)

Example:

"a1b2c3d4-e5f6-7890-abcd-ef1234567890"

Synctera API

Customers

Accounts

Cards

Money Movement

Transactions

Platform

Simulations

Get autopay configuration

Authorizations

Path Parameters

Response