DFS v26.1
Loading
API docs by Redocly

DFS Repayment Services API (latest)

Download OpenAPI specification:

Contains functionality around repayments.

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.

Repayment

Delete a repayment

Deletes an existing repayment.

Authorizations:
Bearer
path Parameters
id
required
integer <int32>

Repayment 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 repayment

Gets the details of an existing repayment.

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,
  • "recurringPeriodDays": 0,
  • "seniorRankPercentage": 0.1,
  • "juniorRankPercentage": 0.1,
  • "mezzanineRankPercentage": 0.1,
  • "maxDurationDays": 0,
  • "collateralTypeId": 0,
  • "billingPeriod": {
    },
  • "repaymentTypes": [
    ],
  • "repaymentTranch": {
    },
  • "constraints": [
    ]
}

Modify a repayment

Modifies an existing repayment.

Authorizations:
Bearer
path Parameters
id
required
integer <int32>

Id of the repayment that will be modified

header Parameters
Accept-Language
string

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

Request Body schema:

Patch repayment request

object (UpdateableProperty<>)

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

Wrapper around properties used in patch requests

object (Api.Common.UpdateableProperty<Constraints>)

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.Collections.Generic.List<Int32>>)

Wrapper around properties used in patch requests

object (UpdateableProperty<>)

Wrapper around properties used in patch requests

Responses

Request samples

Content type
{
  • "recurringPeriodDays": {
    },
  • "seniorRankPercentage": {
    },
  • "juniorRankPercentage": {
    },
  • "mezzanineRankPercentage": {
    },
  • "maxDurationDays": {
    },
  • "constraints": {
    },
  • "collateralTypeId": {
    },
  • "billingPeriodId": {
    },
  • "repaymentTypeIds": {
    },
  • "repaymentTranchId": {
    }
}

Response samples

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

Get all the repayments

Gets the details of all repayments.

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 repayment

Creates a new repayment 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 repayment request

recurringPeriodDays
integer or null <int32>
seniorRankPercentage
required
number <double>
juniorRankPercentage
number or null <double>
mezzanineRankPercentage
number or null <double>
maxDurationDays
required
integer <int32>
collateralTypeId
required
integer <int32>
billingPeriodId
required
integer <int32>
repaymentTypeIds
Array of integers or null <int32> [ items <int32 > ]
repaymentTranchId
integer or null <int32>

Responses

Request samples

Content type
{
  • "recurringPeriodDays": 0,
  • "seniorRankPercentage": 0.1,
  • "juniorRankPercentage": 0.1,
  • "mezzanineRankPercentage": 0.1,
  • "maxDurationDays": 0,
  • "collateralTypeId": 0,
  • "billingPeriodId": 0,
  • "repaymentTypeIds": [
    ],
  • "repaymentTranchId": 0
}

Response samples

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

Filter existing repayments

Gets the details of all the existing repayments. The results can be filtered by passing in request body a list of repayment ids or a credit facility id.

Authorizations:
Bearer
header Parameters
Accept-Language
string

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

Request Body schema:

SearchRepayment Request

repaymentIds
Array of integers or null <int32> [ items <int32 > ]
creditFacilityId
integer or null <int32>

Responses

Request samples

Content type
{
  • "repaymentIds": [
    ],
  • "creditFacilityId": 0
}

Response samples

Content type
application/json
[
  • {
    }
]

Add repayment constraints

Adds to an existing repayment an existing constraint which is a key risk indicator.

Authorizations:
Bearer
path Parameters
id
required
integer <int32>

Repayment id

header Parameters
Accept-Language
string

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

Request Body schema:

Add repayment constraints request

keyRiskIndicatorDetailIds
required
Array of integers <int32> [ items <int32 > ]

Responses

Request samples

Content type
{
  • "keyRiskIndicatorDetailIds": [
    ]
}

Response samples

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

RepaymentTranch

Delete a repayment tranch

Deletes an existing repayment tranch.

Authorizations:
Bearer
path Parameters
id
required
integer <int32>

RepaymentTranch 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 all the repayment tranches

Gets all the existing repayment tranches.

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 repayment tranch

Creates a new repayment tranch which can be used to define a repayment.

Authorizations:
Bearer
header Parameters
Accept-Language
string

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

Request Body schema:

Create repaymentTranch request

name
required
string non-empty

Responses

Request samples

Content type
{
  • "name": "string"
}

Response samples

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

RepaymentType

Delete a repayment type

Deletes an existing repayment type.

Authorizations:
Bearer
path Parameters
id
required
integer <int32>

RepaymentType 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 repayment type

Modifies an existing repayment type which can be used to define a repayment.

Authorizations:
Bearer
path Parameters
id
required
integer <int32>

Id of the repayment type that will be modified

header Parameters
Accept-Language
string

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

Request Body schema:

Patch repayment type request

object (Api.Common.UpdateableProperty<String>)

Wrapper around properties used in patch requests

object (UpdateableProperty<>)

Wrapper around properties used in patch requests

Responses

Request samples

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

Response samples

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

Get all the repayment types

Gets all the existing repayment 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 a new repayment type

Creates a new repayment type which can be used to define a repayment.

Authorizations:
Bearer
header Parameters
Accept-Language
string

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

Request Body schema:

Create repaymentType request

name
required
string non-empty
parentId
required
integer <int32>

Responses

Request samples

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

Response samples

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