Forth Pay

Sections

Theme switcher

Get Debt

Header Parameters

Api-Keystring Required

Path Parameters

idinteger Required

Valid debt_id

Response

200
Object
Debt successfully retrieved

Response Attributes

idinteger

The unique identifier for the debt identified.

readOnly
modified_atstring

The date and time when the debt information was last modified.

client_idinteger

The unique identifier for the client associated with the debt.

creditor_namestring

The name of the creditor associated with the debt.

third_party_namestring

The name of the third party involved in the debt.

account_numberstring Required

The account number associated with the debt.

third_party_account_numberstring

The account number of the third party involved in the debt.

original_debt_amountstring

The original amount of the debt.

readOnly
debt_amountstring

The current amount of the debt.

enrolledboolean

Indicates whether the debt is enrolled or not.

settledboolean

Indicates whether the debt has been settled or not.

readOnly
settlement_idinteger

The unique identifier for the settlement of the debt.

readOnly
settlement_amountnumber

The amount settled for the debt.

readOnly
settlement_datestring

The date when the settlement occurred.

readOnly
400
Object
Authentication Error

Response Attributes

statusobject Required

The current status of the debt.

Show child attributes

Was this section helpful?

What made this section unhelpful for you?

GET

/

Select
1

Response

Was this section helpful?

What made this section unhelpful for you?