customer-risks

Operations addressed under /customer-risks — 4 operations.

get-customer-risk-list

GET

https://dg-sandbox.dgpays.com/risk-management-service

/customer-risks

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<CustomerRiskDto>.

Field	Declared type	Nullable
`CustomerId`	`Guid?`	yes
`QueryPurpose`	`int`	no
`QueryDate`	`DateTime?`	yes
`TotalRiskAmount`	`decimal?`	yes
`CurrencyNumber`	`string`	no
`CustomerRiskDetails`	`List<CustomerRiskDetailDto>` (collection)	no

Member names are the service's declaration names.

get-customer-risk-list › query Parameters

object

orderBy

string

orderSort

string

pageIndex

integer · int32

pageSize

integer · int32

get-customer-risk-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.

object[]

Array of catalog-declared response records.

currencyNumber

string

customerId

string · uuid

object[]

id

string · uuid

queryDate

string · date-time

queryPurpose

integer · int32

Permitted 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

totalRiskAmount

number · decimal

GET/customer-risks

curl https://dg-sandbox.dgpays.com/risk-management-service/customer-risks

Example Responses

[
  {
    "currencyNumber": "currencyNumber",
    "customerId": "00000000-0000-0000-0000-000000000000",
    "customerRiskDetails": [
      {
        "accountNumber": "accountNumber",
        "accountProductId": "00000000-0000-0000-0000-000000000000",
        "currencyNumber": "currencyNumber",
        "id": "00000000-0000-0000-0000-000000000000",
        "ledgerAmount": 0,
        "localAmount": 0,
        "rate": 0,
        "riskAmount": 0,
        "riskLedgerId": "00000000-0000-0000-0000-000000000000"
      }
    ],
    "id": "00000000-0000-0000-0000-000000000000",
    "queryDate": "2024-08-25T15:00:00Z",
    "queryPurpose": 0,
    "totalRiskAmount": 0
  }
]

json

application/json

create-customer-risk

POST

https://dg-sandbox.dgpays.com/risk-management-service

/customer-risks

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_11`	400	`CURRENCY_ID_NOT_FOUND`	Currency cannot be found.
`ERR_RISKMNG_4`	400	`RISK_LEDGER_RECORD_NOT_FOUND`	Risk - ledger record cannot be found. :`{0}`
`ERR_RISKMNG_5`	400	`LOCAL_AMOUNT_SUM_MUST_BE_EQUAL_TO_TOTAL_RISK_AMOUNT`	The localAmount sum in the customer risk detail list must be equal to the Total Risk Amount.

create-customer-risk › Request Body

currencyNumber

string · required

customerId

string · uuid · required

queryPurpose

integer · int32 · required

Permitted values — validated against the query_purpose parameter.

Value	Meaning
`1`	limit assign
`2`	Following

Permitted 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

totalRiskAmount

number · decimal · required

object[]

create-customer-risk › 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.

id

string · uuid

POST/customer-risks

curl https://dg-sandbox.dgpays.com/risk-management-service/customer-risks \
  --request POST \
  --header 'Content-Type: application/json' \
  --data '{
  "currencyNumber": "",
  "customerId": "",
  "customerRiskDetails": [
    {
      "accountNumber": "",
      "currencyNumber": "",
      "ledgerAmount": 0,
      "localAmount": 0,
      "rate": 0,
      "riskAmount": 0,
      "riskLedgerId": ""
    }
  ],
  "queryPurpose": 0,
  "totalRiskAmount": 0
}'

Example Request Body

{
  "currencyNumber": "",
  "customerId": "",
  "customerRiskDetails": [
    {
      "accountNumber": "",
      "currencyNumber": "",
      "ledgerAmount": 0,
      "localAmount": 0,
      "rate": 0,
      "riskAmount": 0,
      "riskLedgerId": ""
    }
  ],
  "queryPurpose": 0,
  "totalRiskAmount": 0
}

json

The field names and types this operation declares. Replace the values before sending.

application/json

Example Responses

{
  "id": "00000000-0000-0000-0000-000000000000"
}

json

application/json

get-current-customer-risk-by-customer-id

GET

https://dg-sandbox.dgpays.com/risk-management-service

/customer-risks/by-customer-id/{customerId}/current

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 CustomerRiskDto.

Field	Declared type	Nullable
`CustomerId`	`Guid?`	yes
`QueryPurpose`	`int`	no
`QueryDate`	`DateTime?`	yes
`TotalRiskAmount`	`decimal?`	yes
`CurrencyNumber`	`string`	no
`CustomerRiskDetails`	`List<CustomerRiskDetailDto>` (collection)	no

Member names are the service's declaration names.

Error codes this operation is known to raise

Code	Status	Meaning	Message
`ERR_RISKMNG_10`	400	`CUSTOMER_RISK_MUST_BE_NOT_NULL`	Customer risk cannot be found. :`{0}`

get-current-customer-risk-by-customer-id › path Parameters

customerId

string · uuid · required

get-current-customer-risk-by-customer-id › query Parameters

orderBy

string

orderSort

string

get-current-customer-risk-by-customer-id › Responses

Success. An exact, uniquely bound route registration classifies this response as a single-record.

No data returned

get-customer-risk-by-id

GET

https://dg-sandbox.dgpays.com/risk-management-service

/customer-risks/{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 CustomerRiskDto.

Field	Declared type	Nullable
`CustomerId`	`Guid?`	yes
`QueryPurpose`	`int`	no
`QueryDate`	`DateTime?`	yes
`TotalRiskAmount`	`decimal?`	yes
`CurrencyNumber`	`string`	no
`CustomerRiskDetails`	`List<CustomerRiskDetailDto>` (collection)	no

Member names are the service's declaration names.

Error codes this operation is known to raise

Code	Status	Meaning	Message
`ERR_RISKMNG_10`	400	`CUSTOMER_RISK_MUST_BE_NOT_NULL`	Customer risk cannot be found. :`{0}`

get-customer-risk-by-id › path Parameters

id

string · uuid · required

get-customer-risk-by-id › Responses

currencyId

integer · int32

customerId

string · uuid

object[]

id

string · uuid

queryDate

string · date-time

queryPurpose

integer · int32

Permitted 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

totalRiskAmount

number · decimal

GET/customer-risks/{id}

curl https://dg-sandbox.dgpays.com/risk-management-service/customer-risks/:id

Example Responses

{
  "currencyId": 0,
  "customerId": "00000000-0000-0000-0000-000000000000",
  "customerRiskDetails": [
    {
      "accountNumber": "accountNumber",
      "accountProductId": "00000000-0000-0000-0000-000000000000",
      "currencyId": 0,
      "id": "00000000-0000-0000-0000-000000000000",
      "ledgerAmount": 0,
      "localAmount": 0,
      "rate": 0,
      "riskAmount": 0,
      "riskLedgerId": "00000000-0000-0000-0000-000000000000"
    }
  ],
  "id": "00000000-0000-0000-0000-000000000000",
  "queryDate": "2024-08-25T15:00:00Z",
  "queryPurpose": 0,
  "totalRiskAmount": 0
}

json

application/json

customer-risk-levels data-migrations

Risk Management Service

customer-risks

Operations addressed under /customer-risks — 4 operations.

get-customer-risk-list

GET

https://dg-sandbox.dgpays.com/risk-management-service

/customer-risks

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<CustomerRiskDto>.

Field	Declared type	Nullable
`CustomerId`	`Guid?`	yes
`QueryPurpose`	`int`	no
`QueryDate`	`DateTime?`	yes
`TotalRiskAmount`	`decimal?`	yes
`CurrencyNumber`	`string`	no
`CustomerRiskDetails`	`List<CustomerRiskDetailDto>` (collection)	no

Member names are the service's declaration names.

get-customer-risk-list › query Parameters

object

orderBy

string

orderSort

string

pageIndex

integer · int32

pageSize

integer · int32

get-customer-risk-list › Responses

object[]

Array of catalog-declared response records.

currencyNumber

string

customerId

string · uuid

object[]

id

string · uuid

queryDate

string · date-time

queryPurpose

integer · int32

Permitted 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

totalRiskAmount

number · decimal

GET/customer-risks

curl https://dg-sandbox.dgpays.com/risk-management-service/customer-risks

Example Responses

[
  {
    "currencyNumber": "currencyNumber",
    "customerId": "00000000-0000-0000-0000-000000000000",
    "customerRiskDetails": [
      {
        "accountNumber": "accountNumber",
        "accountProductId": "00000000-0000-0000-0000-000000000000",
        "currencyNumber": "currencyNumber",
        "id": "00000000-0000-0000-0000-000000000000",
        "ledgerAmount": 0,
        "localAmount": 0,
        "rate": 0,
        "riskAmount": 0,
        "riskLedgerId": "00000000-0000-0000-0000-000000000000"
      }
    ],
    "id": "00000000-0000-0000-0000-000000000000",
    "queryDate": "2024-08-25T15:00:00Z",
    "queryPurpose": 0,
    "totalRiskAmount": 0
  }
]

json

application/json

create-customer-risk

POST

https://dg-sandbox.dgpays.com/risk-management-service

/customer-risks

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_11`	400	`CURRENCY_ID_NOT_FOUND`	Currency cannot be found.
`ERR_RISKMNG_4`	400	`RISK_LEDGER_RECORD_NOT_FOUND`	Risk - ledger record cannot be found. :`{0}`
`ERR_RISKMNG_5`	400	`LOCAL_AMOUNT_SUM_MUST_BE_EQUAL_TO_TOTAL_RISK_AMOUNT`	The localAmount sum in the customer risk detail list must be equal to the Total Risk Amount.

create-customer-risk › Request Body

currencyNumber

string · required

customerId

string · uuid · required

queryPurpose

integer · int32 · required

Permitted values — validated against the query_purpose parameter.

Value	Meaning
`1`	limit assign
`2`	Following

Permitted 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

totalRiskAmount

number · decimal · required

object[]

create-customer-risk › Responses

id

string · uuid

POST/customer-risks

curl https://dg-sandbox.dgpays.com/risk-management-service/customer-risks \
  --request POST \
  --header 'Content-Type: application/json' \
  --data '{
  "currencyNumber": "",
  "customerId": "",
  "customerRiskDetails": [
    {
      "accountNumber": "",
      "currencyNumber": "",
      "ledgerAmount": 0,
      "localAmount": 0,
      "rate": 0,
      "riskAmount": 0,
      "riskLedgerId": ""
    }
  ],
  "queryPurpose": 0,
  "totalRiskAmount": 0
}'

Example Request Body

{
  "currencyNumber": "",
  "customerId": "",
  "customerRiskDetails": [
    {
      "accountNumber": "",
      "currencyNumber": "",
      "ledgerAmount": 0,
      "localAmount": 0,
      "rate": 0,
      "riskAmount": 0,
      "riskLedgerId": ""
    }
  ],
  "queryPurpose": 0,
  "totalRiskAmount": 0
}

json

The field names and types this operation declares. Replace the values before sending.

application/json

Example Responses

{
  "id": "00000000-0000-0000-0000-000000000000"
}

json

application/json

get-current-customer-risk-by-customer-id

GET

https://dg-sandbox.dgpays.com/risk-management-service

/customer-risks/by-customer-id/{customerId}/current

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 CustomerRiskDto.

Field	Declared type	Nullable
`CustomerId`	`Guid?`	yes
`QueryPurpose`	`int`	no
`QueryDate`	`DateTime?`	yes
`TotalRiskAmount`	`decimal?`	yes
`CurrencyNumber`	`string`	no
`CustomerRiskDetails`	`List<CustomerRiskDetailDto>` (collection)	no

Member names are the service's declaration names.

Error codes this operation is known to raise

Code	Status	Meaning	Message
`ERR_RISKMNG_10`	400	`CUSTOMER_RISK_MUST_BE_NOT_NULL`	Customer risk cannot be found. :`{0}`

get-current-customer-risk-by-customer-id › path Parameters

customerId

string · uuid · required

get-current-customer-risk-by-customer-id › query Parameters

orderBy

string

orderSort

string

get-current-customer-risk-by-customer-id › Responses

Success. An exact, uniquely bound route registration classifies this response as a single-record.

No data returned

get-customer-risk-by-id

GET

https://dg-sandbox.dgpays.com/risk-management-service

/customer-risks/{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 CustomerRiskDto.

Field	Declared type	Nullable
`CustomerId`	`Guid?`	yes
`QueryPurpose`	`int`	no
`QueryDate`	`DateTime?`	yes
`TotalRiskAmount`	`decimal?`	yes
`CurrencyNumber`	`string`	no
`CustomerRiskDetails`	`List<CustomerRiskDetailDto>` (collection)	no

Member names are the service's declaration names.

Error codes this operation is known to raise

Code	Status	Meaning	Message
`ERR_RISKMNG_10`	400	`CUSTOMER_RISK_MUST_BE_NOT_NULL`	Customer risk cannot be found. :`{0}`

get-customer-risk-by-id › path Parameters

id

string · uuid · required

get-customer-risk-by-id › Responses

currencyId

integer · int32

customerId

string · uuid

object[]

id

string · uuid

queryDate

string · date-time

queryPurpose

integer · int32

Permitted 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

totalRiskAmount

number · decimal

GET/customer-risks/{id}

curl https://dg-sandbox.dgpays.com/risk-management-service/customer-risks/:id

Example Responses

{
  "currencyId": 0,
  "customerId": "00000000-0000-0000-0000-000000000000",
  "customerRiskDetails": [
    {
      "accountNumber": "accountNumber",
      "accountProductId": "00000000-0000-0000-0000-000000000000",
      "currencyId": 0,
      "id": "00000000-0000-0000-0000-000000000000",
      "ledgerAmount": 0,
      "localAmount": 0,
      "rate": 0,
      "riskAmount": 0,
      "riskLedgerId": "00000000-0000-0000-0000-000000000000"
    }
  ],
  "id": "00000000-0000-0000-0000-000000000000",
  "queryDate": "2024-08-25T15:00:00Z",
  "queryPurpose": 0,
  "totalRiskAmount": 0
}

json

application/json

customer-risk-levels data-migrations