Contract Service

The BDK Contract Service

API Documentation

Swagger API Documentation

Order Status for retailers

To request the current status for the orders of the retailer that the user belongs to, a specific endpoint is provided. The endpoint considers the retailer company group and company group hierarchy and delivers all orders that the retailer is allowed to view.

How to use the endpoint

The order status list can be requested by sending a GET request to the /api/v2/orders/searchRetailerOrderStatus endpoint of Contract Service API

Optionally the following request parameters can be used to filter the orders:

orderId The UUID of the order that is requested.

minDate Minimum last modification date of the order in ISO format (eg. 2023-06-05T09:30:17.788529)

maxDate Maximum last modification date of the order in ISO format (eg. 2023-06-05T09:30:17.788529)

Structure of the response

[
    {
        "id": "8761b9c0-f2d0-470e-85b1-0244cb76efe9",
        "type": "FINANCING",
        "status": "SUCCESS",
        "retailerId": "8f8106da-887b-11ea-bc55-0242ac130003",
        "creationDate": "2023-06-05T09:30:17.788529",
        "lastModificationDate": "2023-06-05T09:34:57.611719",
        "contractNumber": "H100001010",
        "retailerOfferNumber": "123-456-789"
    },
    {
        "id": "80ccb9a8-8834-4151-845f-228c9f71e8ff",
        "type": "FINANCING",
        "status": "WAITING_FOR_DECISION",
        "retailerId": "8f8106da-887b-11ea-bc55-0242ac130003",
        "creationDate": "2023-06-05T09:16:11.560681",
        "lastModificationDate": "2023-06-05T09:29:49.653377",
        "contractNumber": "E100001009",
        "retailerOfferNumber": "123-456-aaa"
    },
    {
        "id": "ef91221d-c954-451b-91de-55cbaa30f8d8",
        "type": "FINANCING",
        "status": "WAITING_FOR_IDENTIFICATION",
        "retailerId": "8f8106da-887b-11ea-bc55-0242ac130003",
        "creationDate": "2023-06-05T09:13:04.617374",
        "lastModificationDate": "2023-06-05T09:14:20.712674",
        "contractNumber": "O100001008",
        "retailerOfferNumber": "123-456-bbb"
    }
]

Order status values and their meanings

'CREATED' Order has been created, customer has to enter data.

'WAITING_FOR_CONTRACT_NUMBER' Customer finished entering data, contract number is generated.

'READY_FOR_DECISION' Contract number is generated, order is ready for credit decision.

'WAITING_FOR_DECISION' Waiting for credit decision.

'DECISION_FAILED' Credit decision is negative, order cannot be edited anymore.

'WAITING_FOR_CONTRACT' Credit decision is positive, PDF contract is generated.

'READY_FOR_IDENTIFICATION' PDF contract is successfully generated, customer can start identification.

'WAITING_FOR_IDENTIFICATION' Identification has been triggered by customer, waiting for response from identification provider to confirm that identification can start.

'IDENTIFICATION_STARTED' Identification is started, identification provider checks identity of the customer.

'WAITING_FOR_IDENTIFICATION_COMPLETION' After the start of the identification, identification process waits to be finished.

'WAITING_FOR_IDENTIFICATION_RESULT' Identification is finished, waiting for the identification result from identification provider.

'IDENTIFICATION_ERROR' Identification failed due to technical errors.

'IDENTIFICATION_FRAUD' Identification provider detects a fraud attempt by the customer.

'WAITING_FOR_DOWNLOAD' Waiting for the customer to download the signed contract PDF document and confirm.

'WAITING_FOR_RETAILER_CONFIRMATION' Waiting for the retailer to accept the order.

'WAITING_FOR_USER_DOCUMENTS' Waiting for the customer to upload the requested documents.

'WAITING_FOR_RETAILER_DOCUMENTS' Waiting for the retailer to upload the requested documents.

'WAITING_FOR_BACKOFFICE' Waiting for the order to be checked and finalized by backoffice.

'WAITING_FOR_BOARDING' Waiting for the order to be imported into backend system.

'FAILED' Order is failed due to a technical problem.