DFS Credit Common Services API (latest)

Download OpenAPI specification:Download

Contains functionality around credit common.

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.

BillingPeriod

Get a list of billing periods

Gets a list of billing periods.

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/billingperiods

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

Response samples

Content type

application/json

Copy

Expand all Collapse all


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

BillingTypes

Get a list of billing type

Gets a list of billing 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/billingtypes

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

Response samples

Content type

application/json

Copy

Expand all Collapse all


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

ConstraintTypes

Delete a constraint type

Deletes an existing constraint type

Authorizations:

Bearer

path Parameters

required

integer <int32>

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

https://example-host/v1.0/constrainttypes/{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 constraint type

Modifies an existing constraint type.

Authorizations:

Bearer

path Parameters

required

integer <int32>

ConstraintType ID

header Parameters

Accept-Language

string

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

Request Body schema:
application/json

Modify Request

name	object (UpdateableProperty%3C%3E) Wrapper around properties used in patch requests
key	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/constrainttypes/{id}

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

Request samples

Payload

Content type

Copy

Expand all Collapse all


{"name": 
{"doUpdate": true,
"value": "string"
},
"key": 
{"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 a list of constraint types

Gets a list of all the existing constraint 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/constrainttypes

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

Response samples

Content type

application/json

Copy

Expand all Collapse all


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

Create a new constraint type

Creates a new constraint type.

Authorizations:

Bearer

header Parameters

Accept-Language

string

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

Request Body schema:
application/json

Create Request

name required	string non-empty
key 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/constrainttypes

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

Request samples

Payload

Content type

Copy

Expand all Collapse all


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

CreditUsage

Delete a credit usage

Deletes an existing credit usage.

Authorizations:

Bearer

path Parameters

required

integer <int32>

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

https://example-host/v1.0/creditusages/{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 credit usage

Modifies an existing credit usage.

Authorizations:

Bearer

path Parameters

required

integer <int32>

CreditUsage ID

header Parameters

Accept-Language

string

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

Request Body schema:
application/json

Modify Request

name	object (UpdateableProperty%3C%3E) Wrapper around properties used in patch requests
key	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/creditusages/{id}

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

Request samples

Payload

Content type

Copy

Expand all Collapse all


{"name": 
{"doUpdate": true,
"value": "string"
},
"key": 
{"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 a list of credit usages

Gets a list of all the existing credit usages.

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/creditusages

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

Response samples

Content type

application/json

Copy

Expand all Collapse all


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

Create a new credit usage

Creates a new credit usage which can be used to configure the credit facility or allow the customer to specify its credit instance.

Authorizations:

Bearer

header Parameters

Accept-Language

string

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

Request Body schema:
application/json

name required	string non-empty
key 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/creditusages

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

Request samples

Payload

Content type

Copy

Expand all Collapse all


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

MemberExternalSystem

Delete information regarding an external system for a member

Delete information regarding an external system for a member.

Authorizations:

Bearer

path Parameters

memberId required	integer <int32> Member Id
system required	string System
externalId required	string External 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/members/{memberId}/external-systems/{system}/external-ids/{externalId}

https://example-host/v1.0/members/{memberId}/external-systems/{system}/external-ids/{externalId}

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 information regarding all external systems for a member

Get information regarding all external systems for a member.

Authorizations:

Bearer

path Parameters

memberId

required

integer <int32>

Member Identifier

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/members/{memberId}/external-systems

https://example-host/v1.0/members/{memberId}/external-systems

Response samples

Content type

application/json

Copy

Expand all Collapse all


[
{"memberId": 0,
"externalId": "string",
"system": "string",
"customAttributes": "string"
}
]

Add information regarding an external system for a member

Add information regarding an external system for a member.

Authorizations:

Bearer

path Parameters

memberId

required

integer <int32>

Member Identifier

header Parameters

Accept-Language

string

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

Request Body schema:
application/json

CreateMemberExternalSystemRequest

externalId required	string non-empty
system required	string non-empty
customAttributes	string Nullable

Responses

200

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Internal Server Error

post/v1.0/members/{memberId}/external-systems

https://example-host/v1.0/members/{memberId}/external-systems

Request samples

Payload

Content type

Copy

Expand all Collapse all


{"externalId": "string",
"system": "string",
"customAttributes": "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 information regarding all the external systems and members

Get information regarding all the external systems and members.

Authorizations:

Bearer

header Parameters

Accept-Language

string

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

Request Body schema:
application/json

results	Array of objects (GetMemberExternalSystemResult) Nullable
page	integer <int32>
pageSize	integer <int32>
pageCount	integer <int32>
totalCount	integer <int32>

Responses

200

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Internal Server Error

post/v1.0/members/external-systems/search

https://example-host/v1.0/members/external-systems/search

Request samples

Payload

Content type

Copy

Expand all Collapse all


{"results": 
[
{"memberId": 0,
"externalId": "string",
"system": "string",
"customAttributes": "string"
}
],
"page": 0,
"pageSize": 0,
"pageCount": 0,
"totalCount": 0
}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"results": 
[
{"memberId": 0,
"externalId": "string",
"system": "string",
"customAttributes": "string"
}
],
"page": 0,
"pageSize": 0,
"pageCount": 0,
"totalCount": 0
}

Import member external systems from CSV

Deletes all existing member external systems and imports ones provided in a CSV file

Authorizations:

Bearer

header Parameters

Accept-Language

string

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

Request Body schema: multipart/form-data

file

required

string <binary>

CSV file

Responses

200

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Internal Server Error

post/v1.0/members/external-systems/import-file

https://example-host/v1.0/members/external-systems/import-file

Response samples

Content type

application/json

Copy

Expand all Collapse all


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

OwnEquityType

Delete an existing own equity type

Deletes an existing own equity type. If the record is currently in use with a credit instance, it will not be allowed to be removed.

Authorizations:

Bearer

path Parameters

required

integer <int32>

Own equity type 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/ownequitytypes/{id}

https://example-host/v1.0/ownequitytypes/{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 an existing own equity type

Modifies an existing own equity type which can be used to configure the credit facility or allow the customer to specify its credit instance.

Authorizations:

Bearer

path Parameters

required

integer <int32>

Own equity type Id

header Parameters

Accept-Language

string

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

Request Body schema:
application/json

Patch OwnEquityType request

name	object (UpdateableProperty%3C%3E) Wrapper around properties used in patch requests
key	object (UpdateableProperty%3C%3E) Wrapper around properties used in patch requests
isCash	object (Api.Common.UpdateableProperty%3CBoolean%3E) Wrapper around properties used in patch requests
collateralTypeId	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/ownequitytypes/{id}

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

Request samples

Payload

Content type

Copy

Expand all Collapse all


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

Retrieve all the own equity types

Retrieves all the own equity types created in the system.

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/ownequitytypes

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

Response samples

Content type

application/json

Copy

Expand all Collapse all


[
{"id": 0,
"name": "string",
"key": "string",
"isCash": true,
"collateralTypeId": 0
}
]

Create a new own equity type

Creates a new own equity type which can be used to configure the credit facility or allow the customer to specify its credit instance.

Authorizations:

Bearer

header Parameters

Accept-Language

string

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

Request Body schema:
application/json

name required	string non-empty
key required	string non-empty
isCash	boolean
collateralTypeId	integer <int32> Nullable

Responses

200

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Internal Server Error

post/v1.0/ownequitytypes

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

Request samples

Payload

Content type

Copy

Expand all Collapse all


{"name": "string",
"key": "string",
"isCash": true,
"collateralTypeId": 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
}
}

Regions

Delete an existing region

Deletes an existing region which is used to configure the credit facility.

Authorizations:

Bearer

path Parameters

required

integer <int32>

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

https://example-host/v1.0/regions/{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 an existing region

Modifies an existing region which can be used to configure the credit facility.

Authorizations:

Bearer

path Parameters

required

integer <int32>

Region ID

header Parameters

Accept-Language

string

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

Request Body schema:
application/json

Modify Region Request

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

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

Request samples

Payload

Content type

Copy

Expand all Collapse all


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

Delete an existing region code

Deletes an existing region code which is used to configure the credit facility.

Authorizations:

Bearer

path Parameters

regionId required	integer <int32> Region Id
regionCodeId required	integer <int32> Region Code 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/regions/{regionId}/codes/{regionCodeId}

https://example-host/v1.0/regions/{regionId}/codes/{regionCodeId}

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 an existing region code

Modifies an existing region code that is part of a dedicated region which will be used to configure the credit facility.

Authorizations:

Bearer

path Parameters

regionId required	integer <int32> Region ID
regionCodeId required	integer <int32> RegionCode ID

header Parameters

Accept-Language

string

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

Request Body schema:
application/json

Modify Region Code Request

name	object (UpdateableProperty%3C%3E) Wrapper around properties used in patch requests
code	object (UpdateableProperty%3C%3E) Wrapper around properties used in patch requests
key	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/regions/{regionId}/codes/{regionCodeId}

https://example-host/v1.0/regions/{regionId}/codes/{regionCodeId}

Request samples

Payload

Content type

Copy

Expand all Collapse all


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

Search all the regions and region codes

Searches all the regions and region codes in the system which can be used to configure the credit facility. A request body defining the pagination must be set. The page numbering starts from 1. There is the option of applying optional filters by region id, country id, key, and name.

Authorizations:

Bearer

header Parameters

Accept-Language

string

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

Request Body schema:
application/json

page	integer <int32>
pageSize	integer <int32>
sortBy	string Nullable
sortOrder	string (SortOrder) Enum: "Ascending" "Descending"
regionIds	Array of integers <int32> Nullable
countryIds	Array of integers <int32> Nullable
keys	Array of strings Nullable
name	string Nullable

Responses

200

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Internal Server Error

post/v1.0/regions/search

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

Request samples

Payload

Content type

Copy

Expand all Collapse all


{"page": 0,
"pageSize": 0,
"sortBy": "string",
"sortOrder": "Ascending",
"regionIds": 
[0
],
"countryIds": 
[0
],
"keys": 
["string"
],
"name": "string"
}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"results": 
[
{"id": 0,
"name": "string",
"key": "string",
"parentZipCode": "string",
"countryId": 0,
"countryName": "string",
"codes": 
[
{"id": 0,
"name": "string",
"code": "string",
"key": "string"
}
]
}
],
"page": 0,
"pageSize": 0,
"pageCount": 0,
"totalCount": 0
}

Create a new region

Creates a new region which can be used to configure the credit facility.

Authorizations:

Bearer

header Parameters

Accept-Language

string

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

Request Body schema:
application/json

Create Region Request

name required	string non-empty
countryId required	integer <int32>
key required	string non-empty
parentZipCode	string Nullable

Responses

200

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Internal Server Error

post/v1.0/regions

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

Request samples

Payload

Content type

Copy

Expand all Collapse all


{"name": "string",
"countryId": 0,
"key": "string",
"parentZipCode": "string"
}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"id": 0
}

Create a new region code

Creates a new region code that is part of a dedicated region which will be used to configure the credit facility.

Authorizations:

Bearer

path Parameters

required

integer <int32>

header Parameters

Accept-Language

string

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

Request Body schema:
application/json

name required	string non-empty
code required	string non-empty
key 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/regions/{id}/codes

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

Request samples

Payload

Content type

Copy

Expand all Collapse all


{"name": "string",
"code": "string",
"key": "string"
}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"id": 0
}

DFS Credit Common Services API (latest)

BillingPeriod

Get a list of billing periods

Authorizations:

header Parameters

Responses

Response samples

BillingTypes

Get a list of billing type

Authorizations:

header Parameters

Responses

Response samples

ConstraintTypes

Delete a constraint type

Authorizations:

path Parameters

header Parameters

Responses

Response samples

Modify a constraint type

Authorizations:

path Parameters

header Parameters

Request Body schema: application/json

Responses

Request samples

Response samples

Get a list of constraint types

Authorizations:

header Parameters

Responses

Response samples

Create a new constraint type

Authorizations:

header Parameters

Request Body schema: application/json

Responses

Request samples

Response samples

CreditUsage

Delete a credit usage

Authorizations:

path Parameters

header Parameters

Responses

Response samples

Modify a credit usage

Authorizations:

path Parameters

header Parameters

Request Body schema: application/json

Responses

Request samples

Response samples

Get a list of credit usages

Authorizations:

header Parameters

Responses

Response samples

Create a new credit usage

Authorizations:

header Parameters

Request Body schema: application/json

Responses

Request samples

Response samples

MemberExternalSystem

Delete information regarding an external system for a member

Authorizations:

path Parameters

header Parameters

Responses

Response samples

Get information regarding all external systems for a member

Authorizations:

path Parameters

header Parameters

Responses

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

Request Body schema:
application/json

Request Body schema:
application/json

Request Body schema:
application/json

Request Body schema:
application/json