DFS Repayment Services API (latest)

Download OpenAPI specification:Download

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

required

integer <int32>

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

https://example-host/v1.0/repayments/{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 repayment

Gets the details of an existing repayment.

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

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

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"id": 0,
"recurringPeriodDays": 0,
"seniorRankPercentage": 0,
"juniorRankPercentage": 0,
"mezzanineRankPercentage": 0,
"maxDurationDays": 0,
"collateralTypeId": 0,
"billingPeriod": 
{"id": 0,
"name": "string",
"key": "string"
},
"repaymentTypes": 
[
{"id": 0,
"name": "string",
"parentId": 0,
"parentName": "string"
}
],
"repaymentTranch": 
{"id": 0,
"name": "string"
},
"constraints": 
[
{"keyRiskIndicatorId": 0,
"name": "string",
"isBoolean": true,
"isPercentage": true,
"details": 
[
{"keyRiskIndicatorDetailId": 0,
"value": 0,
"minValue": 0,
"maxValue": 0,
"isSoftKnockout": true,
"isHardKnockout": true
}
]
}
]
}

Modify a repayment

Modifies an existing repayment.

Authorizations:

Bearer

path Parameters

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

Patch repayment request

recurringPeriodDays	object (UpdateableProperty%3C%3E) Wrapper around properties used in patch requests
seniorRankPercentage	object (Api.Common.UpdateableProperty%3CDecimal%3E) Wrapper around properties used in patch requests
juniorRankPercentage	object (Api.Common.UpdateableProperty%3CSystem.Nullable%3CDecimal%3E%3E) Wrapper around properties used in patch requests
mezzanineRankPercentage	object (Api.Common.UpdateableProperty%3CSystem.Nullable%3CDecimal%3E%3E) Wrapper around properties used in patch requests
maxDurationDays	object (Api.Common.UpdateableProperty%3CInt32%3E) Wrapper around properties used in patch requests
constraints	object (Api.Common.UpdateableProperty%3CConstraints%3E) Wrapper around properties used in patch requests
collateralTypeId	object (Api.Common.UpdateableProperty%3CInt32%3E) Wrapper around properties used in patch requests
billingPeriodId	object (Api.Common.UpdateableProperty%3CInt32%3E) Wrapper around properties used in patch requests
repaymentTypeIds	object (Api.Common.UpdateableProperty%3CSystem.Collections.Generic.List%3CInt32%3E%3E) Wrapper around properties used in patch requests
repaymentTranchId	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/repayments/{id}

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

Request samples

Payload

Content type

Copy

Expand all Collapse all


{"recurringPeriodDays": 
{"doUpdate": true,
"value": 0
},
"seniorRankPercentage": 
{"doUpdate": true,
"value": 0
},
"juniorRankPercentage": 
{"doUpdate": true,
"value": 0
},
"mezzanineRankPercentage": 
{"doUpdate": true,
"value": 0
},
"maxDurationDays": 
{"doUpdate": true,
"value": 0
},
"constraints": 
{"doUpdate": true,
"value": 
{"keyRiskIndicatorDetailIds": 
[0
]
}
},
"collateralTypeId": 
{"doUpdate": true,
"value": 0
},
"billingPeriodId": 
{"doUpdate": true,
"value": 0
},
"repaymentTypeIds": 
{"doUpdate": true,
"value": 
[0
]
},
"repaymentTranchId": 
{"doUpdate": true,
"value": 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
}
}

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

200

400

Bad Request

401

Unauthorized

403

Forbidden

500

Internal Server Error

get/v1.0/repayments

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

Response samples

Content type

application/json

Copy

Expand all Collapse all


[
{"id": 0,
"recurringPeriodDays": 0,
"seniorRankPercentage": 0,
"juniorRankPercentage": 0,
"mezzanineRankPercentage": 0,
"maxDurationDays": 0,
"collateralTypeId": 0,
"billingPeriod": 
{"id": 0,
"name": "string",
"key": "string"
},
"repaymentTypes": 
[
{"id": 0,
"name": "string",
"parentId": 0,
"parentName": "string"
}
],
"repaymentTranch": 
{"id": 0,
"name": "string"
},
"constraints": 
[
{"keyRiskIndicatorId": 0,
"name": "string",
"isBoolean": true,
"isPercentage": true,
"details": 
[
{"keyRiskIndicatorDetailId": 0,
"value": 0,
"minValue": 0,
"maxValue": 0,
"isSoftKnockout": true,
"isHardKnockout": true
}
]
}
]
}
]

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

Create repayment request

recurringPeriodDays	integer <int32> Nullable
seniorRankPercentage required	number <double>
juniorRankPercentage	number <double> Nullable
mezzanineRankPercentage	number <double> Nullable
maxDurationDays required	integer <int32>
collateralTypeId required	integer <int32>
billingPeriodId required	integer <int32>
repaymentTypeIds	Array of integers <int32> Nullable
repaymentTranchId	integer <int32> Nullable

Responses

204

No Content

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Internal Server Error

post/v1.0/repayments

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

Request samples

Payload

Content type

Copy

Expand all Collapse all


{"recurringPeriodDays": 0,
"seniorRankPercentage": 0,
"juniorRankPercentage": 0,
"mezzanineRankPercentage": 0,
"maxDurationDays": 0,
"collateralTypeId": 0,
"billingPeriodId": 0,
"repaymentTypeIds": 
[0
],
"repaymentTranchId": 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
}
}

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

SearchRepayment Request

repaymentIds	Array of integers <int32> Nullable
creditFacilityId	integer <int32> Nullable

Responses

200

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Internal Server Error

post/v1.0/repayments/search

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

Request samples

Payload

Content type

Copy

Expand all Collapse all


{"repaymentIds": 
[0
],
"creditFacilityId": 0
}

Response samples

Content type

application/json

Copy

Expand all Collapse all


[
{"id": 0,
"recurringPeriodDays": 0,
"seniorRankPercentage": 0,
"juniorRankPercentage": 0,
"mezzanineRankPercentage": 0,
"maxDurationDays": 0,
"collateralTypeId": 0,
"billingPeriod": 
{"id": 0,
"name": "string",
"key": "string"
},
"repaymentTypes": 
[
{"id": 0,
"name": "string",
"parentId": 0,
"parentName": "string"
}
],
"repaymentTranch": 
{"id": 0,
"name": "string"
},
"constraints": 
[
{"keyRiskIndicatorId": 0,
"name": "string",
"isBoolean": true,
"isPercentage": true,
"details": 
[
{"keyRiskIndicatorDetailId": 0,
"value": 0,
"minValue": 0,
"maxValue": 0,
"isSoftKnockout": true,
"isHardKnockout": true
}
]
}
]
}
]

Add repayment constraints

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

Authorizations:

Bearer

path Parameters

required

integer <int32>

Repayment id

header Parameters

Accept-Language

string

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

Request Body schema:
application/json

Add repayment constraints request

keyRiskIndicatorDetailIds

required

Array of integers <int32>

Responses

200

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Internal Server Error

post/v1.0/repayments/{id}/constraints

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

Request samples

Payload

Content type

Copy

Expand all Collapse all


{"keyRiskIndicatorDetailIds": 
[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
}
}

RepaymentTranch

Delete a repayment tranch

Deletes an existing repayment tranch.

Authorizations:

Bearer

path Parameters

required

integer <int32>

RepaymentTranch 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/repayment/tranches/{id}

https://example-host/v1.0/repayment/tranches/{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 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

200

400

Bad Request

401

Unauthorized

403

Forbidden

500

Internal Server Error

get/v1.0/repayment/tranches

https://example-host/v1.0/repayment/tranches

Response samples

Content type

application/json

Copy

Expand all Collapse all


[
{"id": 0,
"name": "string"
}
]

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

Create repaymentTranch request

name

required

string non-empty

Responses

200

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Internal Server Error

post/v1.0/repayment/tranches

https://example-host/v1.0/repayment/tranches

Request samples

Payload

Content type

Copy

Expand all Collapse all


{"name": "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
}
}

RepaymentType

Delete a repayment type

Deletes an existing repayment type.

Authorizations:

Bearer

path Parameters

required

integer <int32>

RepaymentType 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/repayment/types/{id}

https://example-host/v1.0/repayment/types/{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
}
}

Modify a repayment type

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

Authorizations:

Bearer

path Parameters

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

Patch repayment type request

name	object (Api.Common.UpdateableProperty%3CString%3E) Wrapper around properties used in patch requests
parentId	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/repayment/types/{id}

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

Request samples

Payload

Content type

Copy

Expand all Collapse all


{"name": 
{"doUpdate": true,
"value": "string"
},
"parentId": 
{"doUpdate": true,
"value": 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
}
}

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

200

400

Bad Request

401

Unauthorized

403

Forbidden

500

Internal Server Error

get/v1.0/repayment/types

https://example-host/v1.0/repayment/types

Response samples

Content type

application/json

Copy

Expand all Collapse all


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

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

Create repaymentType request

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

Responses

200

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Internal Server Error

post/v1.0/repayment/types

https://example-host/v1.0/repayment/types

Request samples

Payload

Content type

Copy

Expand all Collapse all


{"name": "string",
"parentId": 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
}
}

DFS Repayment Services API (latest)

Repayment

Delete a repayment

Authorizations:

path Parameters

header Parameters

Responses

Response samples

Get repayment

Authorizations:

path Parameters

header Parameters

Responses

Response samples

Modify a repayment

Authorizations:

path Parameters

header Parameters

Request Body schema: application/json

Responses

Request samples

Response samples

Get all the repayments

Authorizations:

header Parameters

Responses

Response samples

Create a new repayment

Authorizations:

header Parameters

Request Body schema: application/json

Responses

Request samples

Response samples

Filter existing repayments

Authorizations:

header Parameters

Request Body schema: application/json

Responses

Request samples

Response samples

Add repayment constraints

Authorizations:

path Parameters

header Parameters

Request Body schema: application/json

Responses

Request samples

Response samples

RepaymentTranch

Delete a repayment tranch

Authorizations:

path Parameters

header Parameters

Responses

Response samples

Get all the repayment tranches

Authorizations:

header Parameters

Responses

Response samples

Create a new repayment tranch

Authorizations:

header Parameters

Request Body schema: application/json

Responses

Request samples

Response samples

RepaymentType

Delete a repayment type

Authorizations:

path Parameters

header Parameters

Responses

Response samples

Modify a repayment type

Authorizations:

path Parameters

header Parameters

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

Request Body schema:
application/json

Request Body schema:
application/json

Request Body schema:
application/json