TRtrueaccord
Debts

Get debt total to collect balance

Read a debt's total to collect balance

get/customers/{customerId}/debts/{debtId}/totalToCollectBalance

Request

Response

Returns the requested debt object.

billerstring

For aggregators and marketplaces: this field stores the name of your sub merchant.

productstring

description of the product or service associated with this debt.

transactionIdstring

arbitrary string that you can use to store a reference to the transaction on your system.

transactionIpstring

IP address associated with this transaction. Either in IPv4 or IPv6 format.

transactionTimestampinteger

time that the transaction leading to the debt occurred, if applicable. Format: milliseconds since Jan 1st, 1970 UTC. For example, the origination date of the loan or the date the customer purchased the product which led to the debt. This should be before the defaultTimestamp. Note that this date may be shown to the customer to provide context on the debt, and also has ramifications in our system's compliance rules.

defaultTimestampinteger

Milliseconds since Jan 1st, 1970 UTC.

accountOpenTimestampinteger

Milliseconds since Jan 1st, 1970 UTC.

clientFieldsobject

Client-specific key-value pairs.

sendCbrNegativeNoticeboolean

Boolean flag indicating whether a negative notice WILL BE submitted to a credit bureau in the future.

hasSentCbrNegativeNoticeboolean

Boolean flag indicating whether a negative notice HAS BEEN submitted to a credit bureau in the past.

Example response

{
  "initialPrincipal": {
    "amount": 30000,
    "currency": "USD"
  },
  "initialInterest": {
    "amount": 30000,
    "currency": "USD"
  },
  "initialFees": {
    "amount": 30000,
    "currency": "USD"
  },
  "postChargeOffInformation": {
    "balanceAtChargeOff": {
      "amount": 30000,
      "currency": "USD"
    },
    "feesAccruedSinceChargeOff": {
      "amount": 30000,
      "currency": "USD"
    },
    "interestAccruedSinceChargeOff": {
      "amount": 30000,
      "currency": "USD"
    },
    "totalPaidSinceChargeOff": {
      "amount": 30000,
      "currency": "USD"
    }
  }
}

Changes

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