Loading
Documentation Powered by ReDoc

DFS Credit Fee Services API (latest)

Download OpenAPI specification:Download

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

204

No Content

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Internal Server Error

delete/v1.0/fees/{feeId}/creditfacilities/{creditFacilityId}/collateralTypes/{collateralTypeId}
https://example-host/v1.0/fees/{feeId}/creditfacilities/{creditFacilityId}/collateralTypes/{collateralTypeId}

Response samples

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

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:
application/json

Request

feeData
object (UpdateableProperty%3C%3E)

Wrapper around properties used in patch requests

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

Wrapper around properties used in patch requests

isInterestRateComponent
object (Api.Common.UpdateableProperty%3CBoolean%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/fees/{feeId}/creditfacilities/{creditFacilityId}/collateralTypes/{collateralTypeId}
https://example-host/v1.0/fees/{feeId}/creditfacilities/{creditFacilityId}/collateralTypes/{collateralTypeId}

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "feeData":
    {
    },
  • "billingPeriodId":
    {
    },
  • "isInterestRateComponent":
    {
    }
}

Response samples

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

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:
application/json

Request

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

Responses

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Internal Server Error

post/v1.0/fees/{feeId}/creditfacilities/{creditFacilityId}/collateralTypes/{collateralTypeId}
https://example-host/v1.0/fees/{feeId}/creditfacilities/{creditFacilityId}/collateralTypes/{collateralTypeId}

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "billingPeriodId": 0,
  • "feeData": "string",
  • "isInterestRateComponent": true
}

Response samples

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

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

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Internal Server Error

get/v1.0/fees/creditfacilities/{creditFacilityId}/collateraltypes/{collateralTypeId}
https://example-host/v1.0/fees/creditfacilities/{creditFacilityId}/collateraltypes/{collateralTypeId}

Response samples

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

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

204

No Content

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Internal Server Error

delete/v1.0/fees/{feeId}/creditFacilities/{creditFacilityId}
https://example-host/v1.0/fees/{feeId}/creditFacilities/{creditFacilityId}

Response samples

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

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:
application/json

PatchCreditFacility Request

feeData
object (UpdateableProperty%3C%3E)

Wrapper around properties used in patch requests

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

Wrapper around properties used in patch requests

isInterestRateComponent
object (Api.Common.UpdateableProperty%3CBoolean%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/fees/{feeId}/creditFacilities/{creditFacilityId}
https://example-host/v1.0/fees/{feeId}/creditFacilities/{creditFacilityId}

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "feeData":
    {
    },
  • "billingPeriodId":
    {
    },
  • "isInterestRateComponent":
    {
    }
}

Response samples

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

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:
application/json
billingPeriodId
required
integer <int32>
feeData
required
string non-empty
isInterestRateComponent
boolean

Responses

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Internal Server Error

post/v1.0/fees/{feeId}/creditFacilities/{creditFacilityId}
https://example-host/v1.0/fees/{feeId}/creditFacilities/{creditFacilityId}

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "billingPeriodId": 0,
  • "feeData": "string",
  • "isInterestRateComponent": true
}

Response samples

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

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

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Internal Server Error

get/v1.0/fees/creditFacilities/{creditFacilityId}
https://example-host/v1.0/fees/creditFacilities/{creditFacilityId}

Response samples

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

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

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Internal Server Error

get/v1.0/creditFacilities/{creditFacilityId}/fees
https://example-host/v1.0/creditFacilities/{creditFacilityId}/fees

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "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

204

No Content

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Internal Server Error

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

Response samples

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

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

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Internal Server Error

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

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": 0,
  • "name": "string",
  • "dynamicSchemaId": 0,
  • "createDate": "2025-05-09T12:06:31Z",
  • "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:
application/json

PatchFeeRequest

name
object (UpdateableProperty%3C%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

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

Wrapper around properties used in patch requests

storedProcedure
object (UpdateableProperty%3C%3E)

Wrapper around properties used in patch requests

externalId
object (UpdateableProperty%3C%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/fees/{id}
https://example-host/v1.0/fees/{id}

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "name":
    {
    },
  • "dynamicSchemaId":
    {
    },
  • "isActive":
    {
    },
  • "storedProcedure":
    {
    },
  • "externalId":
    {
    }
}

Response samples

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

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

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

500

Internal Server Error

get/v1.0/fees
https://example-host/v1.0/fees

Response samples

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

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:
application/json
name
required
string non-empty
dynamicSchemaId
integer <int32> Nullable
isActive
boolean
storedProcedure
string Nullable
externalId
string Nullable

Responses

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Internal Server Error

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

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "name": "string",
  • "dynamicSchemaId": 0,
  • "isActive": true,
  • "storedProcedure": "string",
  • "externalId": "string"
}

Response samples

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

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

204

No Content

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Internal Server Error

delete/v1.0/fees/{feeId}/products/{productId}
https://example-host/v1.0/fees/{feeId}/products/{productId}

Response samples

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

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:
application/json

Request

feeData
object (UpdateableProperty%3C%3E)

Wrapper around properties used in patch requests

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

Wrapper around properties used in patch requests

isInterestRateComponent
object (Api.Common.UpdateableProperty%3CBoolean%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/fees/{feeId}/products/{productId}
https://example-host/v1.0/fees/{feeId}/products/{productId}

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "feeData":
    {
    },
  • "billingPeriodId":
    {
    },
  • "isInterestRateComponent":
    {
    }
}

Response samples

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

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:
application/json

Request

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

Responses

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Internal Server Error

post/v1.0/fees/{feeId}/products/{productId}
https://example-host/v1.0/fees/{feeId}/products/{productId}

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "billingPeriodId": 0,
  • "feeData": "string",
  • "isInterestRateComponent": true
}

Response samples

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

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

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Internal Server Error

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

Response samples

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