DFS v26.1
Loading
API docs by Redocly

DFS Credit Common Services API (latest)

Download OpenAPI specification:

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

Response samples

Content type
application/json
[
  • {
    }
]

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

Response samples

Content type
application/json
[
  • {
    }
]

ConstraintTypes

Delete a constraint type

Deletes an existing constraint type

Authorizations:
Bearer
path Parameters
id
required
integer <int32>

ConstraintType 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 constraint type

Modifies an existing constraint type.

Authorizations:
Bearer
path Parameters
id
required
integer <int32>

ConstraintType ID

header Parameters
Accept-Language
string

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

Request Body schema:

Modify Request

object (UpdateableProperty<>)

Wrapper around properties used in patch requests

object (UpdateableProperty<>)

Wrapper around properties used in patch requests

Responses

Request samples

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

Response samples

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

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

Response samples

Content type
application/json
[
  • {
    }
]

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:

Create Request

name
required
string non-empty
key
required
string non-empty

Responses

Request samples

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

Response samples

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

CreditUsage

Delete a credit usage

Deletes an existing credit usage.

Authorizations:
Bearer
path Parameters
id
required
integer <int32>

CreditUsage 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 credit usage

Modifies an existing credit usage.

Authorizations:
Bearer
path Parameters
id
required
integer <int32>

CreditUsage ID

header Parameters
Accept-Language
string

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

Request Body schema:

Modify Request

object (UpdateableProperty<>)

Wrapper around properties used in patch requests

object (UpdateableProperty<>)

Wrapper around properties used in patch requests

Responses

Request samples

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

Response samples

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

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

Response samples

Content type
application/json
[
  • {
    }
]

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

Responses

Request samples

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

Response samples

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

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

Response samples

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

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

Response samples

Content type
application/json
[
  • {
    }
]

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:

CreateMemberExternalSystemRequest

externalId
required
string non-empty
system
required
string non-empty
customAttributes
string or null

Responses

Request samples

Content type
{
  • "externalId": "string",
  • "system": "string",
  • "customAttributes": "string"
}

Response samples

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

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:
page
integer <int32>
pageSize
integer <int32>

Responses

Request samples

Content type
{
  • "page": 0,
  • "pageSize": 0
}

Response samples

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

Response samples

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

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
id
required
integer <int32>

Own equity type 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 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
id
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:

Patch OwnEquityType request

object (UpdateableProperty<>)

Wrapper around properties used in patch requests

object (UpdateableProperty<>)

Wrapper around properties used in patch requests

object (Api.Common.UpdateableProperty<Boolean>)

Wrapper around properties used in patch requests

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

Wrapper around properties used in patch requests

Responses

Request samples

Content type
{
  • "name": {
    },
  • "key": {
    },
  • "isCash": {
    },
  • "collateralTypeId": {
    }
}

Response samples

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

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

Response samples

Content type
application/json
[
  • {
    }
]

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:
name
required
string non-empty
key
required
string non-empty
isCash
boolean
collateralTypeId
integer or null <int32>

Responses

Request samples

Content type
{
  • "name": "string",
  • "key": "string",
  • "isCash": true,
  • "collateralTypeId": 0
}

Response samples

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

Regions

Delete an existing region

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

Authorizations:
Bearer
path Parameters
id
required
integer <int32>

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

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

Authorizations:
Bearer
path Parameters
id
required
integer <int32>

Region ID

header Parameters
Accept-Language
string

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

Request Body schema:

Modify Region Request

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

object (Api.Common.UpdateableProperty<Int32>)

Wrapper around properties used in patch requests

Responses

Request samples

Content type
{
  • "name": {
    },
  • "key": {
    },
  • "parentZipCode": {
    },
  • "countryId": {
    }
}

Response samples

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

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

Response samples

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

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:

Modify Region Code Request

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

Response samples

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

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:
page
integer <int32>
pageSize
integer <int32>
sortBy
string or null
sortOrder
string (SortOrder)
Enum: "Ascending" "Descending"
regionIds
Array of integers or null <int32> [ items <int32 > ]
countryIds
Array of integers or null <int32> [ items <int32 > ]
keys
Array of strings or null
name
string or null

Responses

Request samples

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

Response samples

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

Create Region Request

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

Responses

Request samples

Content type
{
  • "name": "string",
  • "countryId": 0,
  • "key": "string",
  • "parentZipCode": "string"
}

Response samples

Content type
application/json
{
  • "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
id
required
integer <int32>
header Parameters
Accept-Language
string

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

Request Body schema:
name
required
string non-empty
code
required
string non-empty
key
required
string non-empty

Responses

Request samples

Content type
{
  • "name": "string",
  • "code": "string",
  • "key": "string"
}

Response samples

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