API Reference

Create Scheduled Payment

Create new scheduled payment. Permission: Create Scheduled Payments

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
int32
required

Payment amount in cents.

boolean

Whether this is an eCheck payment. Optional; the loan's payment processor determines whether eCheck is permitted.

string
required

UUID of the associated loan.

string

Optional origin identifier for the scheduled payment.

boolean

The caller has obtained authorization for this specific payment (e.g. IVR verbal consent), so the recurring-authorization hold (payment_authorization_required_at) does not apply to it. A same-day payment is charged immediately; a future-dated payment is persisted and charged by the nightly runner on its due date. When omitted or false, the payment is queued with standard behavior. On an immediate (same-day) charge, the response's paymentUuid and paymentStatus reflect the resulting payment.

date
required

string date

uuid

UUID of the payment method to charge. Must belong to the loan's customer. If omitted, the system resolves a method when the scheduled payment runs.

string

UUID of the payment plan.

Responses

Language
Credentials
URL
LoadingLoading…
Response
Choose an example:
application/json