Evaluate statement for autopay configuration
🚧 Beta This is a Beta endpoint. Feedback from the community is welcome. We may make breaking changes to this endpoint.
Re-runs the autopay scheduling logic for an existing statement against an autopay configuration. This is useful when an autopay configuration is created mid-billing-cycle and needs to schedule a payment for an already-issued statement.
The endpoint is idempotent: if an autopay already exists for the statement’s billing period, it is returned unchanged.
The configuration must be ACTIVE and must have autopay_type=STATEMENT
(SCHEDULED configurations cannot be evaluated per-statement). The
configuration’s lending_account_id must match the statement’s account.
Violations of these constraints return 400.
No future-due-date check is enforced. If the computed scheduled date is in the past, the regular autopay batch will execute the autopay on its next run.
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Autopay configuration ID
Body
Statement to evaluate
Request to evaluate an existing statement against an autopay configuration
ID of the statement to evaluate.
Response
Autopay record (newly created or pre-existing)
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.
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
SCHEDULED, STATEMENT 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.
Timestamp when the autopay was created
"2024-01-15T10:30:00Z"
Unique identifier for the autopay
"2d0f7601-ecc6-48b4-b82f-5d64fa84628b"
Timestamp when the autopay was last updated
"2024-01-15T10:30:00Z"
The lending account ID this autopay belongs to
"7d943c51-e4ff-4e57-9558-08cab6b963c7"
The payment description rendered from the description template at autopay creation time. This is used for ACH addenda and internal transfer memo fields.
"Autopay for account ending in 1234"
Date when the autopay is scheduled to execute
"2024-01-25"
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
EXECUTED, FAILED, PENDING, SKIPPED History of execution attempts for an autopay
ID of the autopay configuration that created this autopay. Absent for MANUAL autopays, which are not tied to an autopay configuration.
"3e1f8712-fdd7-59c5-c93f-6e75fb95739c"
The billing period ID this autopay is for. Present for STATEMENT autopays; absent for SCHEDULED autopays.
"4f2g9823-gee8-60d6-d04g-7f86gc06840d"
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.
5000
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.
5000
Identifiers for the payment created by an autopay execution. Only one field will be populated depending on the payment method used.
The statement ID that triggered this autopay
"5g3h0934-hff9-71e7-e15h-8g97hd17951e"

