Payment Defaults REST API Overview

Available Features

The REST API allows creditors to:

• Create new payment defaults
• Update payment default amount
• Send new notice to debtor
• End a payment default
• Set and modify publication end dates
• Delete payment defaults
• Get a list of payment defaults
• Get payment default by ID
• Query notifications sent to debtors

Service Overview

When a payment default is submitted, the system validates the provided data against the business rules of the Payment Default Register.

After successful validation, a payment default is created and the debtor notification process is initiated.

Once all publication requirements have been met, the payment default is automatically published in the Payment Default Register.

Environments

Sandbox

The Sandbox environment is intended for:

• Development
• Integration testing
• Business process validation

The environment allows users to create test data and execute test scenarios covering different stages of the payment default lifecycle.

Generate and Reset Endpoint for Sandbox only

Generate endpoint:
Use the generate endpoint to create a predefined set of test data. The generate endpoint automatically creates payment defaults in all statuses, enabling faster testing.
POST api/v1/payment-defaults/generate

Reset endpoint:
Use the reset endpoint to restore the Sandbox to its original test data. All created or modified payment defaults are replaced with the originally generated dataset.
POST api/v1/payment-defaults/reset

Live

The Live environment is intended for managing real payment defaults. Before production access is granted, the client must complete integration testing in the sandbox environment and confirm readiness for production. Creditinfo may perform basic technical checks, but the client remains responsible for validating the correctness of their integration.

Integration Process

Implementation of the REST API typically consists of the following stages:

1. Signing the service agreement
2. Provisioning API credentials and access
3. Development of the integration
4. Integration testing in the Sandbox environment
5. Go-live in the Live environment

Creditinfo provides support throughout the implementation process when required.

Permissions

Available API functionality depends on the permissions assigned to the creditor.

Permissions determine access to:

• Specific API functions
• Publication end date management
• Sandbox and Live environments

Permissions are configured by Creditinfo.

HTTP status codes:

The errors field is only present in validation error responses (422 Unprocessable Entity).

{
  "message": "Human-readable error description",
  "errors": { "fieldName": ["Validation detail"] }
}

Null and Empty Value Conventions

When a field has no value or is not applicable, the API returns the following defaults depending on the expected data type: