Forth Pay

Sections

Theme switcher

Create Debt

Header Parameters

Api-Keystring Required

Body Parameters

client_idinteger

Unique identifier for the client associated with the debt.

creditor_namestring Required

Name of the creditor associated with the debt.

third_party_namestring

Name of the third party associated with the debt.

account_numberstring Required

Account number associated with the debt.

third_party_account_numberstring

Account number of the third party related to the debt.

debt_amountstring Required

The current amount of the debt.

Response

200
Object
OK

Response Attributes

idinteger

Unique identifier for the debt.

readOnly
modified_atstring

The timestamp indicating when the debt was last modified.

client_idinteger

Unique identifier for the client associated with the debt.

creditor_namestring

Name of the creditor associated with the debt.

third_party_namestring

Name of the third party associated with the debt.

account_numberstring Required

Account number associated with the debt.

third_party_account_numberstring

Account number of the third party related to the debt.

original_debt_amountstring

The original amount of the debt before any settlements.

readOnly
debt_amountstring

The current amount of the debt.

enrolledboolean

Indicates whether the debt is enrolled in a settlement program.

settledboolean

Indicates whether the debt has been settled.

readOnly
settlement_idinteger

Unique identifier for the settlement related to the debt.

readOnly
settlement_amountnumber

The amount to be settled for the debt.

readOnly
settlement_datestring

The date when the debt settlement occurred.

readOnly
400
Object
Error Response

Response Attributes

statusobject Required

The status parameter indicates the current status of the debt creation process. This parameter will return a success status if the debt was successfully created, or an error status if there was a problem with the creation process.

Show child attributes

403
Object
Was this section helpful?

What made this section unhelpful for you?

POST

/

Select
1

Response

Was this section helpful?

What made this section unhelpful for you?