Operations addressed under /risks — 13 operations.
get-risk-definition-list
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
Response body, read from the service source
The route declares its response as IEnumerable<RiskDefinitionDto>.
| Field | Declared type | Nullable |
|---|---|---|
Code | string | no |
Name | string | no |
Description | string | no |
IsActive | bool | no |
CustomerType | int | no |
Member names are the service's declaration names.
query Parameters
orderByorderSortpageIndexpageSizeget-risk-definition-list › Responses
Success. Returns a collection of records. Of 135 operations in this state that were probed (measured against a reference deployment on parameterless GET routes only), 118 answered and 118 returned a bare JSON array.
Array of catalog-declared response records.
codecustomerTypePermitted values — validated against the customer_type parameter. The service rejects any other value.
| Value | Token | Labels |
|---|---|---|
1 | Individual | en: Individual · tr: Bireysel |
2 | Corporate | en: Corporate · tr: Kurumsal |
descriptionidisActivenamecreate-risk-definition
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
Response body, read from the service source
The route declares its response as AuraCommandDto.
| Field | Declared type | Nullable |
|---|---|---|
Id | Guid | no |
Member names are the service's declaration names.
Error codes this operation is known to raise
| Code | Status | Meaning | Message |
|---|---|---|---|
ERR_RISKMNG_1 | 400 | RISK_DEFINITION_MUST_BE_NULL | There is a risk definition with the same risk code. |
create-risk-definition › Request Body
codecustomerTypePermitted values — validated against the customer_type parameter.
| Value | Meaning |
|---|---|
1 | Individual |
2 | Corporate |
Permitted values — validated against the customer_type parameter. The service rejects any other value.
| Value | Token | Labels |
|---|---|---|
1 | Individual | en: Individual · tr: Bireysel |
2 | Corporate | en: Corporate · tr: Kurumsal |
descriptionnamecreate-risk-definition › Responses
Success. The catalog declares this returns a single record. Of 25 operations in this state with a probeable route, 8 answered and 6 returned a single record — the other two returned a collection and a bare boolean.
idget-risk-definition-all-details
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
Response body, read from the service source
The route declares its response as IEnumerable<RiskDefinitionDetailDto>.
| Field | Declared type | Nullable |
|---|---|---|
QueryPurposes | List<QueryPurposeDetailDto> (collection) | no |
RiskLedgers | List<RiskLedgerDetailDto> (collection) | no |
Member names are the service's declaration names.
query Parameters
orderByorderSortpageIndexpageSizeget-risk-definition-all-details › Responses
Success. Returns a collection of records. Of 135 operations in this state that were probed (measured against a reference deployment on parameterless GET routes only), 118 answered and 118 returned a bare JSON array.
Array of catalog-declared response records.
codecustomerTypePermitted values — validated against the customer_type parameter. The service rejects any other value.
| Value | Token | Labels |
|---|---|---|
1 | Individual | en: Individual · tr: Bireysel |
2 | Corporate | en: Corporate · tr: Kurumsal |
descriptionidisActivenameget-risk-definition-by-id
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
Response body, read from the service source
The route declares its response as RiskDefinitionDto.
| Field | Declared type | Nullable |
|---|---|---|
Code | string | no |
Name | string | no |
Description | string | no |
IsActive | bool | no |
CustomerType | int | no |
Member names are the service's declaration names.
Error codes this operation is known to raise
| Code | Status | Meaning | Message |
|---|---|---|---|
ERR_RISKMNG_2 | 400 | RISK_DEFINITION_MUST_BE_NOT_NULL | Risk definition cannot be found. :{0} |
path Parameters
idget-risk-definition-by-id › Responses
Success. The catalog declares this returns a single record. Of 25 operations in this state with a probeable route, 8 answered and 6 returned a single record — the other two returned a collection and a bare boolean.
codecustomerTypePermitted values — validated against the customer_type parameter. The service rejects any other value.
| Value | Token | Labels |
|---|---|---|
1 | Individual | en: Individual · tr: Bireysel |
2 | Corporate | en: Corporate · tr: Kurumsal |
descriptionidisActivenameupdate-risk-definition
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
Error codes this operation is known to raise
| Code | Status | Meaning | Message |
|---|---|---|---|
ERR_RISKMNG_2 | 400 | RISK_DEFINITION_MUST_BE_NOT_NULL | Risk definition cannot be found. :{0} |
path Parameters
idupdate-risk-definition › Request Body
customerTypePermitted values — validated against the customer_type parameter.
| Value | Meaning |
|---|---|
1 | Individual |
2 | Corporate |
Permitted values — validated against the customer_type parameter. The service rejects any other value.
| Value | Token | Labels |
|---|---|---|
1 | Individual | en: Individual · tr: Bireysel |
2 | Corporate | en: Corporate · tr: Kurumsal |
descriptionnameupdate-risk-definition › Responses
Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as x-aura-code-response.
update-risk-definition-status
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
Error codes this operation is known to raise
| Code | Status | Meaning | Message |
|---|---|---|---|
ERR_RISKMNG_2 | 400 | RISK_DEFINITION_MUST_BE_NOT_NULL | Risk definition cannot be found. :{0} |
ERR_RISKMNG_7 | 400 | RISK_DEFINITION_LEDGER_CODE_MUST_BE_NULL | This ledgercode already has a risk definition.Ledger Code:{0} |
path Parameters
idupdate-risk-definition-status › Responses
Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as x-aura-code-response.
get-risk-definition-details-by-id
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
Response body, read from the service source
The route declares its response as RiskDefinitionDetailDto.
| Field | Declared type | Nullable |
|---|---|---|
QueryPurposes | List<QueryPurposeDetailDto> (collection) | no |
RiskLedgers | List<RiskLedgerDetailDto> (collection) | no |
Member names are the service's declaration names.
Error codes this operation is known to raise
| Code | Status | Meaning | Message |
|---|---|---|---|
ERR_RISKMNG_2 | 400 | RISK_DEFINITION_MUST_BE_NOT_NULL | Risk definition cannot be found. :{0} |
path Parameters
idget-risk-definition-details-by-id › Responses
Success. The catalog declares this returns a single record. Of 25 operations in this state with a probeable route, 8 answered and 6 returned a single record — the other two returned a collection and a bare boolean.
codecustomerTypePermitted values — validated against the customer_type parameter. The service rejects any other value.
| Value | Token | Labels |
|---|---|---|
1 | Individual | en: Individual · tr: Bireysel |
2 | Corporate | en: Corporate · tr: Kurumsal |
descriptionidisActivenameget-risk-ledger-list
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
Response body, read from the service source
The route declares its response as IEnumerable<RiskLedgerBaseDto>.
| Field | Declared type | Nullable |
|---|---|---|
CurrencyRateType | int | no |
LedgerCode | string | no |
AccountProductId | Guid? | yes |
Rate | decimal? | yes |
Member names are the service's declaration names.
path Parameters
idquery Parameters
orderByorderSortpageIndexpageSizeget-risk-ledger-list › Responses
Success. Returns a collection of records. Of 135 operations in this state that were probed (measured against a reference deployment on parameterless GET routes only), 118 answered and 118 returned a bare JSON array.
Array of catalog-declared response records.
accountProductIdcurrencyRateTypePermitted values — validated against the currency_rate_type parameter. The service rejects any other value.
| Value | Token | Labels |
|---|---|---|
1 | CurrencyRateType1 | en: CurrencyRateType1 · tr: CurrencyRateType1 · ar: نوع سعر العملة 1 |
2 | CurrencyRateType2 | en: CurrencyRateType2 · tr: CurrencyRateType2 · ar: نوع معدل العملة 2 |
idledgerCoderatecreate-risk-ledger
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
Response body, read from the service source
The route declares its response as AuraCommandDto.
| Field | Declared type | Nullable |
|---|---|---|
Id | Guid | no |
Member names are the service's declaration names.
Error codes this operation is known to raise
| Code | Status | Meaning | Message |
|---|---|---|---|
ERR_RISKMNG_2 | 400 | RISK_DEFINITION_MUST_BE_NOT_NULL | Risk definition cannot be found. :{0} |
ERR_RISKMNG_7 | 400 | RISK_DEFINITION_LEDGER_CODE_MUST_BE_NULL | This ledgercode already has a risk definition.Ledger Code:{0} |
path Parameters
idcreate-risk-ledger › Request Body
accountProductIdcurrencyRateTypePermitted values — validated against the currency_rate_type parameter.
| Value | Meaning |
|---|---|
1 | CurrencyRateType1 |
2 | CurrencyRateType2 |
Permitted values — validated against the currency_rate_type parameter. The service rejects any other value.
| Value | Token | Labels |
|---|---|---|
1 | CurrencyRateType1 | en: CurrencyRateType1 · tr: CurrencyRateType1 · ar: نوع سعر العملة 1 |
2 | CurrencyRateType2 | en: CurrencyRateType2 · tr: CurrencyRateType2 · ar: نوع معدل العملة 2 |
ledgerCoderatecreate-risk-ledger › Responses
Success. The catalog declares this returns a single record. Of 25 operations in this state with a probeable route, 8 answered and 6 returned a single record — the other two returned a collection and a bare boolean.
iddelete-risk-ledger
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
Error codes this operation is known to raise
| Code | Status | Meaning | Message |
|---|---|---|---|
ERR_RISKMNG_2 | 400 | RISK_DEFINITION_MUST_BE_NOT_NULL | Risk definition cannot be found. :{0} |
ERR_RISKMNG_4 | 400 | RISK_LEDGER_RECORD_NOT_FOUND | Risk - ledger record cannot be found. :{0} |
path Parameters
idriskLedgerIddelete-risk-ledger › Responses
Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as x-aura-code-response.
get-risk-query-purpose-list
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
Response body, read from the service source
The route declares its response as IEnumerable<RiskQueryPurposeDto>.
| Field | Declared type | Nullable |
|---|---|---|
QueryPurpose | int | no |
Member names are the service's declaration names.
Error codes this operation is known to raise
| Code | Status | Meaning | Message |
|---|---|---|---|
ERR_RISKMNG_2 | 400 | RISK_DEFINITION_MUST_BE_NOT_NULL | Risk definition cannot be found. :{0} |
path Parameters
idget-risk-query-purpose-list › Responses
Success. Returns a collection of records. Of 135 operations in this state that were probed (measured against a reference deployment on parameterless GET routes only), 118 answered and 118 returned a bare JSON array.
Array of catalog-declared response records.
idqueryPurposePermitted values — validated against the query_purpose parameter. The service rejects any other value.
| Value | Token | Labels |
|---|---|---|
1 | limit assign | en: limit assign · tr: Limit atama |
2 | Following | en: Following · tr: Takip |
create-risk-query-purpose
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
Error codes this operation is known to raise
| Code | Status | Meaning | Message |
|---|---|---|---|
ERR_RISKMNG_2 | 400 | RISK_DEFINITION_MUST_BE_NOT_NULL | Risk definition cannot be found. :{0} |
ERR_RISKMNG_6 | 400 | RISK_DEFINITION_QUERY_PURPOSES_MUST_BE_NOT_MATCHED | This query purpose already exists. Query Purpose:{0} |
ERR_RISKMNG_8 | 400 | RISK_DEFINITION_DUPLICATE_RISK_QUERY_PURPOSE | The same querypurpose cannot be sent more than once in the list. Query Purpose:{0} |
path Parameters
idcreate-risk-query-purpose › Responses
Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as x-aura-code-response.
delete-risk-query-purpose
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
Error codes this operation is known to raise
| Code | Status | Meaning | Message |
|---|---|---|---|
ERR_RISKMNG_2 | 400 | RISK_DEFINITION_MUST_BE_NOT_NULL | Risk definition cannot be found. :{0} |
ERR_RISKMNG_3 | 400 | RISK_DEFINITION_QUERY_PURPOSES_MUST_BE_NOT_NULL | Query purpose record cannot be found. :{0} |
path Parameters
idqueryPurposeIddelete-risk-query-purpose › Responses
Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as x-aura-code-response.