Skip to main content
POST
Submit custom offer response

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.

Body

application/json
negotiation_type
enum<string>
required

pif stores a settlement offer; installment stores a payment-plan offer.

Available options:
pif,
installment
Example:

"installment"

amount
required

Consumer-entered custom offer amount. Must be greater than zero and cannot exceed the saved notice balance.

Example:

"125.00"

first_pay_date
string<date>
required

First payment date. Must be today or a future date.

Example:

"2026-06-20"

installment_type
enum<string>

Required when negotiation_type is installment.

Available options:
weekly,
bimonthly,
monthly
Example:

"weekly"

reason
string

Optional reason selected from response_options.custom_offer_reasons.

Example:

"UnEmployed"

note
string

Optional note to the sender.

Maximum string length: 255
Example:

"Can pay weekly."

Response

Custom offer response submitted.

message
string
required
Examples:

"Notice response started."

"Sender details saved."

"Account details saved."

"Notice uploaded."

data
object
required
Last modified on July 19, 2026