Skip to main content
GET
/
autopay_configs
List autopay configurations
curl --request GET \
  --url https://api.synctera.com/v1/autopay_configs \
  --header 'Authorization: Bearer <token>'
{
  "autopay_configs": [
    {
      "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"
    }
  ],
  "next_page_token": "a8937a0d"
}

Documentation Index

Fetch the complete documentation index at: https://docs.synctera.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

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

Query Parameters

​
external_account_id
string<uuid>
​
business_id
string<uuid>
​
from_creation_time
string<date-time>
​
from_last_updated_time
string<date-time>
​
sort_by
enum<string>[]
Available options:
creation_time:asc,
creation_time:desc,
last_updated_time:asc,
last_updated_time:desc
​
to_last_updated_time
string<date-time>
​
source_account_id
string<uuid>
​
tenant
string[]

The id of the tenant containing the resource.

​
page_token
string

Optional pagination token to be provided to retrieve subsequent pages, returned from previous get

Example:

"a8937a0d"

​
status
enum<string>

Status of the autopay configuration

Available options:
ACTIVE,
DISABLED,
PAUSED
​
lending_account_id
string<uuid>[]
​
limit
integer
default:100

Maximum number of objects to return per page. If the limit is greater than 100, then it will be set to 100.

Required range: x >= 1
Example:

100

​
person_id
string<uuid>
​
to_creation_time
string<date-time>
​
id
string<uuid>[]

Response

List of autopay configurations

​
autopay_configs
object[]
required

Array of autopay configurations

​
next_page_token
string

If returned, use the next_page_token to query for the next page of results. Not returned if there are no more rows.

Example:

"a8937a0d"