Loading
Documentation Powered by ReDoc

DFS Credit Product Services API (latest)

Download OpenAPI specification:Download

Contains functionality around credit facilities.

For endpoints that support localization the language can be passed either as a query string parameter (using the name 'language') or in the 'accept-language' header.
If no language is passed to such endpoints then the default configured language will be used.

CreditFacilities

Get credit products assigned to a facility

Gets a list of all the available products assigned to a facility and their details.

Authorizations:
Bearer
path Parameters
creditFacilityId
required
integer <int32>

CreditFacility Identifier

header Parameters
Accept-Language
string

The ISO 639-1 language to use for localizable data.

Responses

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Internal Server Error

get/v1.0/creditfacilities/{creditFacilityId}/products
https://example-host/v1.0/creditfacilities/{creditFacilityId}/products

Response samples

Content type
application/json
Copy
 Expand all Collapse all
[
  • {
    }
]

Products

Delete an existing credit product

Deletes an existing credit product.

Authorizations:
Bearer
path Parameters
id
required
integer <int32>

Credit Product Id

header Parameters
Accept-Language
string

The ISO 639-1 language to use for localizable data.

Responses

204

No Content

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Internal Server Error

delete/v1.0/products/{id}
https://example-host/v1.0/products/{id}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "code": "General",
  • "subCode": "string",
  • "message": "string",
  • "correlationId": "string",
  • "properties":
    {
    }
}

Get credit product

Gets a product and its details.

Authorizations:
Bearer
path Parameters
id
required
integer <int32>
header Parameters
Accept-Language
string

The ISO 639-1 language to use for localizable data.

Responses

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Internal Server Error

get/v1.0/products/{id}
https://example-host/v1.0/products/{id}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "name": "string",
  • "minAmount": 0,
  • "maxAmount": 0,
  • "productBaseId": 0,
  • "minimumPeriod": 0,
  • "maximumPeriod": 0,
  • "daysPeriod": 0,
  • "repaymentIds":
    [
    ],
  • "isActive": true,
  • "id": 0,
  • "creditFacilityId": 0,
  • "defaultBillingPeriod":
    {
    },
  • "feeIds":
    [
    ]
}

Modify an existing credit product

Modifies an existing credit product. A range of years or a fixed number of years can be defined. The range is configured with minimum period and maximum period parameters. The fixed period is configured with years period.

Authorizations:
Bearer
path Parameters
id
required
integer <int32>
header Parameters
Accept-Language
string

The ISO 639-1 language to use for localizable data.

Request Body schema:
application/json
name
object (UpdateableProperty%3C%3E)

Wrapper around properties used in patch requests

creditFacilityId
object (Api.Common.UpdateableProperty%3CInt32%3E)

Wrapper around properties used in patch requests

minimumPeriod
object (Api.Common.UpdateableProperty%3CSystem.Nullable%3CInt32%3E%3E)

Wrapper around properties used in patch requests

maximumPeriod
object (Api.Common.UpdateableProperty%3CSystem.Nullable%3CInt32%3E%3E)

Wrapper around properties used in patch requests

daysPeriod
object (Api.Common.UpdateableProperty%3CSystem.Nullable%3CInt32%3E%3E)

Wrapper around properties used in patch requests

minAmount
object (Api.Common.UpdateableProperty%3CSystem.Nullable%3CDecimal%3E%3E)

Wrapper around properties used in patch requests

maxAmount
object (Api.Common.UpdateableProperty%3CSystem.Nullable%3CDecimal%3E%3E)

Wrapper around properties used in patch requests

defaultBillingPeriodId
object (Api.Common.UpdateableProperty%3CSystem.Nullable%3CInt32%3E%3E)

Wrapper around properties used in patch requests

repaymentIds
object (Api.Common.UpdateableProperty%3CSystem.Collections.Generic.ICollection%3CInt32%3E%3E)

Wrapper around properties used in patch requests

isActive
object (Api.Common.UpdateableProperty%3CBoolean%3E)

Wrapper around properties used in patch requests

productBaseId
object (Api.Common.UpdateableProperty%3CInt32%3E)

Wrapper around properties used in patch requests

Responses

204

No Content

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Internal Server Error

patch/v1.0/products/{id}
https://example-host/v1.0/products/{id}

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "name":
    {
    },
  • "creditFacilityId":
    {
    },
  • "minimumPeriod":
    {
    },
  • "maximumPeriod":
    {
    },
  • "daysPeriod":
    {
    },
  • "minAmount":
    {
    },
  • "maxAmount":
    {
    },
  • "defaultBillingPeriodId":
    {
    },
  • "repaymentIds":
    {
    },
  • "isActive":
    {
    },
  • "productBaseId":
    {
    }
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "code": "General",
  • "subCode": "string",
  • "message": "string",
  • "correlationId": "string",
  • "properties":
    {
    }
}

Create a new credit product

Creates a new credit product. A range of years or a fixed number of years can be defined. The range is configured with minimum period and maximum period parameters. The fixed period is configured with years period.

Authorizations:
Bearer
header Parameters
Accept-Language
string

The ISO 639-1 language to use for localizable data.

Request Body schema:
application/json

Create credit product request

name
required
string non-empty
minAmount
required
number <double>
maxAmount
required
number <double>
productBaseId
required
integer <int32>
minimumPeriod
integer <int32> Nullable
maximumPeriod
integer <int32> Nullable
daysPeriod
integer <int32> Nullable
repaymentIds
Array of integers <int32> Nullable
isActive
boolean
defaultBillingPeriodId
required
integer <int32>
creditFacilityId
required
integer <int32>

Responses

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Internal Server Error

post/v1.0/products
https://example-host/v1.0/products

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "name": "string",
  • "minAmount": 0,
  • "maxAmount": 0,
  • "productBaseId": 0,
  • "minimumPeriod": 0,
  • "maximumPeriod": 0,
  • "daysPeriod": 0,
  • "repaymentIds":
    [
    ],
  • "isActive": true,
  • "defaultBillingPeriodId": 0,
  • "creditFacilityId": 0
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "code": "General",
  • "subCode": "string",
  • "message": "string",
  • "correlationId": "string",
  • "properties":
    {
    }
}

ProductsBase

Delete an existing credit product base

Deletes an existing credit product base.

Authorizations:
Bearer
path Parameters
id
required
integer <int32>

Product Base Identifier

header Parameters
Accept-Language
string

The ISO 639-1 language to use for localizable data.

Responses

204

No Content

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Internal Server Error

delete/v1.0/products/base/{id}
https://example-host/v1.0/products/base/{id}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "code": "General",
  • "subCode": "string",
  • "message": "string",
  • "correlationId": "string",
  • "properties":
    {
    }
}

Get one credit products base

Gets one credit products base.

Authorizations:
Bearer
path Parameters
id
required
integer <int32>

Product Base Identifier

header Parameters
Accept-Language
string

The ISO 639-1 language to use for localizable data.

Responses

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Internal Server Error

get/v1.0/products/base/{id}
https://example-host/v1.0/products/base/{id}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": 0,
  • "name": "string",
  • "creditFacilityTypeId": 0,
  • "defaultInterestRate": 0,
  • "minimumPeriod": 0,
  • "maximumPeriod": 0,
  • "daysPeriod": 0,
  • "defaultAmortisationPeriod": 0,
  • "creditFacilityIds":
    [
    ],
  • "dynamicSchemaId": 0
}

Modify existing credit product base

Modifies existing credit product base. A range of years or a fixed number of years can be defined. The range is configured with minimum period and maximum period parameters. The fixed period is configured with years period.

Authorizations:
Bearer
path Parameters
id
required
integer <int32>
header Parameters
Accept-Language
string

The ISO 639-1 language to use for localizable data.

Request Body schema:
application/json

Patch Product Base Request

name
object (UpdateableProperty%3C%3E)

Wrapper around properties used in patch requests

creditFacilityTypeId
object (Api.Common.UpdateableProperty%3CInt32%3E)

Wrapper around properties used in patch requests

defaultInterestRate
object (Api.Common.UpdateableProperty%3CDecimal%3E)

Wrapper around properties used in patch requests

minimumPeriod
object (Api.Common.UpdateableProperty%3CSystem.Nullable%3CInt32%3E%3E)

Wrapper around properties used in patch requests

maximumPeriod
object (Api.Common.UpdateableProperty%3CSystem.Nullable%3CInt32%3E%3E)

Wrapper around properties used in patch requests

daysPeriod
object (Api.Common.UpdateableProperty%3CSystem.Nullable%3CInt32%3E%3E)

Wrapper around properties used in patch requests

defaultAmortisationPeriod
object (Api.Common.UpdateableProperty%3CSystem.Nullable%3CDecimal%3E%3E)

Wrapper around properties used in patch requests

dynamicSchemaId
object (Api.Common.UpdateableProperty%3CSystem.Nullable%3CInt32%3E%3E)

Wrapper around properties used in patch requests

Responses

204

No Content

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Internal Server Error

patch/v1.0/products/base/{id}
https://example-host/v1.0/products/base/{id}

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "name":
    {
    },
  • "creditFacilityTypeId":
    {
    },
  • "defaultInterestRate":
    {
    },
  • "minimumPeriod":
    {
    },
  • "maximumPeriod":
    {
    },
  • "daysPeriod":
    {
    },
  • "defaultAmortisationPeriod":
    {
    },
  • "dynamicSchemaId":
    {
    }
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "code": "General",
  • "subCode": "string",
  • "message": "string",
  • "correlationId": "string",
  • "properties":
    {
    }
}

Get all the credit products base

Gets all the credit products base.

Authorizations:
Bearer
header Parameters
Accept-Language
string

The ISO 639-1 language to use for localizable data.

Responses

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

500

Internal Server Error

get/v1.0/products/base
https://example-host/v1.0/products/base

Response samples

Content type
application/json
Copy
 Expand all Collapse all
[
  • {
    }
]

Create a new credit product base

Creates a new credit product base. A range of years or a fixed number of years can be defined. The range is configured with minimum period and maximum period parameters. The fixed period is configured with years period.

Authorizations:
Bearer
header Parameters
Accept-Language
string

The ISO 639-1 language to use for localizable data.

Request Body schema:
application/json

Create Product Base Request

name
required
string non-empty
creditFacilityTypeId
required
integer <int32>
defaultInterestRate
number <double>
minimumPeriod
integer <int32> Nullable
maximumPeriod
integer <int32> Nullable
daysPeriod
integer <int32> Nullable
defaultAmortisationPeriod
number <double> Nullable
dynamicSchemaId
integer <int32> Nullable

Responses

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Internal Server Error

post/v1.0/products/base
https://example-host/v1.0/products/base

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "name": "string",
  • "creditFacilityTypeId": 0,
  • "defaultInterestRate": 0,
  • "minimumPeriod": 0,
  • "maximumPeriod": 0,
  • "daysPeriod": 0,
  • "defaultAmortisationPeriod": 0,
  • "dynamicSchemaId": 0
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "code": "General",
  • "subCode": "string",
  • "message": "string",
  • "correlationId": "string",
  • "properties":
    {
    }
}