Loading
API docs by Redocly

DFS Credit Product Services API (latest)

Download OpenAPI specification:

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

Response samples

Content type
application/json
[
  • {
    }
]

Products

Delete an existing credit product Deprecated

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

Response samples

Content type
application/json
{
  • "code": "BadRequest",
  • "subCode": "NA",
  • "message": "The request was not in the required format",
  • "correlationId": "30d3ebc0b5cb47b0889850bbdfe4aec6"
}

Get credit product Deprecated

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

Response samples

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

Modify an existing credit product Deprecated

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:
object (UpdateableProperty<>)

Wrapper around properties used in patch requests

object (Api.Common.UpdateableProperty<Int32>)

Wrapper around properties used in patch requests

object (Api.Common.UpdateableProperty<System.Nullable<Int32>>)

Wrapper around properties used in patch requests

object (Api.Common.UpdateableProperty<System.Nullable<Int32>>)

Wrapper around properties used in patch requests

object (Api.Common.UpdateableProperty<System.Nullable<Int32>>)

Wrapper around properties used in patch requests

object (Api.Common.UpdateableProperty<System.Nullable<Decimal>>)

Wrapper around properties used in patch requests

object (Api.Common.UpdateableProperty<System.Nullable<Decimal>>)

Wrapper around properties used in patch requests

object (Api.Common.UpdateableProperty<System.Nullable<Int32>>)

Wrapper around properties used in patch requests

object (Api.Common.UpdateableProperty<System.Collections.Generic.ICollection<Int32>>)

Wrapper around properties used in patch requests

object (Api.Common.UpdateableProperty<Boolean>)

Wrapper around properties used in patch requests

object (Api.Common.UpdateableProperty<Int32>)

Wrapper around properties used in patch requests

Responses

Request samples

Content type
{
  • "name": {
    },
  • "creditFacilityId": {
    },
  • "minimumPeriod": {
    },
  • "maximumPeriod": {
    },
  • "daysPeriod": {
    },
  • "minAmount": {
    },
  • "maxAmount": {
    },
  • "defaultBillingPeriodId": {
    },
  • "repaymentIds": {
    },
  • "isActive": {
    },
  • "productBaseId": {
    }
}

Response samples

Content type
application/json
{
  • "code": "BadRequest",
  • "subCode": "NA",
  • "message": "The request was not in the required format",
  • "correlationId": "30d3ebc0b5cb47b0889850bbdfe4aec6"
}

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

Response samples

Content type
application/json
{
  • "code": "BadRequest",
  • "subCode": "NA",
  • "message": "The request was not in the required format",
  • "correlationId": "30d3ebc0b5cb47b0889850bbdfe4aec6"
}

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

Response samples

Content type
application/json
{
  • "name": "string",
  • "minAmount": 0.1,
  • "maxAmount": 0.1,
  • "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:
object (UpdateableProperty<>)

Wrapper around properties used in patch requests

object (Api.Common.UpdateableProperty<Int32>)

Wrapper around properties used in patch requests

object (Api.Common.UpdateableProperty<System.Nullable<Int32>>)

Wrapper around properties used in patch requests

object (Api.Common.UpdateableProperty<System.Nullable<Int32>>)

Wrapper around properties used in patch requests

object (Api.Common.UpdateableProperty<System.Nullable<Int32>>)

Wrapper around properties used in patch requests

object (Api.Common.UpdateableProperty<System.Nullable<Decimal>>)

Wrapper around properties used in patch requests

object (Api.Common.UpdateableProperty<System.Nullable<Decimal>>)

Wrapper around properties used in patch requests

object (Api.Common.UpdateableProperty<System.Nullable<Int32>>)

Wrapper around properties used in patch requests

object (Api.Common.UpdateableProperty<System.Collections.Generic.ICollection<Int32>>)

Wrapper around properties used in patch requests

object (Api.Common.UpdateableProperty<Boolean>)

Wrapper around properties used in patch requests

object (Api.Common.UpdateableProperty<Int32>)

Wrapper around properties used in patch requests

Responses

Request samples

Content type
{
  • "name": {
    },
  • "creditFacilityId": {
    },
  • "minimumPeriod": {
    },
  • "maximumPeriod": {
    },
  • "daysPeriod": {
    },
  • "minAmount": {
    },
  • "maxAmount": {
    },
  • "defaultBillingPeriodId": {
    },
  • "repaymentIds": {
    },
  • "isActive": {
    },
  • "productBaseId": {
    }
}

Response samples

Content type
application/json
{
  • "code": "BadRequest",
  • "subCode": "NA",
  • "message": "The request was not in the required format",
  • "correlationId": "30d3ebc0b5cb47b0889850bbdfe4aec6"
}

Create a new credit product Deprecated

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:

Create credit product request

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

Responses

Request samples

Content type
{
  • "name": "string",
  • "minAmount": 0.1,
  • "maxAmount": 0.1,
  • "productBaseId": 0,
  • "minimumPeriod": 0,
  • "maximumPeriod": 0,
  • "daysPeriod": 0,
  • "repaymentIds": [
    ],
  • "isActive": true,
  • "defaultBillingPeriodId": 0,
  • "creditFacilityId": 0
}

Response samples

Content type
application/json
{
  • "code": "BadRequest",
  • "subCode": "NA",
  • "message": "The request was not in the required format",
  • "correlationId": "30d3ebc0b5cb47b0889850bbdfe4aec6"
}

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:

Create credit product request

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

Responses

Request samples

Content type
{
  • "name": "string",
  • "minAmount": 0.1,
  • "maxAmount": 0.1,
  • "productBaseId": 0,
  • "minimumPeriod": 0,
  • "maximumPeriod": 0,
  • "daysPeriod": 0,
  • "repaymentIds": [
    ],
  • "isActive": true,
  • "defaultBillingPeriodId": 0,
  • "creditFacilityId": 0
}

Response samples

Content type
application/json
{
  • "code": "BadRequest",
  • "subCode": "NA",
  • "message": "The request was not in the required format",
  • "correlationId": "30d3ebc0b5cb47b0889850bbdfe4aec6"
}

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

Response samples

Content type
application/json
{
  • "code": "BadRequest",
  • "subCode": "NA",
  • "message": "The request was not in the required format",
  • "correlationId": "30d3ebc0b5cb47b0889850bbdfe4aec6"
}

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

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "creditFacilityTypeId": 0,
  • "defaultInterestRate": 0.1,
  • "minimumPeriod": 0,
  • "maximumPeriod": 0,
  • "daysPeriod": 0,
  • "defaultAmortisationPeriod": 0.1,
  • "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:

Patch Product Base Request

object (UpdateableProperty<>)

Wrapper around properties used in patch requests

object (Api.Common.UpdateableProperty<Int32>)

Wrapper around properties used in patch requests

object (Api.Common.UpdateableProperty<Decimal>)

Wrapper around properties used in patch requests

object (Api.Common.UpdateableProperty<System.Nullable<Int32>>)

Wrapper around properties used in patch requests

object (Api.Common.UpdateableProperty<System.Nullable<Int32>>)

Wrapper around properties used in patch requests

object (Api.Common.UpdateableProperty<System.Nullable<Int32>>)

Wrapper around properties used in patch requests

object (Api.Common.UpdateableProperty<System.Nullable<Decimal>>)

Wrapper around properties used in patch requests

object (Api.Common.UpdateableProperty<System.Nullable<Int32>>)

Wrapper around properties used in patch requests

Responses

Request samples

Content type
{
  • "name": {
    },
  • "creditFacilityTypeId": {
    },
  • "defaultInterestRate": {
    },
  • "minimumPeriod": {
    },
  • "maximumPeriod": {
    },
  • "daysPeriod": {
    },
  • "defaultAmortisationPeriod": {
    },
  • "dynamicSchemaId": {
    }
}

Response samples

Content type
application/json
{
  • "code": "BadRequest",
  • "subCode": "NA",
  • "message": "The request was not in the required format",
  • "correlationId": "30d3ebc0b5cb47b0889850bbdfe4aec6"
}

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

Response samples

Content type
application/json
[
  • {
    }
]

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:

Create Product Base Request

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

Responses

Request samples

Content type
{
  • "name": "string",
  • "creditFacilityTypeId": 0,
  • "defaultInterestRate": 0.1,
  • "minimumPeriod": 0,
  • "maximumPeriod": 0,
  • "daysPeriod": 0,
  • "defaultAmortisationPeriod": 0.1,
  • "dynamicSchemaId": 0
}

Response samples

Content type
application/json
{
  • "code": "BadRequest",
  • "subCode": "NA",
  • "message": "The request was not in the required format",
  • "correlationId": "30d3ebc0b5cb47b0889850bbdfe4aec6"
}