loans--insurances

Operations addressed under /loans — 79 operations.

Rendered section: This page contains the insurances route group from loans. This is a presentation-only partition; it does not change the API contract or operation tags in the downloadable OpenAPI.

get-insurance-list

GET

https://dg-sandbox.dgpays.com/loan-service

/loans/insurances

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

Field	Declared type	Nullable
`Id`	`Guid`	no
`Type`	`int`	no
`PolicyNumber`	`int`	no
`LoanId`	`Guid`	no
`ProductName`	`string`	no
`Company`	`string`	no
`PolicyHolderNumber`	`int`	no
`CoverageCurrencyNumber`	`string`	no
`PolicyHolderFullname`	`string`	no
`LossPayee`	`string`	no
`VehicleBrand`	`string`	no
`VehicleModel`	`string`	no
`VehicleType`	`string`	no
`EngineNumber`	`string`	no
`ChassisNumber`	`string`	no
`Plate`	`string`	no
`PremiumAmount`	`decimal?`	yes
`PremiumCurrencyNumber`	`string`	no
`CoverageAmount`	`decimal?`	yes
`StartDate`	`DateTime?`	yes
`EndDate`	`DateTime?`	yes

Member names are the service's declaration names.

get-insurance-list › query Parameters

object

orderBy

string

orderSort

string

pageIndex

integer · int32

pageSize

integer · int32

get-insurance-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.

chassisNumber

string

company

string

coverageAmount

number · decimal

coverageCurrencyNumber

string

endDate

string · date-time

engineNumber

string

id

string · uuid

loanId

string · uuid

lossPayee

string

plate

string

policyHolderFullname

string

policyHolderNumber

integer · int32

policyNumber

integer · int32

premiumAmount

number · decimal

premiumCurrencyNumber

string

productName

string

startDate

string · date-time

type

integer · int32

Permitted values — validated against the insurance_type parameter. The service rejects any other value.

Value	Token	Labels
`1`	`Trafik Sigortasi`	en: Traffic Insurance · tr: Trafik Sigortasi
`2`	`Kasko`	tr: Kasko

vehicleBrand

string

vehicleModel

string

vehicleType

string

GET/loans/insurances

curl https://dg-sandbox.dgpays.com/loan-service/loans/insurances

Example Responses

[
  {
    "chassisNumber": "chassisNumber",
    "company": "company",
    "coverageAmount": 0,
    "coverageCurrencyNumber": "coverageCurrencyNumber",
    "endDate": "2024-08-25T15:00:00Z",
    "engineNumber": "engineNumber",
    "id": "00000000-0000-0000-0000-000000000000",
    "loanId": "00000000-0000-0000-0000-000000000000",
    "lossPayee": "lossPayee",
    "plate": "plate",
    "policyHolderFullname": "policyHolderFullname",
    "policyHolderNumber": 0,
    "policyNumber": 0,
    "premiumAmount": 0,
    "premiumCurrencyNumber": "premiumCurrencyNumber",
    "productName": "productName",
    "startDate": "2024-08-25T15:00:00Z",
    "type": 0,
    "vehicleBrand": "vehicleBrand",
    "vehicleModel": "vehicleModel",
    "vehicleType": "vehicleType"
  }
]

json

application/json

get-insurance-by-loan-id

GET

https://dg-sandbox.dgpays.com/loan-service

/loans/{id}/insurances

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

Field	Declared type	Nullable
`Id`	`Guid`	no
`Type`	`int`	no
`PolicyNumber`	`int`	no
`LoanId`	`Guid`	no
`ProductName`	`string`	no
`Company`	`string`	no
`PolicyHolderNumber`	`int`	no
`CoverageCurrencyNumber`	`string`	no
`PolicyHolderFullname`	`string`	no
`LossPayee`	`string`	no
`VehicleBrand`	`string`	no
`VehicleModel`	`string`	no
`VehicleType`	`string`	no
`EngineNumber`	`string`	no
`ChassisNumber`	`string`	no
`Plate`	`string`	no
`PremiumAmount`	`decimal?`	yes
`PremiumCurrencyNumber`	`string`	no
`CoverageAmount`	`decimal?`	yes
`StartDate`	`DateTime?`	yes
`EndDate`	`DateTime?`	yes

Member names are the service's declaration names.

Error codes this operation is known to raise

Code	Status	Meaning
`ERR_LOAN_17`	400	`LOAN_MUST_NOT_BE_NULL`

get-insurance-by-loan-id › path Parameters

id

string · uuid · required

get-insurance-by-loan-id › Responses

object[]

Array of catalog-declared response records.

chassisNumber

string

company

string

coverageAmount

number · decimal

coverageCurrencyNumber

string

endDate

string · date-time

engineNumber

string

id

string · uuid

loanId

string · uuid

lossPayee

string

plate

string

policyHolderFullname

string

policyHolderNumber

integer · int32

policyNumber

integer · int32

premiumAmount

number · decimal

premiumCurrencyNumber

string

productName

string

startDate

string · date-time

type

integer · int32

Permitted values — validated against the insurance_type parameter. The service rejects any other value.

Value	Token	Labels
`1`	`Trafik Sigortasi`	en: Traffic Insurance · tr: Trafik Sigortasi
`2`	`Kasko`	tr: Kasko

vehicleBrand

string

vehicleModel

string

vehicleType

string

GET/loans/{id}/insurances

curl https://dg-sandbox.dgpays.com/loan-service/loans/:id/insurances

Example Responses

[
  {
    "chassisNumber": "chassisNumber",
    "company": "company",
    "coverageAmount": 0,
    "coverageCurrencyNumber": "coverageCurrencyNumber",
    "endDate": "2024-08-25T15:00:00Z",
    "engineNumber": "engineNumber",
    "id": "00000000-0000-0000-0000-000000000000",
    "loanId": "00000000-0000-0000-0000-000000000000",
    "lossPayee": "lossPayee",
    "plate": "plate",
    "policyHolderFullname": "policyHolderFullname",
    "policyHolderNumber": 0,
    "policyNumber": 0,
    "premiumAmount": 0,
    "premiumCurrencyNumber": "premiumCurrencyNumber",
    "productName": "productName",
    "startDate": "2024-08-25T15:00:00Z",
    "type": 0,
    "vehicleBrand": "vehicleBrand",
    "vehicleModel": "vehicleModel",
    "vehicleType": "vehicleType"
  }
]

json

application/json

create-insurance

POST

https://dg-sandbox.dgpays.com/loan-service

/loans/{id}/insurances

Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.

Response body, read from the service source

The route returns AuraCommandDto<Guid>, which is the response body itself and not a wrapper around one: the framework declares it as a class with a single property, Id, of type Guid. A caller gets a JSON OBJECT with one field, not a bare value. The field is id on the wire.

Field	Name on the wire	Declared type	Nullable
`Id`	`id`	`Guid`	no

Member names are the service's declaration names.

Error codes this operation is known to raise

Code	Status	Meaning
`ERR_LOAN_17`	400	`LOAN_MUST_NOT_BE_NULL`

create-insurance › path Parameters

id

string · uuid · required

create-insurance › Request Body

company

string · required

policyHolderNumber

integer · int32 · required

policyNumber

integer · int32 · required

productName

string · required

type

integer · int32 · required

Permitted values — validated against the insurance_type parameter.

Value	Meaning
`1`	Traffic Insurance
`2`	Kasko

Permitted values — validated against the insurance_type parameter. The service rejects any other value.

Value	Token	Labels
`1`	`Trafik Sigortasi`	en: Traffic Insurance · tr: Trafik Sigortasi
`2`	`Kasko`	tr: Kasko

chassisNumber

string

coverageAmount

number · decimal

coverageCurrencyNumber

string

endDate

string · date-time

engineNumber

string

lossPayee

string

plate

string

policyHolderFullname

string

premiumAmount

number · decimal

premiumCurrencyNumber

string

startDate

string · date-time

vehicleBrand

string

vehicleModel

string

vehicleType

string

create-insurance › Responses

Success. An exact, uniquely bound route registration declares the command-id envelope, so this schema is the code-backed body contract.

Body shape declared by the exact route registration for the catalog's 200 response.

id

string · uuid

Identifier returned by the command.

POST/loans/{id}/insurances

curl https://dg-sandbox.dgpays.com/loan-service/loans/:id/insurances \
  --request POST \
  --header 'Content-Type: application/json' \
  --data '{
  "chassisNumber": "",
  "company": "",
  "coverageAmount": 0,
  "coverageCurrencyNumber": "",
  "endDate": "",
  "engineNumber": "",
  "lossPayee": "",
  "plate": "",
  "policyHolderFullname": "",
  "policyHolderNumber": 0,
  "policyNumber": 0,
  "premiumAmount": 0,
  "premiumCurrencyNumber": "",
  "productName": "",
  "startDate": "",
  "type": 0,
  "vehicleBrand": "",
  "vehicleModel": "",
  "vehicleType": ""
}'

Example Request Body

{
  "chassisNumber": "",
  "company": "",
  "coverageAmount": 0,
  "coverageCurrencyNumber": "",
  "endDate": "",
  "engineNumber": "",
  "lossPayee": "",
  "plate": "",
  "policyHolderFullname": "",
  "policyHolderNumber": 0,
  "policyNumber": 0,
  "premiumAmount": 0,
  "premiumCurrencyNumber": "",
  "productName": "",
  "startDate": "",
  "type": 0,
  "vehicleBrand": "",
  "vehicleModel": "",
  "vehicleType": ""
}

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-insurance-by-id

GET

https://dg-sandbox.dgpays.com/loan-service

/loans/{id}/insurances/{insuranceId}

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

Field	Declared type	Nullable
`Id`	`Guid`	no
`Type`	`int`	no
`PolicyNumber`	`int`	no
`LoanId`	`Guid`	no
`ProductName`	`string`	no
`Company`	`string`	no
`PolicyHolderNumber`	`int`	no
`CoverageCurrencyNumber`	`string`	no
`PolicyHolderFullname`	`string`	no
`LossPayee`	`string`	no
`VehicleBrand`	`string`	no
`VehicleModel`	`string`	no
`VehicleType`	`string`	no
`EngineNumber`	`string`	no
`ChassisNumber`	`string`	no
`Plate`	`string`	no
`PremiumAmount`	`decimal?`	yes
`PremiumCurrencyNumber`	`string`	no
`CoverageAmount`	`decimal?`	yes
`StartDate`	`DateTime?`	yes
`EndDate`	`DateTime?`	yes

Member names are the service's declaration names.

Error codes this operation is known to raise

Code	Status	Meaning
`ERR_LOAN_17`	400	`LOAN_MUST_NOT_BE_NULL`
`ERR_LOAN_95`	400	`LOAN_INSURANCE_NOT_FOUND`

get-insurance-by-id › path Parameters

id

string · uuid · required

insuranceId

string · uuid · required

get-insurance-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.

chassisNumber

string

company

string

coverageAmount

number · decimal

coverageCurrencyNumber

string

endDate

string · date-time

engineNumber

string

id

string · uuid

loanId

string · uuid

lossPayee

string

plate

string

policyHolderFullname

string

policyHolderNumber

integer · int32

policyNumber

integer · int32

premiumAmount

number · decimal

premiumCurrencyNumber

string

productName

string

startDate

string · date-time

type

integer · int32

Permitted values — validated against the insurance_type parameter. The service rejects any other value.

Value	Token	Labels
`1`	`Trafik Sigortasi`	en: Traffic Insurance · tr: Trafik Sigortasi
`2`	`Kasko`	tr: Kasko

vehicleBrand

string

vehicleModel

string

vehicleType

string

GET/loans/{id}/insurances/{insuranceId}

curl https://dg-sandbox.dgpays.com/loan-service/loans/:id/insurances/:insuranceId

Example Responses

{
  "chassisNumber": "chassisNumber",
  "company": "company",
  "coverageAmount": 0,
  "coverageCurrencyNumber": "coverageCurrencyNumber",
  "endDate": "2024-08-25T15:00:00Z",
  "engineNumber": "engineNumber",
  "id": "00000000-0000-0000-0000-000000000000",
  "loanId": "00000000-0000-0000-0000-000000000000",
  "lossPayee": "lossPayee",
  "plate": "plate",
  "policyHolderFullname": "policyHolderFullname",
  "policyHolderNumber": 0,
  "policyNumber": 0,
  "premiumAmount": 0,
  "premiumCurrencyNumber": "premiumCurrencyNumber",
  "productName": "productName",
  "startDate": "2024-08-25T15:00:00Z",
  "type": 0,
  "vehicleBrand": "vehicleBrand",
  "vehicleModel": "vehicleModel",
  "vehicleType": "vehicleType"
}

json

application/json

update-insurance

PUT

https://dg-sandbox.dgpays.com/loan-service

/loans/{id}/insurances/{insuranceId}

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
`ERR_LOAN_17`	400	`LOAN_MUST_NOT_BE_NULL`
`ERR_LOAN_95`	400	`LOAN_INSURANCE_NOT_FOUND`

update-insurance › path Parameters

id

string · uuid · required

insuranceId

string · uuid · required

update-insurance › Request Body

type

integer · int32 · required

Permitted values — validated against the insurance_type parameter.

Value	Meaning
`1`	Traffic Insurance
`2`	Kasko

Permitted values — validated against the insurance_type parameter. The service rejects any other value.

Value	Token	Labels
`1`	`Trafik Sigortasi`	en: Traffic Insurance · tr: Trafik Sigortasi
`2`	`Kasko`	tr: Kasko

chassisNumber

string

company

string

coverageAmount

number · decimal

coverageCurrencyNumber

string

endDate

string · date-time

engineNumber

string

lossPayee

string

plate

string

policyHolderFullname

string

policyHolderNumber

integer · int32

policyNumber

integer · int32

premiumAmount

number · decimal

premiumCurrencyNumber

string

productName

string

startDate

string · date-time

vehicleBrand

string

vehicleModel

string

vehicleType

string

update-insurance › 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.

No data returned

PUT/loans/{id}/insurances/{insuranceId}

curl https://dg-sandbox.dgpays.com/loan-service/loans/:id/insurances/:insuranceId \
  --request PUT \
  --header 'Content-Type: application/json' \
  --data '{
  "chassisNumber": "",
  "company": "",
  "coverageAmount": 0,
  "coverageCurrencyNumber": "",
  "endDate": "",
  "engineNumber": "",
  "lossPayee": "",
  "plate": "",
  "policyHolderFullname": "",
  "policyHolderNumber": 0,
  "policyNumber": 0,
  "premiumAmount": 0,
  "premiumCurrencyNumber": "",
  "productName": "",
  "startDate": "",
  "type": 0,
  "vehicleBrand": "",
  "vehicleModel": "",
  "vehicleType": ""
}'

Example Request Body

{
  "chassisNumber": "",
  "company": "",
  "coverageAmount": 0,
  "coverageCurrencyNumber": "",
  "endDate": "",
  "engineNumber": "",
  "lossPayee": "",
  "plate": "",
  "policyHolderFullname": "",
  "policyHolderNumber": 0,
  "policyNumber": 0,
  "premiumAmount": 0,
  "premiumCurrencyNumber": "",
  "productName": "",
  "startDate": "",
  "type": 0,
  "vehicleBrand": "",
  "vehicleModel": "",
  "vehicleType": ""
}

json

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

application/json

Example Responses

No example specified for this content type

delete-insurance

DELETE

https://dg-sandbox.dgpays.com/loan-service

/loans/{id}/insurances/{insuranceId}

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
`ERR_LOAN_17`	400	`LOAN_MUST_NOT_BE_NULL`
`ERR_LOAN_95`	400	`LOAN_INSURANCE_NOT_FOUND`

delete-insurance › path Parameters

id

string · uuid · required

insuranceId

string · uuid · required

delete-insurance › Responses

No data returned

loans--installments loans--internal-external-disbursement