collaterals
Operations addressed under /collaterals — 19 operations.
get-collateral-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<CollateralDto>.
| Field | Declared type | Nullable |
|---|---|---|
Id | Guid? | yes |
CollateralTypeId | Guid? | yes |
CollateralNumber | string | no |
CustomerId | Guid? | yes |
Name | string | no |
Description | string | no |
Amount | decimal? | yes |
CurrencyNumber | string | no |
UsableRate | decimal? | yes |
Date | DateTime? | yes |
MaturityDate | DateTime? | yes |
ExpiryDate | DateTime? | yes |
PledgeAmount | decimal? | yes |
Fields | List<CollateralFieldValueDto> (collection) | no |
Pledges | List<PledgeDto> (collection) | no |
Usages | List<CollateralUsageDto> (collection) | no |
Member names are the service's declaration names.
query Parameters
orderByorderSortpageIndexpageSizeget-collateral-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.
amountcollateralNumbercollateralTypeIdcurrencyNumbercustomerIddatedescriptionexpiryDateidmaturityDatenamepledgeAmountusableRatecreate-collateral
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.
create-collateral › Request Body
amountcollateralTypeIdcurrencyNumbercustomerIddescriptionmaturityDatenameusableRatecreate-collateral › Responses
Success. An exact, uniquely bound route registration declares the command-id envelope, so this schema is the code-backed body contract.
idIdentifier returned by the command.
get-pledge-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<PledgeDto>.
| Field | Declared type | Nullable |
|---|---|---|
Id | Guid? | yes |
CustomerId | Guid | no |
CollateralId | Guid | no |
Status | int? | yes |
IsActive | bool? | yes |
NotaryPledgeNumber | string | no |
Amount | decimal? | yes |
NotaryTransactionNumber | string | no |
Description | string | no |
RemovalDate | DateTime? | yes |
StartDate | DateTime? | yes |
EndDate | DateTime? | yes |
Member names are the service's declaration names.
query Parameters
orderByorderSortpageIndexpageSizeget-pledge-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.
amountcollateralIdcustomerIddescriptionendDateidisActivenotaryPledgeNumbernotaryTransactionNumberremovalDatestartDatestatusPermitted values — validated against the pledge_status parameter. The service rejects any other value.
| Value | Token | Labels |
|---|---|---|
1 | Pre-pledge | ar: الالتزام المسبق |
2 | Pledge | ar: تعهد |
get-collateral-usage-by-loan-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 IEnumerable<CollateralUsageDto>.
| Field | Declared type | Nullable |
|---|---|---|
Id | Guid? | yes |
CollateralId | Guid? | yes |
UsageType | int? | yes |
LoanId | Guid? | yes |
Description | string | no |
Amount | decimal? | yes |
CurrencyNumber | string | no |
IsActive | bool? | yes |
UsageDate | DateTime? | yes |
Member names are the service's declaration names.
path Parameters
loanIdquery Parameters
orderByorderSortpageIndexpageSizeget-collateral-usage-by-loan-id › 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.
amountcollateralIdcurrencyNumberdescriptionidisActiveloanIdusageDateusageTypePermitted values — validated against the collateral_usage_type parameter. The service rejects any other value.
| Value | Token | Labels |
|---|---|---|
1 | loan | en: loan · tr: kredi · ar: قرض |
2 | limit | en: limit · tr: limit · ar: حد |
get-collateral-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 CollateralDto.
| Field | Declared type | Nullable |
|---|---|---|
Id | Guid? | yes |
CollateralTypeId | Guid? | yes |
CollateralNumber | string | no |
CustomerId | Guid? | yes |
Name | string | no |
Description | string | no |
Amount | decimal? | yes |
CurrencyNumber | string | no |
UsableRate | decimal? | yes |
Date | DateTime? | yes |
MaturityDate | DateTime? | yes |
ExpiryDate | DateTime? | yes |
PledgeAmount | decimal? | yes |
Fields | List<CollateralFieldValueDto> (collection) | no |
Pledges | List<PledgeDto> (collection) | no |
Usages | List<CollateralUsageDto> (collection) | no |
Member names are the service's declaration names.
path Parameters
idget-collateral-by-id › Responses
Success. An exact, uniquely bound route registration classifies this response as a single-record.
update-collateral
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
path Parameters
idupdate-collateral › Request Body
amountcurrencyNumberdescriptionmaturityDatenamestartDateusableRateexpiryDateupdate-collateral › 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-customer-collateral-expiry-date
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_CLLTRL_10 | 400 | EXPIRE_DATE_NOT_ALLOWED_FOR_UPDATE | Expiry Date cannot be updated because the collateral is in use. Collateral Usage: {0} |
ERR_CLLTRL_13 | 400 | COLLATERAL_NOT_FOUND | Collateral cannot be found. :{0} |
path Parameters
idupdate-customer-collateral-expiry-date › 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.
create-collateral-field-value
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
path Parameters
idcreate-collateral-field-value › 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-collateral-field-value
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
path Parameters
idfieldValueIdupdate-collateral-field-value › 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-collateral-field-value
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
path Parameters
idfieldValueIddelete-collateral-field-value › 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-pledge-list-by-collateral-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 IEnumerable<PledgeDto>.
| Field | Declared type | Nullable |
|---|---|---|
Id | Guid? | yes |
CustomerId | Guid | no |
CollateralId | Guid | no |
Status | int? | yes |
IsActive | bool? | yes |
NotaryPledgeNumber | string | no |
Amount | decimal? | yes |
NotaryTransactionNumber | string | no |
Description | string | no |
RemovalDate | DateTime? | 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 | Message |
|---|---|---|---|
ERR_CLLTRL_13 | 400 | COLLATERAL_NOT_FOUND | Collateral cannot be found. :{0} |
path Parameters
idquery Parameters
orderByorderSortpageIndexpageSizeget-pledge-list-by-collateral-id › 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.
amountcollateralIdcustomerIddescriptionendDateidisActivenotaryPledgeNumbernotaryTransactionNumberremovalDatestartDatestatusPermitted values — validated against the pledge_status parameter. The service rejects any other value.
| Value | Token | Labels |
|---|---|---|
1 | Pre-pledge | ar: الالتزام المسبق |
2 | Pledge | ar: تعهد |
create-pledge
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 | Message |
|---|---|---|---|
ERR_CLLTRL_13 | 400 | COLLATERAL_NOT_FOUND | Collateral cannot be found. :{0} |
path Parameters
idcreate-pledge › Request Body
amountcustomerIdnotaryPledgeNumberstartDatestatusPermitted values — validated against the pledge_status parameter.
| Value | Meaning |
|---|---|
1 | Pre-pledge |
2 | Pledge |
Permitted values — validated against the pledge_status parameter. The service rejects any other value.
| Value | Token | Labels |
|---|---|---|
1 | Pre-pledge | ar: الالتزام المسبق |
2 | Pledge | ar: تعهد |
descriptionendDatenotaryTransactionNumberremovalDatecreate-pledge › Responses
Success. An exact, uniquely bound route registration declares the command-id envelope, so this schema is the code-backed body contract.
idIdentifier returned by the command.
get-pledge-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 PledgeDto.
| Field | Declared type | Nullable |
|---|---|---|
Id | Guid? | yes |
CustomerId | Guid | no |
CollateralId | Guid | no |
Status | int? | yes |
IsActive | bool? | yes |
NotaryPledgeNumber | string | no |
Amount | decimal? | yes |
NotaryTransactionNumber | string | no |
Description | string | no |
RemovalDate | DateTime? | 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 | Message |
|---|---|---|---|
ERR_CLLTRL_13 | 400 | COLLATERAL_NOT_FOUND | Collateral cannot be found. :{0} |
ERR_CLLTRL_19 | 400 | PLEDGE_NOT_FOUND | not published in this snapshot |
path Parameters
idpledgeIdget-pledge-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.
amountcollateralIdcustomerIddescriptionendDateidisActivenotaryPledgeNumbernotaryTransactionNumberremovalDatestartDatestatusPermitted values — validated against the pledge_status parameter. The service rejects any other value.
| Value | Token | Labels |
|---|---|---|
1 | Pre-pledge | ar: الالتزام المسبق |
2 | Pledge | ar: تعهد |
update-pledge
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_CLLTRL_13 | 400 | COLLATERAL_NOT_FOUND | Collateral cannot be found. :{0} |
ERR_CLLTRL_19 | 400 | PLEDGE_NOT_FOUND | not published in this snapshot |
path Parameters
idpledgeIdupdate-pledge › Request Body optional
amountcustomerIddescriptionendDateisActivenotaryPledgeNumbernotaryTransactionNumberremovalDatestartDatestatusPermitted values — validated against the pledge_status parameter.
| Value | Meaning |
|---|---|
1 | Pre-pledge |
2 | Pledge |
Permitted values — validated against the pledge_status parameter. The service rejects any other value.
| Value | Token | Labels |
|---|---|---|
1 | Pre-pledge | ar: الالتزام المسبق |
2 | Pledge | ar: تعهد |
update-pledge › 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-pledge
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_CLLTRL_13 | 400 | COLLATERAL_NOT_FOUND | Collateral cannot be found. :{0} |
ERR_CLLTRL_19 | 400 | PLEDGE_NOT_FOUND | not published in this snapshot |
path Parameters
idpledgeIddelete-pledge › 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-collateral-usage-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<CollateralUsageDto>.
| Field | Declared type | Nullable |
|---|---|---|
Id | Guid? | yes |
CollateralId | Guid? | yes |
UsageType | int? | yes |
LoanId | Guid? | yes |
Description | string | no |
Amount | decimal? | yes |
CurrencyNumber | string | no |
IsActive | bool? | yes |
UsageDate | DateTime? | yes |
Member names are the service's declaration names.
Error codes this operation is known to raise
| Code | Status | Meaning | Message |
|---|---|---|---|
ERR_CLLTRL_13 | 400 | COLLATERAL_NOT_FOUND | Collateral cannot be found. :{0} |
path Parameters
idquery Parameters
orderByorderSortpageIndexpageSizeget-collateral-usage-list › Responses
Success. An exact, uniquely bound route registration classifies this response as a collection.
create-customer-collateral-usage
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.
path Parameters
idcreate-customer-collateral-usage › Request Body
amountcurrencyNumberloanIdusageTypePermitted values — validated against the collateral_usage_type parameter.
| Value | Meaning |
|---|---|
1 | loan |
2 | limit |
Permitted values — validated against the collateral_usage_type parameter. The service rejects any other value.
| Value | Token | Labels |
|---|---|---|
1 | loan | en: loan · tr: kredi · ar: قرض |
2 | limit | en: limit · tr: limit · ar: حد |
descriptioncreate-customer-collateral-usage › Responses
Success. An exact, uniquely bound route registration declares the command-id envelope, so this schema is the code-backed body contract.
idIdentifier returned by the command.
get-collateral-usage-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 CollateralUsageDto.
| Field | Declared type | Nullable |
|---|---|---|
Id | Guid? | yes |
CollateralId | Guid? | yes |
UsageType | int? | yes |
LoanId | Guid? | yes |
Description | string | no |
Amount | decimal? | yes |
CurrencyNumber | string | no |
IsActive | bool? | yes |
UsageDate | DateTime? | yes |
Member names are the service's declaration names.
path Parameters
idcollateralUsageIdget-collateral-usage-by-id › Responses
Success. An exact, uniquely bound route registration classifies this response as a single-record.
update-customer-collateral-usage
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
path Parameters
idcollateralUsageIdupdate-customer-collateral-usage › 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.