DFS Credit Facilities 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

Delete credit facility

Deletes an existing credit facility.

Authorizations:

Bearer

path Parameters

required

integer <int32>

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/creditfacilities/{id}

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

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"code": "General",
"subCode": "string",
"message": "string",
"correlationId": "string",
"properties": 
{"property1": null,
"property2": null
}
}

Get credit facility details

Gets all the details of the requested credit facility.

Authorizations:

Bearer

path Parameters

required

integer <int32>

header Parameters

Accept-Language

string

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

Responses

200

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Internal Server Error

get/v1.0/creditfacilities/{id}

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

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"id": 0,
"name": "string",
"creditFacilityTypeId": 0,
"riskClassTypeId": 0,
"bookingCenterCountryId": 0,
"jurisdictionCountryId": 0,
"currencyId": 0,
"contactTypeId": 0,
"isAutoApproved": true,
"isCommitted": true,
"reviewDate": "2025-05-09T12:06:30Z",
"minAmount": 0,
"maxAmount": 0,
"isActive": true,
"createDate": "2025-05-09T12:06:30Z",
"lenderId": 0,
"maxProducts": 0,
"maxBorrowers": 0,
"defaultOfferValidityDays": 0,
"isAutoValidated": true,
"collateralTypeIds": 
[0
],
"creditUsageIds": 
[0
],
"creditInstanceTypeIds": 
[0
],
"keyRiskIndicatorDetailIds": 
[0
],
"feeIds": 
[0
],
"repaymentIds": 
[0
],
"riskModelIds": 
[0
],
"productIds": 
[0
],
"collateralTypeRegionConstraints": 
[
{"collateralTypeId": 0,
"regionIds": 
[0
],
"constraintTypeId": 0
}
],
"creditFacilityType": 
{"id": 0,
"name": "string",
"key": "string",
"externalId": "string",
"parentId": 0,
"parentName": "string"
},
"repayments": 
[
{"id": 0,
"recurringPeriodDays": 0,
"seniorRankPercentage": 0,
"juniorRankPercentage": 0,
"mezzanineRankPercentage": 0,
"maxDurationDays": 0,
"collateralTypeId": 0,
"billingPeriodId": 0,
"repaymentTranchId": 0,
"repaymentTypeIds": 
[0
]
}
]
}

Modify credit facility details

Modifies an existing credit facility.

Authorizations:

Bearer

path Parameters

required

integer <int32>

Id of the credit facility that will be modified

header Parameters

Accept-Language

string

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

Request Body schema:
application/json

Patch credit facility 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
riskClassTypeId	object (Api.Common.UpdateableProperty%3CSystem.Nullable%3CInt32%3E%3E) Wrapper around properties used in patch requests
bookingCenterCountryId	object (Api.Common.UpdateableProperty%3CInt32%3E) Wrapper around properties used in patch requests
jurisdictionCountryId	object (Api.Common.UpdateableProperty%3CInt32%3E) Wrapper around properties used in patch requests
currencyId	object (Api.Common.UpdateableProperty%3CInt32%3E) Wrapper around properties used in patch requests
contactTypeId	object (Api.Common.UpdateableProperty%3CSystem.Nullable%3CInt32%3E%3E) Wrapper around properties used in patch requests
isCommitted	object (Api.Common.UpdateableProperty%3CSystem.Nullable%3CBoolean%3E%3E) Wrapper around properties used in patch requests
isAutoApproved	object (Api.Common.UpdateableProperty%3CSystem.Nullable%3CBoolean%3E%3E) Wrapper around properties used in patch requests
reviewDate	object (Api.Common.UpdateableProperty%3CSystem.Nullable%3CDateTime%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
isActive	object (Api.Common.UpdateableProperty%3CBoolean%3E) Wrapper around properties used in patch requests
lenderId	object (Api.Common.UpdateableProperty%3CInt32%3E) Wrapper around properties used in patch requests
maxProducts	object (Api.Common.UpdateableProperty%3CInt32%3E) Wrapper around properties used in patch requests
maxBorrowers	object (Api.Common.UpdateableProperty%3CInt32%3E) Wrapper around properties used in patch requests
defaultOfferValidityDays	object (Api.Common.UpdateableProperty%3CSystem.Nullable%3CInt32%3E%3E) Wrapper around properties used in patch requests
isAutoValidated	object (Api.Common.UpdateableProperty%3CBoolean%3E) Wrapper around properties used in patch requests
collateralTypeIds	object (Api.Common.UpdateableProperty%3CSystem.Collections.Generic.ICollection%3CInt32%3E%3E) Wrapper around properties used in patch requests
creditInstanceTypeIds	object (Api.Common.UpdateableProperty%3CSystem.Collections.Generic.ICollection%3CInt32%3E%3E) Wrapper around properties used in patch requests
creditUsageIds	object (Api.Common.UpdateableProperty%3CSystem.Collections.Generic.ICollection%3CInt32%3E%3E) Wrapper around properties used in patch requests
keyRiskIndicatorDetailIds	object (Api.Common.UpdateableProperty%3CSystem.Collections.Generic.ICollection%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
collateralTypeRegionConstraints	object (Api.Common.UpdateableProperty%3CSystem.Collections.Generic.ICollection%3CCollateralTypeRegionConstraint%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/creditfacilities/{id}

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

Request samples

Payload

Content type

Copy

Expand all Collapse all


{"name": 
{"doUpdate": true,
"value": "string"
},
"creditFacilityTypeId": 
{"doUpdate": true,
"value": 0
},
"riskClassTypeId": 
{"doUpdate": true,
"value": 0
},
"bookingCenterCountryId": 
{"doUpdate": true,
"value": 0
},
"jurisdictionCountryId": 
{"doUpdate": true,
"value": 0
},
"currencyId": 
{"doUpdate": true,
"value": 0
},
"contactTypeId": 
{"doUpdate": true,
"value": 0
},
"isCommitted": 
{"doUpdate": true,
"value": true
},
"isAutoApproved": 
{"doUpdate": true,
"value": true
},
"reviewDate": 
{"doUpdate": true,
"value": "2025-05-09T12:06:30Z"
},
"minAmount": 
{"doUpdate": true,
"value": 0
},
"maxAmount": 
{"doUpdate": true,
"value": 0
},
"isActive": 
{"doUpdate": true,
"value": true
},
"lenderId": 
{"doUpdate": true,
"value": 0
},
"maxProducts": 
{"doUpdate": true,
"value": 0
},
"maxBorrowers": 
{"doUpdate": true,
"value": 0
},
"defaultOfferValidityDays": 
{"doUpdate": true,
"value": 0
},
"isAutoValidated": 
{"doUpdate": true,
"value": true
},
"collateralTypeIds": 
{"doUpdate": true,
"value": 
[0
]
},
"creditInstanceTypeIds": 
{"doUpdate": true,
"value": 
[0
]
},
"creditUsageIds": 
{"doUpdate": true,
"value": 
[0
]
},
"keyRiskIndicatorDetailIds": 
{"doUpdate": true,
"value": 
[0
]
},
"repaymentIds": 
{"doUpdate": true,
"value": 
[0
]
},
"collateralTypeRegionConstraints": 
{"doUpdate": true,
"value": 
[
{"collateralTypeId": 0,
"regionIds": 
[0
],
"constraintTypeId": 0
}
]
}
}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"code": "General",
"subCode": "string",
"message": "string",
"correlationId": "string",
"properties": 
{"property1": null,
"property2": null
}
}

Create a new credit facility

Creates a new credit facility which can be part of the product offering.

Authorizations:

Bearer

header Parameters

Accept-Language

string

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

Request Body schema:
application/json

Create credit facility request

name required	string non-empty
creditFacilityTypeId required	integer <int32>
bookingCenterCountryId required	integer <int32>
jurisdictionCountryId required	integer <int32>
currencyId required	integer <int32>
contactTypeId required	integer <int32>
isAutoApproved required	boolean
isCommitted required	boolean
minAmount required	number <double>
maxAmount required	number <double>
isActive required	boolean
lenderId required	integer <int32>
maxProducts required	integer <int32>
maxBorrowers required	integer <int32>
defaultOfferValidityDays required	integer <int32>
creditUsageIds required	Array of integers <int32>
creditInstanceTypeIds required	Array of integers <int32>
riskClassTypeId	integer <int32> Nullable
isAutoValidated	boolean
reviewDate	string <date-time> Nullable
collateralTypeIds	Array of integers <int32> Nullable
repaymentIds	Array of integers <int32> Nullable
keyRiskIndicatorDetailIds	Array of integers <int32> Nullable

Responses

200

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Internal Server Error

post/v1.0/creditfacilities

https://example-host/v1.0/creditfacilities

Request samples

Payload

Content type

Copy

Expand all Collapse all


{"name": "string",
"creditFacilityTypeId": 0,
"bookingCenterCountryId": 0,
"jurisdictionCountryId": 0,
"currencyId": 0,
"contactTypeId": 0,
"isAutoApproved": true,
"isCommitted": true,
"minAmount": 0,
"maxAmount": 0,
"isActive": true,
"lenderId": 0,
"maxProducts": 0,
"maxBorrowers": 0,
"defaultOfferValidityDays": 0,
"creditUsageIds": 
[0
],
"creditInstanceTypeIds": 
[0
],
"riskClassTypeId": 0,
"isAutoValidated": true,
"reviewDate": "2025-05-09T12:06:30Z",
"collateralTypeIds": 
[0
],
"repaymentIds": 
[0
],
"keyRiskIndicatorDetailIds": 
[0
]
}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"id": 0
}

Filter credit facilities by certain criteria

Gets a list of all the existing credit facilities. A request body defining the pagination must be set. The page numbering starts from 1. Ordered by default based on the create date ASC. There is also the option of applying filters by name, credit facility type id, jurisdiction id, borrower type id, currency id, status, create date and lender id.

Authorizations:

Bearer

header Parameters

Accept-Language

string

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

Request Body schema:
application/json

Search request

page	integer <int32>
pageSize	integer <int32>
sortBy	string Nullable
sortOrder	string (SortOrder) Enum: "Ascending" "Descending"
name	string Nullable
creditFacilityTypeIds	Array of integers <int32> Nullable
bookingCenterCountryIds	Array of integers <int32> Nullable
jurisdictionCountryIds	Array of integers <int32> Nullable
borrowerTypeIds	Array of integers <int32> Nullable
currencyIds	Array of integers <int32> Nullable
lenderIds	Array of integers <int32> Nullable
createDateFrom	string <date-time> Nullable
createDateTo	string <date-time> Nullable
status	boolean Nullable

Responses

200

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Internal Server Error

post/v1.0/creditfacilities/search

https://example-host/v1.0/creditfacilities/search

Request samples

Payload

Content type

Copy

Expand all Collapse all


{"page": 0,
"pageSize": 0,
"sortBy": "string",
"sortOrder": "Ascending",
"name": "string",
"creditFacilityTypeIds": 
[0
],
"bookingCenterCountryIds": 
[0
],
"jurisdictionCountryIds": 
[0
],
"borrowerTypeIds": 
[0
],
"currencyIds": 
[0
],
"lenderIds": 
[0
],
"createDateFrom": "2025-05-09T12:06:30Z",
"createDateTo": "2025-05-09T12:06:30Z",
"status": true
}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"results": 
[
{"id": 0,
"name": "string",
"creditFacilityTypeId": 0,
"riskClassTypeId": 0,
"bookingCenterCountryId": 0,
"jurisdictionCountryId": 0,
"currencyId": 0,
"contactTypeId": 0,
"isAutoApproved": true,
"isCommitted": true,
"reviewDate": "2025-05-09T12:06:30Z",
"minAmount": 0,
"maxAmount": 0,
"isActive": true,
"createDate": "2025-05-09T12:06:30Z",
"lenderId": 0,
"maxProducts": 0,
"maxBorrowers": 0,
"defaultOfferValidityDays": 0,
"isAutoValidated": true,
"collateralTypeIds": 
[0
],
"creditUsageIds": 
[0
],
"creditInstanceTypeIds": 
[0
],
"keyRiskIndicatorDetailIds": 
[0
],
"feeIds": 
[0
],
"repaymentIds": 
[0
],
"riskModelIds": 
[0
],
"productIds": 
[0
],
"collateralTypeRegionConstraints": 
[
{"collateralTypeId": 0,
"regionIds": 
[0
],
"constraintTypeId": 0
}
],
"creditFacilityType": 
{"id": 0,
"name": "string",
"key": "string",
"externalId": "string",
"parentId": 0,
"parentName": "string"
},
"repayments": 
[
{"id": 0,
"recurringPeriodDays": 0,
"seniorRankPercentage": 0,
"juniorRankPercentage": 0,
"mezzanineRankPercentage": 0,
"maxDurationDays": 0,
"collateralTypeId": 0,
"billingPeriodId": 0,
"repaymentTranchId": 0,
"repaymentTypeIds": 
[0
]
}
]
}
],
"page": 0,
"pageSize": 0,
"pageCount": 0,
"totalCount": 0
}

CreditFacilityTypes

Delete credit facility type

Deletes an existing credit facility type.

Authorizations:

Bearer

path Parameters

required

integer <int32>

CreditFacilityType 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/creditfacilitytypes/{id}

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

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"code": "General",
"subCode": "string",
"message": "string",
"correlationId": "string",
"properties": 
{"property1": null,
"property2": null
}
}

Get credit facility type

Gets a credit facility type.

Authorizations:

Bearer

path Parameters

required

integer <int32>

CreditFacilityType ID

header Parameters

Accept-Language

string

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

Responses

200

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Internal Server Error

get/v1.0/creditfacilitytypes/{id}

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

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"id": 0,
"name": "string",
"key": "string",
"externalId": "string",
"parentId": 0,
"parentName": "string"
}

Modify credit facility type

Modifies an existing credit facility type which can be part of the product offering.

Authorizations:

Bearer

path Parameters

required

integer <int32>

Credit facility type id

header Parameters

Accept-Language

string

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

Request Body schema:
application/json

Update credit facility type request

parentId	object (Api.Common.UpdateableProperty%3CSystem.Nullable%3CInt32%3E%3E) Wrapper around properties used in patch requests
name	object (UpdateableProperty%3C%3E) Wrapper around properties used in patch requests
key	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/creditfacilitytypes/{id}

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

Request samples

Payload

Content type

Copy

Expand all Collapse all


{"parentId": 
{"doUpdate": true,
"value": 0
},
"name": 
{"doUpdate": true,
"value": "string"
},
"key": 
{"doUpdate": true,
"value": "string"
},
"externalId": 
{"doUpdate": true,
"value": "string"
}
}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"code": "General",
"subCode": "string",
"message": "string",
"correlationId": "string",
"properties": 
{"property1": null,
"property2": null
}
}

Get credit facility types

Gets a list containing all the credit facility types.

Authorizations:

Bearer

header Parameters

Accept-Language

string

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

Responses

200

400

Bad Request

401

Unauthorized

403

Forbidden

500

Internal Server Error

get/v1.0/creditfacilitytypes

https://example-host/v1.0/creditfacilitytypes

Response samples

Content type

application/json

Copy

Expand all Collapse all


[
{"id": 0,
"name": "string",
"key": "string",
"externalId": "string",
"parentId": 0,
"parentName": "string"
}
]

Create credit facility type

Creates a new credit facility type which can be part of the product offering.

Authorizations:

Bearer

header Parameters

Accept-Language

string

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

Request Body schema:
application/json

Create credit facility type request

parentId required	integer <int32>
name required	string non-empty
key required	string non-empty
externalId	string Nullable

Responses

200

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Internal Server Error

post/v1.0/creditfacilitytypes

https://example-host/v1.0/creditfacilitytypes

Request samples

Payload

Content type

Copy

Expand all Collapse all


{"parentId": 0,
"name": "string",
"key": "string",
"externalId": "string"
}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"id": 0
}

DFS Credit Facilities Services API (latest)

CreditFacilities

Delete credit facility

Authorizations:

path Parameters

header Parameters

Responses

Response samples

Get credit facility details

Authorizations:

path Parameters

header Parameters

Responses

Response samples

Modify credit facility details

Authorizations:

path Parameters

header Parameters

Request Body schema: application/json

Responses

Request samples

Response samples

Create a new credit facility

Authorizations:

header Parameters

Request Body schema: application/json

Responses

Request samples

Response samples

Filter credit facilities by certain criteria

Authorizations:

header Parameters

Request Body schema: application/json

Responses

Request samples

Response samples

CreditFacilityTypes

Delete credit facility type

Authorizations:

path Parameters

header Parameters

Responses

Response samples

Get credit facility type

Authorizations:

path Parameters

header Parameters

Responses

Response samples

Modify credit facility type

Authorizations:

path Parameters

header Parameters

Request Body schema: application/json

Responses

Request samples

Response samples

Get credit facility types

Authorizations:

header Parameters

Responses

Response samples

Create credit facility type

Authorizations:

header Parameters

Request Body schema: application/json

Responses

Request samples

Response samples

Request Body schema:
application/json

Request Body schema:
application/json

Request Body schema:
application/json

Request Body schema:
application/json

Request Body schema:
application/json