API Reference
  1. Payment Defaults API
  2. Payment Defaults

Send a New Notice to Debtor

post
https://{BASE_URL}/v1/payment-defaults//notice

Sends a new notice to the debtor and updates the contact details of a PENDING payment default.

Contact details can only be updated for payment defaults with PENDING status. When contact details are resubmitted, the payment default's estimated publication date is extended — except when only an SMS (phone) notice is sent.

The system does not check whether a previous notice has already been successfully delivered to the same or a different address.

Notices are sent to every contact address provided. Phone (SMS) is an additional notification channel.

A 422 Unprocessable Entity error is returned if:
- The payment default status is not PENDING.
- bankAccountNumbers does not conform to the IBAN standard.
- An email address is invalid.
- A postal address is incomplete (all of street, city, country, and postalCode are required).

Path Params
integer
required

Unique identifier of the payment default.

Body Params
string

Payment reference number. Optional. Added to email and postal notice letters if provided.

debtorContactDetails
object
required

Contact details of the debtor. At least one contact method is required: either email, post or number. Up to 4 email addresses and 4 phone numbers can be provided.

bankAccountNumbers
array of strings
length ≤ 4

Bank account number(s) in IBAN format. Optional. Added to email and postal notice letters if provided. Up to 4 IBAN numbers can be supplied.

bankAccountNumbers
Responses

Updated 10 days ago

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

Updated 10 days ago

Did this page help you?