Skip to main content
PATCH
Change settlement date

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

consumer
integer
required

Consumer account ID.

payment
integer
required

Numeric scheduled payment row ID returned in scheduled_payments[].id.

Body

application/json
first_pay_date
string<date>
required

Requested settlement date. Dates outside pay terms reopen the account as a pending creditor response.

Example:

"2026-06-20"

Response

Settlement date updated or requested.

message
string
required
Examples:

"Payment rescheduled for today."

"Payment skipped."

"Payment scheduled for today was not skipped."

"Payment date updated."

"Settlement date updated."

"Awesome! Your offer was sent to your creditor!"

"Recurring payment schedule updated."

"Payment plan cancelled."

"Settlement cancelled."

"Payment processed."

"Partial payment processed."

"Remaining balance paid."

"Extra payment processed."

data
object
required
Last modified on July 19, 2026