Skip to main content
GET
/
autopays
List autopays
curl --request GET \
  --url https://api.synctera.com/v1/autopays \
  --header 'Authorization: Bearer <token>'
{
  "autopays": [
    {
      "autopay_config_id": "3e1f8712-fdd7-59c5-c93f-6e75fb95739c",
      "billing_period_id": "4f2g9823-gee8-60d6-d04g-7f86gc06840d",
      "config_snapshot": {
        "amount_rule": "CURRENT_BALANCE",
        "failure_policy": "NO_RETRY",
        "payment_method": "ACH",
        "timing_rule": "DAYS_BEFORE_DUE",
        "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",
      "rendered_description": "Autopay for account ending in 1234",
      "scheduled_date": "2024-01-25",
      "status": "EXECUTED",
      "attempt_history": {
        "attempts": [
          {
            "attempted_at": "2024-01-25T14:30:00Z",
            "status": "FAILED",
            "payment_attributes": {
              "ach_id": "6a4b1045-cdd0-82f8-f26c-9e08ce28062f",
              "transaction_id": "7b5c2156-dee1-93a9-a37d-0f19df39173a"
            },
            "reason": "Insufficient funds in payment source account"
          }
        ]
      },
      "current_amount": 5000,
      "payment_attributes": {
        "ach_id": "6a4b1045-cdd0-82f8-f26c-9e08ce28062f",
        "transaction_id": "7b5c2156-dee1-93a9-a37d-0f19df39173a"
      },
      "statement_id": "5g3h0934-hff9-71e7-e15h-8g97hd17951e",
      "tenant": {
        "bank_id": 6,
        "partner_id": 6
      }
    }
  ],
  "next_page_token": "a8937a0d"
}

Authorizations

​
Authorization
string
header
required

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

Query Parameters

​
scheduled_date
string<date>
​
status
enum<string>

Status of the autopay:

  • PENDING: Autopay is scheduled and waiting to be executed
  • EXECUTED: Autopay was successfully executed
  • SKIPPED: Autopay was skipped (e.g., no balance due)
  • FAILED: Autopay failed to execute
Available options:
EXECUTED,
FAILED,
PENDING,
SKIPPED
​
rendered_description
string[]
​
from_creation_time
string<date-time>
​
statement_id
string<uuid>[]
​
autopay_config_id
string<uuid>[]
​
from_last_updated_time
string<date-time>
​
to_last_updated_time
string<date-time>
​
rendered_description_like
string

Case insensitive wildcard search for rendered_description, wildcards can be specified with '*'. Wildcards at both the start and the end of the input is assumed.

​
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"

​
sort_by
enum<string>[]
Available options:
creation_time:asc,
creation_time:desc,
last_updated_time:asc,
last_updated_time:desc,
scheduled_date:asc,
scheduled_date:desc
​
lending_account_id
string<uuid>[]
​
to_scheduled_date
string<date>
​
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

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

Response

List of autopays

​
autopays
object[]
required

Array of autopays

​
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"