Create a New Payment Default

Submits a new payment default entry. Upon successful creation, the payment default ID is returned, which can be used to retrieve or update the payment default.

At least one contact method is required: either an email address or a full postal address (street, city, country, and postalCode). Up to 4 email addresses, 4 phone numbers, and 4 IBAN bank account numbers can be provided. Notices are sent to every contact address provided. Phone (SMS) is an additional notification channel.

A 422 Unprocessable Entity error is returned if:
- subjectCode fails personal identification code or registration code validation or is missing.
- contractNo exceeds 50 characters or is missing.
- beginDate is missing, not in YYYY-MM-DD format, is less than 38 days, or is earlier than 15 years ago.
- debtSum is missing, less than 30.00, or greater than 999999.99.
- bankAccountNumbers contains an invalid IBAN.
- referenceNumber is invalid.
- debtorContactDetails is missing or incomplete (no email or post address provided).
- A duplicate payment default - when already exists with the same subjectCode, beginDate, and contractNo.

Body Params
string
required

Debtor's personal identification code or registration code. Can be provided as a string or a number.

string
required
length ≤ 50

Contract number. Maximum 50 characters.

date
required

Start date in YYYY-MM-DD format. Cannot be earlier than 15 years ago. Cannot be submitted if the debtor's outstanding debt is less than 38 days.

string
required

Payment default amount. Decimal with 2 decimal places. Minimum 30.00, maximum 999999.99.

debtorContactDetails
object
required

Contact details of the debtor. At least one contact method is required: either email or post (with all fields filled in). Up to 4 email addresses, 4 phone numbers. Notices are sent to every contact address provided.
Phone (SMS) is an additional notification channel.

string

Payment reference number. Optional. If sent then used on e-mail and post notices.

bankAccountNumbers
array of strings
length ≤ 4

Bank account number(s) in IBAN format. Optional. Up to 4 IBAN numbers can be supplied. If sent then used on e-mail and post notices.
Example: [
"EE382200221020145685",
"EE572200982880745761",
"EE452200267069251215",
"EE202200461919225708"
]

bankAccountNumbers
Responses

Language
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json