Create an autopay schedule

curl --request POST \ --url https://api.montereyfinancial.app/autopay \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data ' { "account_id": "<string>", "payment_method_id": "<string>", "amount_cents": 123, "start_date": "2023-12-25", "frequency_interval": 1, "end_date": "2023-12-25", "anchor_day": 16, "anchor_month": 6 } '

{ "id": "<string>", "account_id": "<string>", "payment_method_id": "<string>", "amount_cents": 123, "frequency_unit": "<string>", "frequency_interval": 123, "start_date": "2023-12-25", "next_run_date": "2023-12-25", "status": "<string>", "created_at": "2023-11-07T05:31:56Z", "updated_at": "2023-11-07T05:31:56Z", "anchor_day": 123, "anchor_month": 123, "end_date": "2023-12-25", "cancelled_at": "2023-11-07T05:31:56Z" }

Authorizations

Authorization

string

header

required

Static API key issued via the client portal. Treat it like a password.

Body

application/json

Request body for creating an autopay schedule. The payment method must belong to a borrower on the target account.

account_id

string

required

The account this schedule pays toward.

payment_method_id

string

required

The stored payment method to charge on each run.

amount_cents

integer

required

Amount to charge per run, in integer cents.

frequency_unit

enum<string>

required

Unit of the recurrence interval.

Available options:

day,

week,

month,

year

start_date

string<date>

required

Date of the first scheduled run.

frequency_interval

integer

default:1

Number of units between runs. Defaults to 1.

Required range: x >= 1

end_date

string<date> | null

Last date a run may occur. Omit for an open-ended schedule.

anchor_day

integer | null

Day of month (1-31) to pin runs to, for month/year cadences.

Required range: 1 <= x <= 31

anchor_month

integer | null

Month (1-12) to pin runs to, for yearly cadences.

Required range: 1 <= x <= 12

Response

Successful Response

A recurring payment schedule tying an account to a stored payment method.

string

required

account_id

string

required

The account this schedule pays toward.

payment_method_id

string

required

The stored payment method charged on each run.

amount_cents

integer

required

Amount charged per run, in integer cents.

frequency_unit

string

required

Unit of the recurrence interval. One of: day, week, month, year.

frequency_interval

integer

required

Number of units between runs (e.g. 2 + week = every two weeks).

start_date

string<date>

required

Date of the first scheduled run.

next_run_date

string<date>

required

Date the next charge is scheduled to run.

status

string

required

Schedule state. One of: active, paused, cancelled, expired.

created_at

string<date-time>

required

updated_at

string<date-time>

required

anchor_day

integer | null

Day of month (1-31) runs are pinned to, for month/year cadences. Clamped to the last day of shorter months.

anchor_month

integer | null

Month (1-12) runs are pinned to, for yearly cadences.

end_date

string<date> | null

Last date a run may occur. Null for open-ended schedules.

cancelled_at

string<date-time> | null

When the schedule was cancelled. Null unless cancelled.