TRtrueaccord
Debts

Pause collections on a debt

Pause collections on a debt

post/customers/{customerId}/debts/{debtId}/pauseCollections

Request

Query parameters

changeDebtStatusboolean

Changes debt's status to Paused if the parameter value is set to true.

Request body

reason'SCRA' | 'PENDING_BK_VERIFICATION' | 'PENDING_FRAUD_INVESTIGATION' | 'PERMANENT_HARDSHIP_TERMINAL_ILLNESS' | 'PERMANENT_HARDSHIP_PERMANENT_DISABILITY' | 'PERMANENT_HARDSHIP_LONG_TERM_INCARCERATION' | 'TEMPORARY_HARDSHIP' | 'OTHER' | 'GEOGRAPHIC_SUPPRESSION' | 'GOOD_FAITH_PAYMENT' | 'INVALID_DISPUTE_PAUSE_PERIOD' | 'PROFANITY' | 'MAILED_IN_PAYMENT' | 'TEMPORARY_HARDSHIP_CONFIRMED' | 'DV_DOCS_MAILED' | 'PENDING_PREV_PAID_DOCS'

Some of these pause reasons have restrictions on number of days they can be paused for, so when a custom range of days is necessary, use OTHER or TEMPORARY_HARDSHIP.

pauseLengthInDaysinteger

The number of days the account should remain paused. NOTE: 0 indicates an indefinite pause period.

notesstring

Notes related to pausing collections. Added as a comment on the debt.

Example request

{
  "reason": "OTHER",
  "pauseLengthInDays": 14,
  "notes": "Client needs a pause during recall process."
}

Response

OK

Changes

No recorded changes to this operation across all 1 revision of this API.