Skip to main content
POST
Make partial payment

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
amount
string
required

Partial payment amount. Must be at least 1.00 and cannot exceed the selected scheduled installment amount.

Pattern: ^\d+(\.\d{1,2})?$
Example:

"25.00"

Response

Partial payment processed.

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