Skip to main content
GET
/
autopays
/
{autopay_id}
Get autopay
curl --request GET \
  --url https://api.synctera.com/v1/autopays/{autopay_id} \
  --header 'Authorization: Bearer <token>'
{
  "autopay_config_id": "3e1f8712-fdd7-59c5-c93f-6e75fb95739c",
  "autopay_type": "SCHEDULED",
  "config_snapshot": {
    "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",
  "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"
      }
    ]
  },
  "billing_period_id": "4f2g9823-gee8-60d6-d04g-7f86gc06840d",
  "current_amount": 5000,
  "executed_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
  }
}

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.

Path Parameters

​
autopay_id
string<uuid>
required

Autopay ID

Response

Autopay details

An autopay record. STATEMENT autopays are tied to a specific billing period; SCHEDULED autopays are created during EOD orchestration and are not tied to a billing period.

​
autopay_config_id
string<uuid>
required

ID of the autopay configuration that created this autopay

Example:

"3e1f8712-fdd7-59c5-c93f-6e75fb95739c"

​
autopay_type
enum<string>
required

Controls when autopay is triggered:

  • STATEMENT: triggered once per billing cycle when a statement is created
  • SCHEDULED: triggered on a recurring cadence via EOD orchestration; requires amount_rule=CURRENT_BALANCE and timing_rule=DAILY
Available options:
SCHEDULED,
STATEMENT
​
config_snapshot
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.

​
creation_time
string<date-time>
required

Timestamp when the autopay was created

Example:

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

​
id
string<uuid>
required

Unique identifier for the autopay

Example:

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

​
last_updated_time
string<date-time>
required

Timestamp when the autopay was last updated

Example:

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

​
lending_account_id
string<uuid>
required

The lending account ID this autopay belongs to

Example:

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

​
rendered_description
string
required

The payment description rendered from the description template at autopay creation time. This is used for ACH addenda and internal transfer memo fields.

Example:

"Autopay for account ending in 1234"

​
scheduled_date
string<date>
required

Date when the autopay is scheduled to execute

Example:

"2024-01-25"

​
status
enum<string>
required

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
​
attempt_history
object

History of execution attempts for an autopay

​
billing_period_id
string<uuid>

The billing period ID this autopay is for. Present for STATEMENT autopays; absent for SCHEDULED autopays.

Example:

"4f2g9823-gee8-60d6-d04g-7f86gc06840d"

​
current_amount
integer<int64>

The amount in cents associated with this autopay. For PENDING autopays this is the projected amount based on the config snapshot and current balances and may change before execution as balances change. For EXECUTED autopays this is the actual amount used at execution time (mirrors executed_amount). For SKIPPED, FAILED, or cancelled autopays without an executed_amount this is 0.

Example:

5000

​
executed_amount
integer<int64>

The amount in cents actually used when the autopay was executed. Absent until the autopay is executed; once present it is the source of truth for the autopay amount and never changes.

Example:

5000

​
payment_attributes
object

Identifiers for the payment created by an autopay execution. Only one field will be populated depending on the payment method used.

​
statement_id
string<uuid>

The statement ID that triggered this autopay

Example:

"5g3h0934-hff9-71e7-e15h-8g97hd17951e"

​
tenant
Tenant · object