assignments

Operations addressed under /assignments — 21 operations.

get-allotment-assignment-list

GET

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

/assignments

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

Field	Declared type	Nullable
`CustomerId`	`Guid`	no
`FinancialAnalysisId`	`Guid?`	yes
`AllotmentDate`	`DateTime`	no
`ValidityEndDate`	`DateTime`	no
`AllotmentAmount`	`decimal`	no
`ExternalCalculatedLimit`	`decimal?`	yes
`InternalCalculatedLimit`	`decimal?`	yes
`CurrencyNumber`	`string`	no
`AllotmentStatus`	`int`	no
`Collaterals`	`List<AllotmentCollateralDto>` (collection)	no
`Comments`	`List<AllotmentAssignmentCommentDto>` (collection)	no
`Details`	`List<AllotmentAssignmentDetailDto>` (collection)	no
`Products`	`List<AllotmentAssignmentProductDto>` (collection)	no

Member names are the service's declaration names.

get-allotment-assignment-list › query Parameters

object

orderBy

string

orderSort

string

pageIndex

integer · int32

pageSize

integer · int32

get-allotment-assignment-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.

allotmentAmount

number · decimal

allotmentDate

string · date-time

allotmentStatus

integer · int32

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

Value	Token	Labels
`1`	`Evaluating`	en: Evaluating · tr: Evaluating · ar: تقييم
`2`	`Rejected`	en: Rejected · tr: Rejected · ar: مرفوض
`3`	`Active`	tr: Aktif
`4`	`Frozen`	tr: Dondurulmuş
`5`	`Cancelled`	tr: İptal
`6`	`Expired`	tr: Vadesi Bitmiş

object[]

currencyNumber

string

customerId

string · uuid

object[]

financialAnalysisId

string · uuid

id

string · uuid

object[]

validityEndDate

string · date-time

GET/assignments

curl https://dg-sandbox.dgpays.com/allotment-service/assignments

Example Responses

[
  {
    "allotmentAmount": 0,
    "allotmentDate": "2024-08-25T15:00:00Z",
    "allotmentStatus": 0,
    "collaterals": [
      {
        "allotmentCollateralId": "00000000-0000-0000-0000-000000000000",
        "collateralAmount": {},
        "collateralId": "00000000-0000-0000-0000-000000000000"
      }
    ],
    "comments": [
      {
        "assignmentComment": "assignmentComment",
        "assignmentCommentId": "00000000-0000-0000-0000-000000000000",
        "commentDate": "2024-08-25T15:00:00Z",
        "userId": "00000000-0000-0000-0000-000000000000"
      }
    ],
    "currencyNumber": "currencyNumber",
    "customerId": "00000000-0000-0000-0000-000000000000",
    "details": [
      {
        "allotmentAssignmentDetailId": "00000000-0000-0000-0000-000000000000",
        "allotmentType": 0,
        "allotmentTypeAmount": 0
      }
    ],
    "financialAnalysisId": "00000000-0000-0000-0000-000000000000",
    "id": "00000000-0000-0000-0000-000000000000",
    "products": [
      {
        "allotmentAssignmentProductId": "00000000-0000-0000-0000-000000000000",
        "allotmentDate": "2024-08-25T15:00:00Z",
        "allotmentProductId": "00000000-0000-0000-0000-000000000000",
        "fields": [
          {
            "allotmentAssignmentProductFieldId": "00000000-0000-0000-0000-000000000000",
            "allotmentProductFieldId": "00000000-0000-0000-0000-000000000000",
            "fieldValue": "fieldValue"
          }
        ],
        "productAllotmentAmount": 0,
        "productCollaterals": [
          {
            "allotmentAssignmentProductCollateralId": "00000000-0000-0000-0000-000000000000",
            "collateralId": "00000000-0000-0000-0000-000000000000",
            "maxAmount": 0,
            "minAmount": 0,
            "operand": 0
          }
        ],
        "validityEndDate": "2024-08-25T15:00:00Z"
      }
    ],
    "validityEndDate": "2024-08-25T15:00:00Z"
  }
]

json

application/json

create-allotment-assignment

POST

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

/assignments

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_ALLTMNT_10`	400	`CUSTOMER_HAS_AN_ALLOTMENT_FOR_CURRENT_DATE`	Customer has already an allotment which contains the currenct date.
`ERR_ALLTMNT_16`	400	`ALLOTMENT_TYPE_MUST_BE_UNQUIE_FOR_EACH_ASSIGNMENT`	Each allotment type can have only one assignment.
`ERR_ALLTMNT_18`	400	`ASSIGNMENT_END_DATE_CANNOT_BE_SMALLER_THAN_PRODUCT_END_DATE`	Validity end date of an assignment on product cannot be further than validity end date of customers allotment.
`ERR_ALLTMNT_20`	400	`CUSTOMER_HAS_AN_ALLOTMENT_FOR_CURRENT_DATE_AND_PRODUCT`	Customer has already an allotment on the given product: `{0}` which contains the currenct date.
`ERR_ALLTMNT_9`	400	`ALLOTMENT_TYPE_AMOUNT_MUST_BE_LESS_THAN_ALLOTMENT_AMOUNT`	Allotment Type Amount cannot be greater than the Allotment Amount.

create-allotment-assignment › Request Body

allotmentAmount

number · decimal · required

currencyNumber

string · required

customerId

string · uuid · required

object[] · required

financialAnalysisId

string · uuid · required

object[] · required

calculatedIncome

number · decimal

object[]

externalCalculatedLimit

number · decimal

internalCalculatedLimit

number · decimal

validityDay

integer · int32

create-allotment-assignment › 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/assignments

curl https://dg-sandbox.dgpays.com/allotment-service/assignments \
  --request POST \
  --header 'Content-Type: application/json' \
  --data '{
  "allotmentAmount": 0,
  "calculatedIncome": 0,
  "collaterals": [
    {
      "collateralAmount": 0,
      "collateralId": ""
    }
  ],
  "comments": [
    {
      "assignmentComment": "",
      "commentDate": "",
      "userId": ""
    }
  ],
  "currencyNumber": "",
  "customerId": "",
  "details": [
    {
      "allotmentType": 0,
      "allotmentTypeAmount": 0
    }
  ],
  "externalCalculatedLimit": 0,
  "financialAnalysisId": "",
  "internalCalculatedLimit": 0,
  "products": [
    {
      "allotmentProductId": "",
      "fields": [
        {
          "allotmentProductFieldId": "",
          "fieldValue": ""
        }
      ],
      "productAllotmentAmount": 0,
      "productCollaterals": [
        {
          "collateralId": "",
          "maxAmount": 0,
          "minAmount": 0,
          "operand": 0
        }
      ],
      "validityDay": 0
    }
  ],
  "validityDay": 0
}'

Example Request Body

{
  "allotmentAmount": 0,
  "calculatedIncome": 0,
  "collaterals": [
    {
      "collateralAmount": 0,
      "collateralId": ""
    }
  ],
  "comments": [
    {
      "assignmentComment": "",
      "commentDate": "",
      "userId": ""
    }
  ],
  "currencyNumber": "",
  "customerId": "",
  "details": [
    {
      "allotmentType": 0,
      "allotmentTypeAmount": 0
    }
  ],
  "externalCalculatedLimit": 0,
  "financialAnalysisId": "",
  "internalCalculatedLimit": 0,
  "products": [
    {
      "allotmentProductId": "",
      "fields": [
        {
          "allotmentProductFieldId": "",
          "fieldValue": ""
        }
      ],
      "productAllotmentAmount": 0,
      "productCollaterals": [
        {
          "collateralId": "",
          "maxAmount": 0,
          "minAmount": 0,
          "operand": 0
        }
      ],
      "validityDay": 0
    }
  ],
  "validityDay": 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-allotment-assignment-by-customer-id

GET

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

/assignments/by-customer-id/{customerId}

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

Field	Declared type	Nullable
`CustomerId`	`Guid`	no
`FinancialAnalysisId`	`Guid?`	yes
`AllotmentDate`	`DateTime`	no
`ValidityEndDate`	`DateTime`	no
`AllotmentAmount`	`decimal`	no
`ExternalCalculatedLimit`	`decimal?`	yes
`InternalCalculatedLimit`	`decimal?`	yes
`CurrencyNumber`	`string`	no
`AllotmentStatus`	`int`	no
`Collaterals`	`List<AllotmentCollateralDto>` (collection)	no
`Comments`	`List<AllotmentAssignmentCommentDto>` (collection)	no
`Details`	`List<AllotmentAssignmentDetailDto>` (collection)	no
`Products`	`List<AllotmentAssignmentProductDto>` (collection)	no

Member names are the service's declaration names.

get-allotment-assignment-by-customer-id › path Parameters

customerId

string · uuid · required

get-allotment-assignment-by-customer-id › query Parameters

object

orderBy

string

orderSort

string

pageIndex

integer · int32

pageSize

integer · int32

get-allotment-assignment-by-customer-id › Responses

object[]

Array of catalog-declared response records.

allotmentAmount

number · decimal

allotmentDate

string · date-time

allotmentStatus

integer · int32

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

Value	Token	Labels
`1`	`Evaluating`	en: Evaluating · tr: Evaluating · ar: تقييم
`2`	`Rejected`	en: Rejected · tr: Rejected · ar: مرفوض
`3`	`Active`	tr: Aktif
`4`	`Frozen`	tr: Dondurulmuş
`5`	`Cancelled`	tr: İptal
`6`	`Expired`	tr: Vadesi Bitmiş

object[]

currencyNumber

string

customerId

string · uuid

object[]

externalCalculatedLimit

number · decimal

financialAnalysisId

string · uuid

id

string · uuid

internalCalculatedLimit

number · decimal

object[]

validityEndDate

string · date-time

GET/assignments/by-customer-id/{customerId}

curl https://dg-sandbox.dgpays.com/allotment-service/assignments/by-customer-id/:customerId

Example Responses

[
  {
    "allotmentAmount": 0,
    "allotmentDate": "2024-08-25T15:00:00Z",
    "allotmentStatus": 0,
    "collaterals": [
      {
        "allotmentCollateralId": "00000000-0000-0000-0000-000000000000",
        "collateralAmount": 0,
        "collateralId": "00000000-0000-0000-0000-000000000000"
      }
    ],
    "comments": [
      {
        "assignmentComment": "assignmentComment",
        "assignmentCommentId": "00000000-0000-0000-0000-000000000000",
        "commentDate": "2024-08-25T15:00:00Z",
        "userId": "00000000-0000-0000-0000-000000000000"
      }
    ],
    "currencyNumber": "currencyNumber",
    "customerId": "00000000-0000-0000-0000-000000000000",
    "details": [
      {
        "allotmentAssignmentDetailId": "00000000-0000-0000-0000-000000000000",
        "allotmentType": 0,
        "allotmentTypeAmount": 0
      }
    ],
    "externalCalculatedLimit": 0,
    "financialAnalysisId": "00000000-0000-0000-0000-000000000000",
    "id": "00000000-0000-0000-0000-000000000000",
    "internalCalculatedLimit": 0,
    "products": [
      {
        "allotmentAssignmentProductId": "00000000-0000-0000-0000-000000000000",
        "allotmentDate": "2024-08-25T15:00:00Z",
        "allotmentProductId": "00000000-0000-0000-0000-000000000000",
        "fields": [
          {
            "allotmentAssignmentProductFieldId": "00000000-0000-0000-0000-000000000000",
            "allotmentProductFieldId": "00000000-0000-0000-0000-000000000000",
            "fieldValue": "fieldValue"
          }
        ],
        "productAllotmentAmount": 0,
        "productCollaterals": [
          {
            "allotmentAssignmentProductCollateralId": "00000000-0000-0000-0000-000000000000",
            "collateralId": "00000000-0000-0000-0000-000000000000",
            "maxAmount": 0,
            "minAmount": 0,
            "operand": 0
          }
        ],
        "validityEndDate": "2024-08-25T15:00:00Z"
      }
    ],
    "validityEndDate": "2024-08-25T15:00:00Z"
  }
]

json

application/json

get-customer-allotment-assignment-by-product-id

GET

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

/assignments/by-customer-id/{customerId}/products/by-allotment-product/{allotmentProductId}

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

Field	Declared type	Nullable
`CustomerId`	`Guid`	no
`FinancialAnalysisId`	`Guid?`	yes
`AllotmentAmount`	`decimal`	no
`CurrencyNumber`	`string`	no
`AllotmentAssignmentProductId`	`Guid`	no
`AllotmentProductId`	`Guid`	no
`ProductAllotmentDate`	`DateTime`	no
`ProductValidityEndDate`	`DateTime`	no
`ProductAllotmentAmount`	`decimal`	no
`AllotmentStatus`	`int`	no
`Details`	`List<AllotmentAssignmentDetailDto>` (collection)	no
`Fields`	`List<AssignmentProductFieldDto>` (collection)	no

Member names are the service's declaration names.

get-customer-allotment-assignment-by-product-id › path Parameters

customerId

string · uuid · required

allotmentProductId

string · uuid · required

get-customer-allotment-assignment-by-product-id › query Parameters

date

string · date

object

get-customer-allotment-assignment-by-product-id › Responses

allotmentAmount

number · decimal

allotmentAssignmentProductId

string · uuid

allotmentProductId

string · uuid

allotmentStatus

integer · int32

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

Value	Token	Labels
`1`	`Evaluating`	en: Evaluating · tr: Evaluating · ar: تقييم
`2`	`Rejected`	en: Rejected · tr: Rejected · ar: مرفوض
`3`	`Active`	tr: Aktif
`4`	`Frozen`	tr: Dondurulmuş
`5`	`Cancelled`	tr: İptal
`6`	`Expired`	tr: Vadesi Bitmiş

currencyNumber

string

customerId

string · uuid

object[]

financialAnalysisId

string · uuid

id

string · uuid

productAllotmentAmount

number · decimal

productAllotmentDate

string · date-time

productValidityEndDate

string · date-time

GET/assignments/by-customer-id/{customerId}/products/by-allotment-product/{allotmentProductId}

curl https://dg-sandbox.dgpays.com/allotment-service/assignments/by-customer-id/:customerId/products/by-allotment-product/:allotmentProductId

Example Responses

{
  "allotmentAmount": 0,
  "allotmentAssignmentProductId": "00000000-0000-0000-0000-000000000000",
  "allotmentProductId": "00000000-0000-0000-0000-000000000000",
  "allotmentStatus": 0,
  "currencyNumber": "currencyNumber",
  "customerId": "00000000-0000-0000-0000-000000000000",
  "details": [
    {
      "allotmentAssignmentDetailId": "00000000-0000-0000-0000-000000000000",
      "allotmentType": 0,
      "allotmentTypeAmount": 0
    }
  ],
  "fields": [
    {
      "allotmentAssignmentProductFieldId": "00000000-0000-0000-0000-000000000000",
      "allotmentProductFieldId": "00000000-0000-0000-0000-000000000000",
      "fieldValue": "fieldValue"
    }
  ],
  "financialAnalysisId": "00000000-0000-0000-0000-000000000000",
  "id": "00000000-0000-0000-0000-000000000000",
  "productAllotmentAmount": 0,
  "productAllotmentDate": "2024-08-25T15:00:00Z",
  "productValidityEndDate": "2024-08-25T15:00:00Z"
}

json

application/json

get-allotment-assignment-by-id

GET

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

/assignments/{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 AllotmentAssignmentDto.

Field	Declared type	Nullable
`CustomerId`	`Guid`	no
`FinancialAnalysisId`	`Guid?`	yes
`AllotmentDate`	`DateTime`	no
`ValidityEndDate`	`DateTime`	no
`AllotmentAmount`	`decimal`	no
`ExternalCalculatedLimit`	`decimal?`	yes
`InternalCalculatedLimit`	`decimal?`	yes
`CurrencyNumber`	`string`	no
`AllotmentStatus`	`int`	no
`Collaterals`	`List<AllotmentCollateralDto>` (collection)	no
`Comments`	`List<AllotmentAssignmentCommentDto>` (collection)	no
`Details`	`List<AllotmentAssignmentDetailDto>` (collection)	no
`Products`	`List<AllotmentAssignmentProductDto>` (collection)	no

Member names are the service's declaration names.

Error codes this operation is known to raise

Code	Status	Meaning	Message
`ERR_ALLTMNT_11`	400	`ALLOTMENT_ASSIGNMENT_MUST_BE_EXIST`	Allotment assignment is cannot be found with the given: `{0}`.

get-allotment-assignment-by-id › path Parameters

id

string · uuid · required

get-allotment-assignment-by-id › Responses

allotmentAmount

number · decimal

allotmentDate

string · date-time

allotmentStatus

integer · int32

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

Value	Token	Labels
`1`	`Evaluating`	en: Evaluating · tr: Evaluating · ar: تقييم
`2`	`Rejected`	en: Rejected · tr: Rejected · ar: مرفوض
`3`	`Active`	tr: Aktif
`4`	`Frozen`	tr: Dondurulmuş
`5`	`Cancelled`	tr: İptal
`6`	`Expired`	tr: Vadesi Bitmiş

object[]

currencyNumber

string

customerId

string · uuid

object[]

financialAnalysisId

string · uuid

id

string · uuid

object[]

validityEndDate

string · date-time

GET/assignments/{id}

curl https://dg-sandbox.dgpays.com/allotment-service/assignments/:id

Example Responses

{
  "allotmentAmount": 0,
  "allotmentDate": "2024-08-25T15:00:00Z",
  "allotmentStatus": 0,
  "collaterals": [
    {
      "allotmentCollateralId": "00000000-0000-0000-0000-000000000000",
      "collateralAmount": 0,
      "collateralId": "00000000-0000-0000-0000-000000000000"
    }
  ],
  "comments": [
    {
      "assignmentComment": "assignmentComment",
      "assignmentCommentId": "00000000-0000-0000-0000-000000000000",
      "commentDate": "2024-08-25T15:00:00Z",
      "userId": "00000000-0000-0000-0000-000000000000"
    }
  ],
  "currencyNumber": "currencyNumber",
  "customerId": "00000000-0000-0000-0000-000000000000",
  "details": [
    {
      "allotmentAssignmentDetailId": "00000000-0000-0000-0000-000000000000",
      "allotmentType": 0,
      "allotmentTypeAmount": 0
    }
  ],
  "financialAnalysisId": "00000000-0000-0000-0000-000000000000",
  "id": "00000000-0000-0000-0000-000000000000",
  "products": [
    {
      "allotmentAssignmentProductId": "00000000-0000-0000-0000-000000000000",
      "allotmentDate": "2024-08-25T15:00:00Z",
      "allotmentProductId": "00000000-0000-0000-0000-000000000000",
      "fields": [
        {
          "allotmentAssignmentProductFieldId": "00000000-0000-0000-0000-000000000000",
          "allotmentProductFieldId": "00000000-0000-0000-0000-000000000000",
          "fieldValue": "fieldValue"
        }
      ],
      "productAllotmentAmount": 0,
      "productCollaterals": [
        {
          "allotmentAssignmentProductCollateralId": "00000000-0000-0000-0000-000000000000",
          "collateralId": "00000000-0000-0000-0000-000000000000",
          "maxAmount": 0,
          "minAmount": 0,
          "operand": 0
        }
      ],
      "validityEndDate": "2024-08-25T15:00:00Z"
    }
  ],
  "validityEndDate": "2024-08-25T15:00:00Z"
}

json

application/json

update-allotment-assignment

PUT

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

/assignments/{id}

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_ALLTMNT_10`	400	`CUSTOMER_HAS_AN_ALLOTMENT_FOR_CURRENT_DATE`	Customer has already an allotment which contains the currenct date.
`ERR_ALLTMNT_11`	400	`ALLOTMENT_ASSIGNMENT_MUST_BE_EXIST`	Allotment assignment is cannot be found with the given: `{0}`.
`ERR_ALLTMNT_18`	400	`ASSIGNMENT_END_DATE_CANNOT_BE_SMALLER_THAN_PRODUCT_END_DATE`	Validity end date of an assignment on product cannot be further than validity end date of customers allotment.
`ERR_ALLTMNT_9`	400	`ALLOTMENT_TYPE_AMOUNT_MUST_BE_LESS_THAN_ALLOTMENT_AMOUNT`	Allotment Type Amount cannot be greater than the Allotment Amount.

update-allotment-assignment › path Parameters

id

string · uuid · required

update-allotment-assignment › Request Body

allotmentAmount

number · decimal · required

validityEndDate

string · date-time · required

calculatedIncome

number · decimal

externalCalculatedLimit

number · decimal

internalCalculatedLimit

number · decimal

update-allotment-assignment › 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

create-allotment-assignment-collateral

POST

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

/assignments/{id}/collaterals

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_ALLTMNT_11`	400	`ALLOTMENT_ASSIGNMENT_MUST_BE_EXIST`	Allotment assignment is cannot be found with the given: `{0}`.

create-allotment-assignment-collateral › path Parameters

id

string · uuid · required

create-allotment-assignment-collateral › Request Body

object[] · required

create-allotment-assignment-collateral › Responses

No data returned

delete-allotment-assignment-collateral

DELETE

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

/assignments/{id}/collaterals/{allotmentCollateralId}

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_ALLTMNT_11`	400	`ALLOTMENT_ASSIGNMENT_MUST_BE_EXIST`	Allotment assignment is cannot be found with the given: `{0}`.
`ERR_ALLTMNT_21`	400	`ALLOTMENT_COLLATERAL_MUST_BE_EXIST`	Allotment collateral is cannot be found with the given allotment collateral:`{0}`.
`ERR_ALLTMNT_22`	400	`ALLOTMENT_COLLATERAL_MUST_NOT_BE_USED_IN_ASSIGNMENT_PRODUCT`	Allotment collateral cannot be deleted. It is used in allotment assignment product.

delete-allotment-assignment-collateral › path Parameters

id

string · uuid · required

allotmentCollateralId

string · uuid · required

delete-allotment-assignment-collateral › Responses

No data returned

get-allotment-assignment-comment-list

GET

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

/assignments/{id}/comments

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

Field	Declared type	Nullable
`AssignmentCommentId`	`Guid`	no
`AssignmentComment`	`string`	no
`UserId`	`Guid`	no
`CommentDate`	`DateTime`	no

Member names are the service's declaration names.

get-allotment-assignment-comment-list › path Parameters

id

string · uuid · required

get-allotment-assignment-comment-list › Responses

object[]

Array of catalog-declared response records.

assignmentComment

string

assignmentCommentId

string · uuid

commentDate

string · date-time

userId

string · uuid

create-allotment-assignment-comment

POST

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

/assignments/{id}/comments

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_ALLTMNT_11`	400	`ALLOTMENT_ASSIGNMENT_MUST_BE_EXIST`	Allotment assignment is cannot be found with the given: `{0}`.

create-allotment-assignment-comment › path Parameters

id

string · uuid · required

create-allotment-assignment-comment › Request Body

assignmentComment

string · required

commentDate

string · date-time · required

userId

string · uuid · required

create-allotment-assignment-comment › Responses

id

string · uuid

update-allotment-assignment-comment

PUT

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

/assignments/{id}/comments/{assignmentCommentId}

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_ALLTMNT_11`	400	`ALLOTMENT_ASSIGNMENT_MUST_BE_EXIST`	Allotment assignment is cannot be found with the given: `{0}`.
`ERR_ALLTMNT_17`	400	`ASSIGNMENT_COMMENT_MUST_BE_EXITS`	Allotment assignment comment is cannot be found with the given assignment comment: `{0}`.

update-allotment-assignment-comment › path Parameters

id

string · uuid · required

assignmentCommentId

string · uuid · required

update-allotment-assignment-comment › Request Body

assignmentComment

string · required

update-allotment-assignment-comment › Responses

No data returned

delete-allotment-assignment-comment

DELETE

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

/assignments/{id}/comments/{assignmentCommentId}

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_ALLTMNT_11`	400	`ALLOTMENT_ASSIGNMENT_MUST_BE_EXIST`	Allotment assignment is cannot be found with the given: `{0}`.
`ERR_ALLTMNT_17`	400	`ASSIGNMENT_COMMENT_MUST_BE_EXITS`	Allotment assignment comment is cannot be found with the given assignment comment: `{0}`.

delete-allotment-assignment-comment › path Parameters

id

string · uuid · required

assignmentCommentId

string · uuid · required

delete-allotment-assignment-comment › Responses

No data returned

create-allotment-assignment-detail

POST

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

/assignments/{id}/details

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_ALLTMNT_11`	400	`ALLOTMENT_ASSIGNMENT_MUST_BE_EXIST`	Allotment assignment is cannot be found with the given: `{0}`.
`ERR_ALLTMNT_16`	400	`ALLOTMENT_TYPE_MUST_BE_UNQUIE_FOR_EACH_ASSIGNMENT`	Each allotment type can have only one assignment.
`ERR_ALLTMNT_9`	400	`ALLOTMENT_TYPE_AMOUNT_MUST_BE_LESS_THAN_ALLOTMENT_AMOUNT`	Allotment Type Amount cannot be greater than the Allotment Amount.

create-allotment-assignment-detail › path Parameters

id

string · uuid · required

create-allotment-assignment-detail › Request Body

object[] · required

create-allotment-assignment-detail › Responses

No data returned

update-allotment-assignment-detail

PUT

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

/assignments/{id}/details/{allotmentAssignmentDetailId}

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_ALLTMNT_11`	400	`ALLOTMENT_ASSIGNMENT_MUST_BE_EXIST`	Allotment assignment is cannot be found with the given: `{0}`.
`ERR_ALLTMNT_16`	400	`ALLOTMENT_TYPE_MUST_BE_UNQUIE_FOR_EACH_ASSIGNMENT`	Each allotment type can have only one assignment.
`ERR_ALLTMNT_19`	400	`PRODUCT_ALLOTMENT_AMOUNT_CANNOT_BE_GREATER_THAN_RELATED_TYPE_AMOUNT`	Product Allotment Amount cannot be greater than the related Allotment Type Amount.
`ERR_ALLTMNT_28`	400	`ASSIGNMENT_DETAIL_MUST_BE_EXIST`	Allotment assignment detail is cannot be found with the given allotment detail: `{0}`.
`ERR_ALLTMNT_9`	400	`ALLOTMENT_TYPE_AMOUNT_MUST_BE_LESS_THAN_ALLOTMENT_AMOUNT`	Allotment Type Amount cannot be greater than the Allotment Amount.

update-allotment-assignment-detail › path Parameters

id

string · uuid · required

allotmentAssignmentDetailId

string · uuid · required

update-allotment-assignment-detail › Request Body

allotmentType

integer · int32 · required

Permitted values — validated against the allotment_type parameter.

Value	Meaning
`1`	Cash
`2`	Non-Cash

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

Value	Token	Labels
`1`	`Cash`	tr: Nakdi
`2`	`Non-Cash`	tr: GayriNakdi

allotmentTypeAmount

number · decimal · required

update-allotment-assignment-detail › Responses

No data returned

update-allotment-assignment-with-product-detail

PUT

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

/assignments/{id}/product-details

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_ALLTMNT_10`	400	`CUSTOMER_HAS_AN_ALLOTMENT_FOR_CURRENT_DATE`	Customer has already an allotment which contains the currenct date.
`ERR_ALLTMNT_11`	400	`ALLOTMENT_ASSIGNMENT_MUST_BE_EXIST`	Allotment assignment is cannot be found with the given: `{0}`.
`ERR_ALLTMNT_18`	400	`ASSIGNMENT_END_DATE_CANNOT_BE_SMALLER_THAN_PRODUCT_END_DATE`	Validity end date of an assignment on product cannot be further than validity end date of customers allotment.
`ERR_ALLTMNT_19`	400	`PRODUCT_ALLOTMENT_AMOUNT_CANNOT_BE_GREATER_THAN_RELATED_TYPE_AMOUNT`	Product Allotment Amount cannot be greater than the related Allotment Type Amount.
`ERR_ALLTMNT_24`	400	`ASSIGNMENT_PRODUCT_MUST_BE_EXIST`	Allotment assignment product is cannot be found with given allotment assignment product:`{0}`.
`ERR_ALLTMNT_28`	400	`ASSIGNMENT_DETAIL_MUST_BE_EXIST`	Allotment assignment detail is cannot be found with the given allotment detail: `{0}`.
`ERR_ALLTMNT_9`	400	`ALLOTMENT_TYPE_AMOUNT_MUST_BE_LESS_THAN_ALLOTMENT_AMOUNT`	Allotment Type Amount cannot be greater than the Allotment Amount.

update-allotment-assignment-with-product-detail › path Parameters

id

string · uuid · required

update-allotment-assignment-with-product-detail › Request Body

allotmentAmount

number · decimal · required

object[] · required

validityEndDate

string · date-time · required

calculatedIncome

number · decimal

externalCalculatedLimit

number · decimal

internalCalculatedLimit

number · decimal

update-allotment-assignment-with-product-detail › Responses

No data returned

PUT/assignments/{id}/product-details

curl https://dg-sandbox.dgpays.com/allotment-service/assignments/:id/product-details \
  --request PUT \
  --header 'Content-Type: application/json' \
  --data '{
  "allotmentAmount": 0,
  "assignmentDetails": [
    {
      "allotmentAssignmentDetailId": "",
      "allotmentTypeAmount": 0
    }
  ],
  "assignmentProducts": [
    {
      "allotmentAssignmentProductId": "",
      "productAllotmentAmount": 0,
      "validityEndDate": ""
    }
  ],
  "calculatedIncome": 0,
  "externalCalculatedLimit": 0,
  "internalCalculatedLimit": 0,
  "validityEndDate": ""
}'

Example Request Body

{
  "allotmentAmount": 0,
  "assignmentDetails": [
    {
      "allotmentAssignmentDetailId": "",
      "allotmentTypeAmount": 0
    }
  ],
  "assignmentProducts": [
    {
      "allotmentAssignmentProductId": "",
      "productAllotmentAmount": 0,
      "validityEndDate": ""
    }
  ],
  "calculatedIncome": 0,
  "externalCalculatedLimit": 0,
  "internalCalculatedLimit": 0,
  "validityEndDate": ""
}

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

get-allotment-assignment-product-list

GET

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

/assignments/{id}/products

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

Field	Declared type	Nullable
`AllotmentAssignmentProductId`	`Guid`	no
`AllotmentProductId`	`Guid`	no
`AllotmentDate`	`DateTime`	no
`ValidityEndDate`	`DateTime`	no
`ProductAllotmentAmount`	`decimal`	no
`Fields`	`List<AssignmentProductFieldDto>` (collection)	no
`ProductCollaterals`	`List<AssignmentProductCollateralDto>` (collection)	no

Member names are the service's declaration names.

Error codes this operation is known to raise

Code	Status	Meaning	Message
`ERR_ALLTMNT_11`	400	`ALLOTMENT_ASSIGNMENT_MUST_BE_EXIST`	Allotment assignment is cannot be found with the given: `{0}`.

get-allotment-assignment-product-list › path Parameters

id

string · uuid · required

get-allotment-assignment-product-list › query Parameters

object

orderBy

string

orderSort

string

pageIndex

integer · int32

pageSize

integer · int32

get-allotment-assignment-product-list › Responses

object[]

Array of catalog-declared response records.

allotmentAssignmentProductId

string · uuid

allotmentDate

string · date-time

allotmentProductId

string · uuid

object[]

productAllotmentAmount

number · decimal

object[]

validityEndDate

string · date-time

GET/assignments/{id}/products

curl https://dg-sandbox.dgpays.com/allotment-service/assignments/:id/products

Example Responses

[
  {
    "allotmentAssignmentProductId": "00000000-0000-0000-0000-000000000000",
    "allotmentDate": "2024-08-25T15:00:00Z",
    "allotmentProductId": "00000000-0000-0000-0000-000000000000",
    "fields": [
      {
        "allotmentAssignmentProductFieldId": "00000000-0000-0000-0000-000000000000",
        "allotmentProductFieldId": "00000000-0000-0000-0000-000000000000",
        "fieldValue": "fieldValue"
      }
    ],
    "productAllotmentAmount": 0,
    "productCollaterals": [
      {
        "allotmentAssignmentProductCollateralId": "00000000-0000-0000-0000-000000000000",
        "collateralId": "00000000-0000-0000-0000-000000000000",
        "maxAmount": 0,
        "minAmount": 0,
        "operand": 0
      }
    ],
    "validityEndDate": "2024-08-25T15:00:00Z"
  }
]

json

application/json

create-allotment-assignment-product

POST

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

/assignments/{id}/products

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_ALLTMNT_11`	400	`ALLOTMENT_ASSIGNMENT_MUST_BE_EXIST`	Allotment assignment is cannot be found with the given: `{0}`.
`ERR_ALLTMNT_18`	400	`ASSIGNMENT_END_DATE_CANNOT_BE_SMALLER_THAN_PRODUCT_END_DATE`	Validity end date of an assignment on product cannot be further than validity end date of customers allotment.
`ERR_ALLTMNT_20`	400	`CUSTOMER_HAS_AN_ALLOTMENT_FOR_CURRENT_DATE_AND_PRODUCT`	Customer has already an allotment on the given product: `{0}` which contains the currenct date.

create-allotment-assignment-product › path Parameters

id

string · uuid · required

create-allotment-assignment-product › Request Body

object[] · required

create-allotment-assignment-product › Responses

No data returned

POST/assignments/{id}/products

curl https://dg-sandbox.dgpays.com/allotment-service/assignments/:id/products \
  --request POST \
  --header 'Content-Type: application/json' \
  --data '{
  "products": [
    {
      "allotmentProductId": "",
      "fields": [
        {
          "allotmentProductFieldId": "",
          "fieldValue": ""
        }
      ],
      "productAllotmentAmount": 0,
      "productCollaterals": [
        {
          "collateralId": "",
          "maxAmount": 0,
          "minAmount": 0,
          "operand": 0
        }
      ],
      "validityDay": 0
    }
  ]
}'

Example Request Body

{
  "products": [
    {
      "allotmentProductId": "",
      "fields": [
        {
          "allotmentProductFieldId": "",
          "fieldValue": ""
        }
      ],
      "productAllotmentAmount": 0,
      "productCollaterals": [
        {
          "collateralId": "",
          "maxAmount": 0,
          "minAmount": 0,
          "operand": 0
        }
      ],
      "validityDay": 0
    }
  ]
}

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

update-allotment-assignment-product

PUT

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

/assignments/{id}/products/{allotmentAssignmentProductId}

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_ALLTMNT_11`	400	`ALLOTMENT_ASSIGNMENT_MUST_BE_EXIST`	Allotment assignment is cannot be found with the given: `{0}`.
`ERR_ALLTMNT_18`	400	`ASSIGNMENT_END_DATE_CANNOT_BE_SMALLER_THAN_PRODUCT_END_DATE`	Validity end date of an assignment on product cannot be further than validity end date of customers allotment.
`ERR_ALLTMNT_19`	400	`PRODUCT_ALLOTMENT_AMOUNT_CANNOT_BE_GREATER_THAN_RELATED_TYPE_AMOUNT`	Product Allotment Amount cannot be greater than the related Allotment Type Amount.
`ERR_ALLTMNT_24`	400	`ASSIGNMENT_PRODUCT_MUST_BE_EXIST`	Allotment assignment product is cannot be found with given allotment assignment product:`{0}`.

update-allotment-assignment-product › path Parameters

id

string · uuid · required

allotmentAssignmentProductId

string · uuid · required

update-allotment-assignment-product › Request Body

productAllotmentAmount

number · decimal · required

validityEndDate

string · date-time · required

update-allotment-assignment-product › Responses

No data returned

create-allotment-assignment-product-collateral

POST

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

/assignments/{id}/products/{allotmentAssignmentProductId}/collaterals

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_ALLTMNT_11`	400	`ALLOTMENT_ASSIGNMENT_MUST_BE_EXIST`	Allotment assignment is cannot be found with the given: `{0}`.
`ERR_ALLTMNT_12`	400	`COLLATERAL_MUST_BE_RELATED_TO_ASSIGNMENT`	Collateral is cannot be found in Assignment Collaterals with given:`{0}`.
`ERR_ALLTMNT_13`	400	`COLLATERAL_MUST_BE_UNIQUE_FOR_PRODUCT`	It is not allowed to relate one collateral:`{0}` to more than one allotment product assignment.
`ERR_ALLTMNT_24`	400	`ASSIGNMENT_PRODUCT_MUST_BE_EXIST`	Allotment assignment product is cannot be found with given allotment assignment product:`{0}`.
`ERR_ALLTMNT_25`	400	`COLLATERAL_AMOUNT_CANNOT_BE_EXCEEDED`	maxAmount cannot be greater than the collateralAmount. Collateral:`{0}`.

create-allotment-assignment-product-collateral › path Parameters

id

string · uuid · required

allotmentAssignmentProductId

string · uuid · required

create-allotment-assignment-product-collateral › Request Body

object[] · required

create-allotment-assignment-product-collateral › Responses

No data returned

POST/assignments/{id}/products/{allotmentAssignmentProductId}/collaterals

curl https://dg-sandbox.dgpays.com/allotment-service/assignments/:id/products/:allotmentAssignmentProductId/collaterals \
  --request POST \
  --header 'Content-Type: application/json' \
  --data '{
  "productCollaterals": [
    {
      "collateralId": "",
      "maxAmount": 0,
      "minAmount": 0,
      "operand": 0
    }
  ]
}'

Example Request Body

{
  "productCollaterals": [
    {
      "collateralId": "",
      "maxAmount": 0,
      "minAmount": 0,
      "operand": 0
    }
  ]
}

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

update-allotment-assignment-status

PUT

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

/assignments/{id}/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_ALLTMNT_11`	400	`ALLOTMENT_ASSIGNMENT_MUST_BE_EXIST`	Allotment assignment is cannot be found with the given: `{0}`.

update-allotment-assignment-status › path Parameters

id

string · uuid · required

update-allotment-assignment-status › Request Body

allotmentStatus

integer · int32 · required

Permitted values — validated against the allotment_status parameter.

Value	Meaning
`1`	Evaluating
`2`	Rejected
`3`	Active
`4`	Frozen
`5`	Cancelled
`6`	Expired

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

Value	Token	Labels
`1`	`Evaluating`	en: Evaluating · tr: Evaluating · ar: تقييم
`2`	`Rejected`	en: Rejected · tr: Rejected · ar: مرفوض
`3`	`Active`	tr: Aktif
`4`	`Frozen`	tr: Dondurulmuş
`5`	`Cancelled`	tr: İptal
`6`	`Expired`	tr: Vadesi Bitmiş

update-allotment-assignment-status › Responses

No data returned

Update Allotment Assignment Successful Video Call Date

PUT

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

/assignments/{id}/succ-vid-call-date

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

Invokes the update-allotment-assignment-successful-vid-call-date service definition through PUT /assignments/{id}/succ-vid-call-date.

Turkish display name: Tahsisat Ataması Başarılı Video Görüşme Tarihi Güncellemesi

Error codes this operation is known to raise

Code	Status	Meaning	Message
`ERR_ALLTMNT_11`	400	`ALLOTMENT_ASSIGNMENT_MUST_BE_EXIST`	Allotment assignment is cannot be found with the given: `{0}`.

Update Allotment Assignment Successful Video Call Date › path Parameters

id

string · uuid · required

Update Allotment Assignment Successful Video Call Date › Responses

No data returned

batch-catalog