Response Structure

The response returns an array of Promise To Pay records for the specified lending account.

Top-Level Fields

message (array)
- List of Promise To Pay records.

Promise To Pay Fields

Each object in the message array represents a Promise To Pay record and includes:

name
- Internal unique identifier for the record.
lending_account_id
- Associated lending account number.
promise_to_pay_name
- Promise To Pay reference ID.
balance_id
- Related balance identifier.
balance_description
- Description of the balance (Primary Loan, Deferred Down, etc.).
start_date
- Date when the Promise To Pay was created.
promised_by
- Identifier of the user who created the Promise To Pay.
total_promised_amount
- Total amount promised for the Promise To Pay.
status
- Overall Promise To Pay status (Active, Removed, Kept, Broken).
removal_reason_code
- Reason for removal, if applicable.
promise_to_pay_note
- Notes added at the Promise To Pay level.

Promise Schedule Details

Each Promise To Pay record also contains scheduling and payment information:

promised_date
- Date on which the payment was promised.
promised_amount
- Amount promised for the specific date.
receipt_method
- Method through which the promise was created (Web, Phone, etc.).
payment_method
- Payment method used (Cash, ACH, Card, etc.).
payment_account
- Internal payment account reference.
payment_account_readable_name
- Human-readable payment account name.
note
- Additional notes related to the promise.
paid_amount
- Amount paid against the promise.
promise_status
- Status of the individual promise entry.

Promise Lifecycle Tracking

The following fields indicate the outcome of the promise:

promise_kept_date
- Date when the promise was fulfilled.
promise_kept_transaction
- Transaction identifier if the promise was kept.
promise_removal_reason_code
- Reason code specific to promise removal.
promise_broken_date
- Date when the promise was marked as broken.

Example Response

{
  "message": [
    {
      "name": "0trgk1pnd6",
      "lending_account_id": "LA-004120",
      "promise_to_pay_name": "PTP-000678",
      "balance_id": "BA-009600",
      "balance_description": "Primary Loan Balance",
      "start_date": "2025-07-23",
      "promised_by": "2025-00051",
      "total_promised_amount": 3100.0,
      "status": "Removed",
      "removal_reason_code": "Incorrect Payment Date",
      "promised_date": "2025-07-23",
      "promised_amount": 3100.0,
      "receipt_method": "Web",
      "payment_method": "",
      "paid_amount": 0.0,
      "promise_status": "Removed"
    }
  ]
}