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.
Gets a list of billing periods.
| Accept-Language | string The ISO 639-1 language to use for localizable data. |
OK
Bad Request
Unauthorized
Forbidden
Internal Server Error
[- {
- "id": 0,
- "name": "string",
- "key": "string"
}
]Gets a list of billing types.
| Accept-Language | string The ISO 639-1 language to use for localizable data. |
OK
Bad Request
Unauthorized
Forbidden
Internal Server Error
[- {
- "id": 0,
- "name": "string"
}
]Deletes an existing constraint type
| id required | integer <int32> ConstraintType ID |
| Accept-Language | string The ISO 639-1 language to use for localizable data. |
No Content
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "code": "BadRequest",
- "subCode": "NA",
- "message": "The request was not in the required format",
- "correlationId": "30d3ebc0b5cb47b0889850bbdfe4aec6"
}Modifies an existing constraint type.
| id required | integer <int32> ConstraintType ID |
| Accept-Language | string The ISO 639-1 language to use for localizable data. |
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 |
No Content
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "name": {
- "doUpdate": true,
- "value": "string"
}, - "key": {
- "doUpdate": true,
- "value": "string"
}
}{- "code": "BadRequest",
- "subCode": "NA",
- "message": "The request was not in the required format",
- "correlationId": "30d3ebc0b5cb47b0889850bbdfe4aec6"
}Gets a list of all the existing constraint types.
| Accept-Language | string The ISO 639-1 language to use for localizable data. |
OK
Bad Request
Unauthorized
Forbidden
Internal Server Error
[- {
- "id": 0,
- "key": "string",
- "name": "string"
}
]Creates a new constraint type.
| Accept-Language | string The ISO 639-1 language to use for localizable data. |
Create Request
| name required | string non-empty |
| key required | string non-empty |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "name": "string",
- "key": "string"
}{- "code": "BadRequest",
- "subCode": "NA",
- "message": "The request was not in the required format",
- "correlationId": "30d3ebc0b5cb47b0889850bbdfe4aec6"
}Deletes an existing credit usage.
| id required | integer <int32> CreditUsage ID |
| Accept-Language | string The ISO 639-1 language to use for localizable data. |
No Content
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "code": "BadRequest",
- "subCode": "NA",
- "message": "The request was not in the required format",
- "correlationId": "30d3ebc0b5cb47b0889850bbdfe4aec6"
}Modifies an existing credit usage.
| id required | integer <int32> CreditUsage ID |
| Accept-Language | string The ISO 639-1 language to use for localizable data. |
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 |
No Content
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "name": {
- "doUpdate": true,
- "value": "string"
}, - "key": {
- "doUpdate": true,
- "value": "string"
}
}{- "code": "BadRequest",
- "subCode": "NA",
- "message": "The request was not in the required format",
- "correlationId": "30d3ebc0b5cb47b0889850bbdfe4aec6"
}Gets a list of all the existing credit usages.
| Accept-Language | string The ISO 639-1 language to use for localizable data. |
OK
Bad Request
Unauthorized
Forbidden
Internal Server Error
[- {
- "id": 0,
- "key": "string",
- "name": "string"
}
]Creates a new credit usage which can be used to configure the credit facility or allow the customer to specify its credit instance.
| Accept-Language | string The ISO 639-1 language to use for localizable data. |
| name required | string non-empty |
| key required | string non-empty |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "name": "string",
- "key": "string"
}{- "code": "BadRequest",
- "subCode": "NA",
- "message": "The request was not in the required format",
- "correlationId": "30d3ebc0b5cb47b0889850bbdfe4aec6"
}Delete information regarding an external system for a member.
| memberId required | integer <int32> Member Id |
| system required | string System |
| externalId required | string External Id |
| Accept-Language | string The ISO 639-1 language to use for localizable data. |
No Content
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "code": "BadRequest",
- "subCode": "NA",
- "message": "The request was not in the required format",
- "correlationId": "30d3ebc0b5cb47b0889850bbdfe4aec6"
}Get information regarding all external systems for a member.
| memberId required | integer <int32> Member Identifier |
| Accept-Language | string The ISO 639-1 language to use for localizable data. |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
[- {
- "memberId": 0,
- "externalId": "string",
- "system": "string",
- "customAttributes": "string"
}
]Add information regarding an external system for a member.
| memberId required | integer <int32> Member Identifier |
| Accept-Language | string The ISO 639-1 language to use for localizable data. |
CreateMemberExternalSystemRequest
| externalId required | string non-empty |
| system required | string non-empty |
| customAttributes | string Nullable |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "externalId": "string",
- "system": "string",
- "customAttributes": "string"
}{- "code": "BadRequest",
- "subCode": "NA",
- "message": "The request was not in the required format",
- "correlationId": "30d3ebc0b5cb47b0889850bbdfe4aec6"
}Get information regarding all the external systems and members.
| Accept-Language | string The ISO 639-1 language to use for localizable data. |
| results | Array of objects (GetMemberExternalSystemResult) Nullable |
| page | integer <int32> |
| pageSize | integer <int32> |
| pageCount | integer <int32> |
| totalCount | integer <int32> |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "results": [
- {
- "memberId": 0,
- "externalId": "string",
- "system": "string",
- "customAttributes": "string"
}
], - "page": 0,
- "pageSize": 0,
- "pageCount": 0,
- "totalCount": 0
}{- "results": [
- {
- "memberId": 0,
- "externalId": "string",
- "system": "string",
- "customAttributes": "string"
}
], - "page": 0,
- "pageSize": 0,
- "pageCount": 0,
- "totalCount": 0
}Deletes all existing member external systems and imports ones provided in a CSV file
| Accept-Language | string The ISO 639-1 language to use for localizable data. |
| file required | string <binary> CSV file |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "code": "BadRequest",
- "subCode": "NA",
- "message": "The request was not in the required format",
- "correlationId": "30d3ebc0b5cb47b0889850bbdfe4aec6"
}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.
| id required | integer <int32> Own equity type Id |
| Accept-Language | string The ISO 639-1 language to use for localizable data. |
No Content
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "code": "BadRequest",
- "subCode": "NA",
- "message": "The request was not in the required format",
- "correlationId": "30d3ebc0b5cb47b0889850bbdfe4aec6"
}Modifies an existing own equity type which can be used to configure the credit facility or allow the customer to specify its credit instance.
| id required | integer <int32> Own equity type Id |
| Accept-Language | string The ISO 639-1 language to use for localizable data. |
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 |
No Content
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "name": {
- "doUpdate": true,
- "value": "string"
}, - "key": {
- "doUpdate": true,
- "value": "string"
}, - "isCash": {
- "doUpdate": true,
- "value": true
}, - "collateralTypeId": {
- "doUpdate": true,
- "value": 0
}
}{- "code": "BadRequest",
- "subCode": "NA",
- "message": "The request was not in the required format",
- "correlationId": "30d3ebc0b5cb47b0889850bbdfe4aec6"
}Retrieves all the own equity types created in the system.
| Accept-Language | string The ISO 639-1 language to use for localizable data. |
OK
Bad Request
Unauthorized
Forbidden
Internal Server Error
[- {
- "id": 0,
- "name": "string",
- "key": "string",
- "isCash": true,
- "collateralTypeId": 0
}
]Creates a new own equity type which can be used to configure the credit facility or allow the customer to specify its credit instance.
| Accept-Language | string The ISO 639-1 language to use for localizable data. |
| name required | string non-empty |
| key required | string non-empty |
| isCash | boolean |
| collateralTypeId | integer <int32> Nullable |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "name": "string",
- "key": "string",
- "isCash": true,
- "collateralTypeId": 0
}{- "code": "BadRequest",
- "subCode": "NA",
- "message": "The request was not in the required format",
- "correlationId": "30d3ebc0b5cb47b0889850bbdfe4aec6"
}Deletes an existing region which is used to configure the credit facility.
| id required | integer <int32> Region Id |
| Accept-Language | string The ISO 639-1 language to use for localizable data. |
No Content
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "code": "BadRequest",
- "subCode": "NA",
- "message": "The request was not in the required format",
- "correlationId": "30d3ebc0b5cb47b0889850bbdfe4aec6"
}Modifies an existing region which can be used to configure the credit facility.
| id required | integer <int32> Region ID |
| Accept-Language | string The ISO 639-1 language to use for localizable data. |
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 |
No Content
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "name": {
- "doUpdate": true,
- "value": "string"
}, - "key": {
- "doUpdate": true,
- "value": "string"
}, - "parentZipCode": {
- "doUpdate": true,
- "value": "string"
}, - "countryId": {
- "doUpdate": true,
- "value": 0
}
}{- "code": "BadRequest",
- "subCode": "NA",
- "message": "The request was not in the required format",
- "correlationId": "30d3ebc0b5cb47b0889850bbdfe4aec6"
}Deletes an existing region code which is used to configure the credit facility.
| regionId required | integer <int32> Region Id |
| regionCodeId required | integer <int32> Region Code Id |
| Accept-Language | string The ISO 639-1 language to use for localizable data. |
No Content
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "code": "BadRequest",
- "subCode": "NA",
- "message": "The request was not in the required format",
- "correlationId": "30d3ebc0b5cb47b0889850bbdfe4aec6"
}Modifies an existing region code that is part of a dedicated region which will be used to configure the credit facility.
| regionId required | integer <int32> Region ID |
| regionCodeId required | integer <int32> RegionCode ID |
| Accept-Language | string The ISO 639-1 language to use for localizable data. |
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 |
No Content
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "name": {
- "doUpdate": true,
- "value": "string"
}, - "code": {
- "doUpdate": true,
- "value": "string"
}, - "key": {
- "doUpdate": true,
- "value": "string"
}
}{- "code": "BadRequest",
- "subCode": "NA",
- "message": "The request was not in the required format",
- "correlationId": "30d3ebc0b5cb47b0889850bbdfe4aec6"
}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.
| Accept-Language | string The ISO 639-1 language to use for localizable data. |
| 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 |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "page": 0,
- "pageSize": 0,
- "sortBy": "string",
- "sortOrder": "Ascending",
- "regionIds": [
- 0
], - "countryIds": [
- 0
], - "keys": [
- "string"
], - "name": "string"
}{- "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
}Creates a new region which can be used to configure the credit facility.
| Accept-Language | string The ISO 639-1 language to use for localizable data. |
Create Region Request
| name required | string non-empty |
| countryId required | integer <int32> |
| key required | string non-empty |
| parentZipCode | string Nullable |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "name": "string",
- "countryId": 0,
- "key": "string",
- "parentZipCode": "string"
}{- "id": 0
}Creates a new region code that is part of a dedicated region which will be used to configure the credit facility.
| id required | integer <int32> |
| Accept-Language | string The ISO 639-1 language to use for localizable data. |
| name required | string non-empty |
| code required | string non-empty |
| key required | string non-empty |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "name": "string",
- "code": "string",
- "key": "string"
}{- "id": 0
}