Loading
API docs by Redocly

DFS Credit Fee Services API (latest)

Download OpenAPI specification:

Contains functionality around credit fee.

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.

CollateralType

Delete a collateral type fee

Unlink the fee from the collateral type and delete its specific fee data.

Authorizations:
Bearer
path Parameters
feeId
required
integer <int32>

Fee identifier

creditFacilityId
required
integer <int32>

CreditFacility Identifier

collateralTypeId
required
integer <int32>

CollateralType 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"
}

Modify a collateral type fee

Modifies the data of a fee that is linked to a collateral type.

Authorizations:
Bearer
path Parameters
feeId
required
integer <int32>

Fee identifier

creditFacilityId
required
integer <int32>

CreditFacility Identifier

collateralTypeId
required
integer <int32>

CollateralType Identifier

header Parameters
Accept-Language
string

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

Request Body schema:

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<Boolean>)

Wrapper around properties used in patch requests

Responses

Request samples

Content type
{
  • "feeData": {
    },
  • "billingPeriodId": {
    },
  • "isInterestRateComponent": {
    }
}

Response samples

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

Link a fee to a collateral type

Links an existing fee to an existing collateral type and saves the fee data specific for it.

Authorizations:
Bearer
path Parameters
feeId
required
integer <int32>

Fee identifier

creditFacilityId
required
integer <int32>

Credit identifier

collateralTypeId
required
integer <int32>

CollateralType Identifier

header Parameters
Accept-Language
string

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

Request Body schema:

Request

billingPeriodId
required
integer <int32>
feeData
required
string non-empty
isInterestRateComponent
boolean

Responses

Request samples

Content type
{
  • "billingPeriodId": 0,
  • "feeData": "string",
  • "isInterestRateComponent": true
}

Response samples

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

Get all the fees assigned to a collateral type

Gets all the fees assigned to a collateral type together with the fee details.

Authorizations:
Bearer
path Parameters
creditFacilityId
required
integer <int32>

CreditFacility Identifier

collateralTypeId
required
integer <int32>

CollateralType Identifier

header Parameters
Accept-Language
string

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

Responses

Response samples

Content type
application/json
[
  • {
    }
]

CreditFacility

Delete a fee credit facility

Unlink the fee from the credit facility and delete its specific fee data.

Authorizations:
Bearer
path Parameters
feeId
required
integer <int32>

Fee ID

creditFacilityId
required
integer <int32>

Credit Facility 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"
}

Modify a fee credit facility

Modifies the data of a fee that is linked to a credit facility.

Authorizations:
Bearer
path Parameters
feeId
required
integer <int32>

Fee ID

creditFacilityId
required
integer <int32>

CreditFacility ID

header Parameters
Accept-Language
string

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

Request Body schema:

PatchCreditFacility 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<Boolean>)

Wrapper around properties used in patch requests

Responses

Request samples

Content type
{
  • "feeData": {
    },
  • "billingPeriodId": {
    },
  • "isInterestRateComponent": {
    }
}

Response samples

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

Link a fee to a credit facility

Links an existing fee to an existing credit facility and saves the fee data specific for it.

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

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

Request Body schema:
billingPeriodId
required
integer <int32>
feeData
required
string non-empty
isInterestRateComponent
boolean

Responses

Request samples

Content type
{
  • "billingPeriodId": 0,
  • "feeData": "string",
  • "isInterestRateComponent": true
}

Response samples

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

Get all the fees assigned to a credit facility

Gets all the fees assigned to a credit facility together with the fee details.

Authorizations:
Bearer
path Parameters
creditFacilityId
required
integer <int32>

CreditFacility ID

header Parameters
Accept-Language
string

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

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get a detailed list of all the fees part of a credit facility

Gets a detailed list of all the fees part of a credit facility.

Authorizations:
Bearer
path Parameters
creditFacilityId
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
{
  • "collateralTypeFees": [
    ],
  • "productFees": [
    ],
  • "creditFacilityFees": [
    ]
}

Fee

Delete a fee

Deletes an existing fee that is not assigned to any credit facilities, products or collateral type.

Authorizations:
Bearer
path Parameters
id
required
integer <int32>

Fee 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 fee details

Gets all the details of an existing fee and its linkage to credit facilities, products, or collateral type.

Authorizations:
Bearer
path Parameters
id
required
integer <int32>

Fee ID

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",
  • "dynamicSchemaId": 0,
  • "createDate": "2019-08-24T14:15:22Z",
  • "isActive": true,
  • "storedProcedure": "string",
  • "externalId": "string",
  • "creditFacilityFees": [
    ],
  • "productFees": [
    ],
  • "collateralTypeFees": [
    ]
}

Modify an existing fee

Modifies an existing fee. Be aware that modifying the dynamic schema id will result in corrupt fees if they are already assigned to a credit facility, product or collateral type.

Authorizations:
Bearer
path Parameters
id
required
integer <int32>

Fee ID

header Parameters
Accept-Language
string

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

Request Body schema:

PatchFeeRequest

object (UpdateableProperty<>)

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<Boolean>)

Wrapper around properties used in patch requests

object (UpdateableProperty<>)

Wrapper around properties used in patch requests

object (UpdateableProperty<>)

Wrapper around properties used in patch requests

Responses

Request samples

Content type
{
  • "name": {
    },
  • "dynamicSchemaId": {
    },
  • "isActive": {
    },
  • "storedProcedure": {
    },
  • "externalId": {
    }
}

Response samples

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

Get fees

Gets a list of all the existing fees with basic information.

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 fee

Creates a new fee with a dynamic structure. After the fee is created it can be assigned to a specific credit facilities, products or collateral type.

Authorizations:
Bearer
header Parameters
Accept-Language
string

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

Request Body schema:
name
required
string non-empty
dynamicSchemaId
integer or null <int32>
isActive
boolean
storedProcedure
string or null
externalId
string or null

Responses

Request samples

Content type
{
  • "name": "string",
  • "dynamicSchemaId": 0,
  • "isActive": true,
  • "storedProcedure": "string",
  • "externalId": "string"
}

Response samples

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

Product

Delete a product fee

Unlink the fee from the product and delete its specific fee data.

Authorizations:
Bearer
path Parameters
feeId
required
integer <int32>

Fee identifier

productId
required
integer <int32>

Product 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"
}

Modify a product fee

Modifies the data of a fee that is linked to a product.

Authorizations:
Bearer
path Parameters
feeId
required
integer <int32>

Fee identifier

productId
required
integer <int32>

Product Identifier

header Parameters
Accept-Language
string

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

Request Body schema:

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<Boolean>)

Wrapper around properties used in patch requests

Responses

Request samples

Content type
{
  • "feeData": {
    },
  • "billingPeriodId": {
    },
  • "isInterestRateComponent": {
    }
}

Response samples

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

Link a fee to a product

Links an existing fee to an existing product and saves the fee data specific for it.

Authorizations:
Bearer
path Parameters
feeId
required
integer <int32>

Fee identifier

productId
required
integer <int32>

Product Identifier

header Parameters
Accept-Language
string

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

Request Body schema:

Request

billingPeriodId
required
integer <int32>
feeData
required
string non-empty
isInterestRateComponent
boolean

Responses

Request samples

Content type
{
  • "billingPeriodId": 0,
  • "feeData": "string",
  • "isInterestRateComponent": true
}

Response samples

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

Get all the fees assigned to a product

Gets all the fees assigned to a product together with the fee details.

Authorizations:
Bearer
path Parameters
productId
required
integer <int32>

Product Identifier

header Parameters
Accept-Language
string

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

Responses

Response samples

Content type
application/json
[
  • {
    }
]