Loading
Documentation Powered by ReDoc

DFS Lender Services API (latest)

Download OpenAPI specification:Download

Contains functionality around lenders.

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.

Lender

Delete lender

Deletes an existing lender.

Authorizations:
Bearer
path Parameters
id
required
integer <int32>

Lender 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/lenders/{id}
https://example-host/v1.0/lenders/{id}

Response samples

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

Get lender by id

Gets lender with provided id.

Authorizations:
Bearer
path Parameters
id
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/lenders/{id}
https://example-host/v1.0/lenders/{id}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": 0,
  • "name": "string",
  • "participantUid": "string",
  • "isActive": true,
  • "externalId": "string",
  • "data": "string",
  • "dynamicSchemaId": 0,
  • "creditFacilityIds":
    [
    ]
}

Modify a lender

Modifies an existing lender.

Authorizations:
Bearer
path Parameters
id
required
integer <int32>

LenderId of the lender 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 lender request

name
object (UpdateableProperty%3C%3E)

Wrapper around properties used in patch requests

participantUid
object (UpdateableProperty%3C%3E)

Wrapper around properties used in patch requests

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

Wrapper around properties used in patch requests

externalId
object (UpdateableProperty%3C%3E)

Wrapper around properties used in patch requests

data
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

Responses

204

No Content

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Internal Server Error

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

Request samples

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

Response samples

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

Get lenders

Gets lenders.

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

Response samples

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

Create a new lender

Creates a new lender.

Authorizations:
Bearer
header Parameters
Accept-Language
string

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

Request Body schema:
application/json

Create lender request

name
required
string non-empty
participantUid
required
string non-empty
isActive
required
boolean
externalId
string Nullable
data
string Nullable
dynamicSchemaId
integer <int32> Nullable

Responses

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Internal Server Error

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

Request samples

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

Response samples

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