If you create settlements in your own system, for example in your contact centre or ERP, you put them into the portal through the API. First fetch the settlement profiles, put the terms together and send the settlement to the collection order. The portal checks that it fits the profile.
How to do it
- Fetch the profiles with
GET /v3/settlement_profiles. Per profile you get the name, whether it is the default, and the limits: minimum and maximum number of terms and the minimum amount per term. Show the profiles, for example, as a drop-down list in your own system. - Put the terms together: per term the sequence number, the amount, when the message is sent and the due date.
- Create the settlement with
POST /v3/collection_orders/{id}/settlement, with the chosen profile and the terms. If you leave out the profile, the default profile applies. - Follow the settlement with
GET /v3/collection_orders/{id}/settlement: the status of the settlement and of each term.
What the portal checks
- The terms add up to the outstanding amount of the collection order.
- The number of terms and the amount per term fit within the profile.
- Dates are not in the past and terms do not overlap.
- The collection order is active. If a settlement is already running, the request is rejected.
The profile also determines what happens when a term is not paid. See Settlement profiles explained.
Good to know
- Changing a running settlement through the API is planned. Until then you change a settlement in the portal. See Editing or cancelling a settlement.
- A settlement you create through the API appears in the portal like any other settlement.