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",
  "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
  }
}

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 for a billing period

​
autopay_config_id
string<uuid>
required

ID of the autopay configuration that created this autopay

Example:

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

​
billing_period_id
string<uuid>
required

The billing period ID this autopay is for

Example:

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

​
config_snapshot
object
required

Autopay configuration settings

​
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

​
current_amount
integer<int64>

Current payment amount in cents based on the config snapshot and current balances. This value reflects what would be paid if the autopay executed right now. It may change before actual execution as account balances change.

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