PApaymentology
Customer Distress Management

Illustrate a treatment plan

Simulate a treatment plan without creating or executing it.

post/hardship/v1/accounts/{accountId}/treatment-plans/illustrate

Request

  • Base URL
    http://<host-url>
  • URL
    http://<host-url>/hardship/v1/accounts/{accountId}/treatment-plans/illustrate
  • Auth
    HTTP bearer

Path parameters

accountIdinteger required

Request body

reasonsstring[] required
detailsstring required

Response

Treatment plan illustration generated

idstring uuid
account_idinteger
reasonsstring[]
detailsstring
start_datestring date
end_datestring date
state'DRAFT' | 'CANCELLED' | 'EXECUTED'
status'ILLUSTRATION' | 'EXPIRED' | 'SCHEDULED' | 'CANCELLED' | 'ACTIVE' | 'COMPLETED'
account_balance_at_savenumber
created_atstring date-time
created_bystring
illustrated_atstring date-time
illustration_expires_atstring date-time

Changes

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