Loading
API docs by Redocly

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

Delete credit facility

Deletes an existing credit facility.

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
{
  • "code": "BadRequest",
  • "subCode": "NA",
  • "message": "The request was not in the required format",
  • "correlationId": "30d3ebc0b5cb47b0889850bbdfe4aec6"
}

Get credit facility details

Gets all the details of the requested credit facility.

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
{
  • "id": 0,
  • "name": "string",
  • "creditFacilityTypeId": 0,
  • "riskClassTypeId": 0,
  • "bookingCenterCountryId": 0,
  • "jurisdictionCountryId": 0,
  • "currencyId": 0,
  • "contactTypeId": 0,
  • "isAutoApproved": true,
  • "isCommitted": true,
  • "reviewDate": "2019-08-24T14:15:22Z",
  • "minAmount": 0.1,
  • "maxAmount": 0.1,
  • "isActive": true,
  • "createDate": "2019-08-24T14:15:22Z",
  • "lenderId": 0,
  • "maxProducts": 0,
  • "maxBorrowers": 0,
  • "defaultOfferValidityDays": 0,
  • "isAutoValidated": true,
  • "selfApproveAllowedRoleKeys": [
    ],
  • "collateralTypeIds": [
    ],
  • "creditUsageIds": [
    ],
  • "creditInstanceTypeIds": [
    ],
  • "keyRiskIndicatorDetailIds": [
    ],
  • "feeIds": [
    ],
  • "repaymentIds": [
    ],
  • "riskModelIds": [
    ],
  • "productIds": [
    ],
  • "collateralTypeRegionConstraints": [
    ],
  • "creditFacilityType": {
    },
  • "repayments": [
    ]
}

Modify credit facility details

Modifies an existing credit facility.

Authorizations:
Bearer
path Parameters
id
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:

Patch credit facility 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<System.Nullable<Int32>>)

Wrapper around properties used in patch requests

object (Api.Common.UpdateableProperty<Int32>)

Wrapper around properties used in patch requests

object (Api.Common.UpdateableProperty<Int32>)

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

Wrapper around properties used in patch requests

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

Wrapper around properties used in patch requests

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

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

Wrapper around properties used in patch requests

object (Api.Common.UpdateableProperty<Int32>)

Wrapper around properties used in patch requests

object (Api.Common.UpdateableProperty<Int32>)

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

Wrapper around properties used in patch requests

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

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<System.Collections.Generic.ICollection<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<System.Collections.Generic.ICollection<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<System.Collections.Generic.ICollection<CollateralTypeRegionConstraint>>)

Wrapper around properties used in patch requests

Responses

Request samples

Content type
{
  • "name": {
    },
  • "creditFacilityTypeId": {
    },
  • "riskClassTypeId": {
    },
  • "bookingCenterCountryId": {
    },
  • "jurisdictionCountryId": {
    },
  • "currencyId": {
    },
  • "contactTypeId": {
    },
  • "isCommitted": {
    },
  • "isAutoApproved": {
    },
  • "reviewDate": {
    },
  • "minAmount": {
    },
  • "maxAmount": {
    },
  • "isActive": {
    },
  • "lenderId": {
    },
  • "maxProducts": {
    },
  • "maxBorrowers": {
    },
  • "defaultOfferValidityDays": {
    },
  • "isAutoValidated": {
    },
  • "selfApproveAllowedRoleKeys": {
    },
  • "collateralTypeIds": {
    },
  • "creditInstanceTypeIds": {
    },
  • "creditUsageIds": {
    },
  • "keyRiskIndicatorDetailIds": {
    },
  • "repaymentIds": {
    },
  • "collateralTypeRegionConstraints": {
    }
}

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 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:

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> [ items <int32 > ]
creditInstanceTypeIds
required
Array of integers <int32> [ items <int32 > ]
riskClassTypeId
integer or null <int32>
isAutoValidated
boolean
reviewDate
string or null <date-time>
collateralTypeIds
Array of integers or null <int32> [ items <int32 > ]
repaymentIds
Array of integers or null <int32> [ items <int32 > ]
keyRiskIndicatorDetailIds
Array of integers or null <int32> [ items <int32 > ]
selfApproveAllowedRoleKeys
Array of strings or null

Responses

Request samples

Content type
{
  • "name": "string",
  • "creditFacilityTypeId": 0,
  • "bookingCenterCountryId": 0,
  • "jurisdictionCountryId": 0,
  • "currencyId": 0,
  • "contactTypeId": 0,
  • "isAutoApproved": true,
  • "isCommitted": true,
  • "minAmount": 0.1,
  • "maxAmount": 0.1,
  • "isActive": true,
  • "lenderId": 0,
  • "maxProducts": 0,
  • "maxBorrowers": 0,
  • "defaultOfferValidityDays": 0,
  • "creditUsageIds": [
    ],
  • "creditInstanceTypeIds": [
    ],
  • "riskClassTypeId": 0,
  • "isAutoValidated": true,
  • "reviewDate": "2019-08-24T14:15:22Z",
  • "collateralTypeIds": [
    ],
  • "repaymentIds": [
    ],
  • "keyRiskIndicatorDetailIds": [
    ],
  • "selfApproveAllowedRoleKeys": [
    ]
}

Response samples

Content type
application/json
{
  • "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:

Search request

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

Responses

Request samples

Content type
{
  • "page": 0,
  • "pageSize": 0,
  • "sortBy": "string",
  • "sortOrder": "Ascending",
  • "name": "string",
  • "creditFacilityTypeIds": [
    ],
  • "bookingCenterCountryIds": [
    ],
  • "jurisdictionCountryIds": [
    ],
  • "borrowerTypeIds": [
    ],
  • "currencyIds": [
    ],
  • "lenderIds": [
    ],
  • "createDateFrom": "2019-08-24T14:15:22Z",
  • "createDateTo": "2019-08-24T14:15:22Z",
  • "status": true
}

Response samples

Content type
application/json
{
  • "results": [
    ],
  • "page": 0,
  • "pageSize": 0,
  • "pageCount": 0,
  • "totalCount": 0
}

CreditFacilityTypes

Delete credit facility type

Deletes an existing credit facility type.

Authorizations:
Bearer
path Parameters
id
required
integer <int32>

CreditFacilityType 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 facility type

Gets a credit facility type.

Authorizations:
Bearer
path Parameters
id
required
integer <int32>

CreditFacilityType 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",
  • "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
id
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:

Update credit facility type request

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

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

object (UpdateableProperty<>)

Wrapper around properties used in patch requests

Responses

Request samples

Content type
{
  • "parentId": {
    },
  • "name": {
    },
  • "key": {
    },
  • "externalId": {
    }
}

Response samples

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

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

Response samples

Content type
application/json
[
  • {
    }
]

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:

Create credit facility type request

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

Responses

Request samples

Content type
{
  • "parentId": 0,
  • "name": "string",
  • "key": "string",
  • "externalId": "string"
}

Response samples

Content type
application/json
{
  • "id": 0
}