loans--general

Operations addressed under /loans — 79 operations.

Rendered section: This page contains the general 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-loan-list

GET

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

/loans

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

Field	Declared type	Nullable
`Id`	`Guid?`	yes
`CustomerId`	`Guid?`	yes
`ProposalId`	`Guid?`	yes
`CustomerApplicationId`	`Guid?`	yes
`CustomerAccountId`	`Guid?`	yes
`LoanProductId`	`Guid`	no
`LoanNumber`	`string`	no
`FundingSource`	`int?`	yes
`OrganizationId`	`Guid?`	yes
`CurrencyNumber`	`string`	no
`Amount`	`decimal?`	yes
`LoanDate`	`DateTime?`	yes
`Status`	`int?`	yes
`ExchangeRate`	`decimal?`	yes
`AccountingEntryId`	`Guid?`	yes
`LoanCloseDate`	`DateTime?`	yes
`LoanCloseType`	`int?`	yes
`CustomerRiskId`	`Guid?`	yes
`AllotmentQueryId`	`Guid?`	yes
`ParentLoanId`	`Guid?`	yes
`CancelDate`	`DateTime?`	yes
`CancelReason`	`int?`	yes
`CancelDescription`	`string`	no
`LatePenaltyRate`	`decimal?`	yes
`EarlyPaymentDiscountRate`	`decimal?`	yes
`AccrualStatus`	`int?`	yes
`ExternalReference`	`string`	no
`ExternalTransactionid`	`string`	no
`VendorExternalId`	`Guid?`	yes
`StatusContext`	`string`	no
`PartnerId`	`Guid?`	yes

Member names are the service's declaration names.

get-loan-list › query Parameters

object

orderBy

string

orderSort

string

pageIndex

integer · int32

pageSize

integer · int32

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

accountingEntryId

string · uuid

accrualStatus

integer · int32

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

Value	Token	Labels
`1`	`Not Accrued`	no label seeded
`2`	`Accrual Completed`	no label seeded
`3`	`Error at Accrual`	no label seeded
`4`	`Accrul Canceled`	no label seeded
`5`	`Collection Exist - Accrual Not Canceled`	no label seeded

amount

number · decimal

cancelDate

string · date-time

cancelDescription

string

cancelReason

string

currencyNumber

string

customerAccountId

string · uuid

customerApplicationId

string · uuid

customerId

string · uuid

customerRiskId

string · uuid

exchangeRate

number · decimal

externalReference

string

externalTransactionid

string

fundingSource

integer · int32

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

Value	Token	Labels
`1`	`equity`	en: equity · tr: Öz Kaynak · ar: الملكية
`2`	`pool`	en: pool · tr: Havuz · ar: حوض سباحة

id

string · uuid

latePenaltyRate

number · decimal

loanCloseDate

string · date-time

loanCloseType

integer · int32

loanDate

string · date-time

loanNumber

string

loanProductId

string · uuid

organizationId

string · uuid

parentLoanId

string · uuid

proposalId

string · uuid

status

integer · int32

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

Value	Token	Labels
`1`	`Pending Money Transfer`	en: Pending Money Transfer · tr: Para Transferi Bekliyor · ar: التحويل المالي المعلق
`2`	`Completed`	en: Completed · tr: Ödeme Gerçekleşti · ar: تمّ.

vendorExternalId

string · uuid

GET/loans

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

Example Responses

[
  {
    "accountingEntryId": "00000000-0000-0000-0000-000000000000",
    "accrualStatus": 0,
    "amount": 0,
    "cancelDate": "2024-08-25T15:00:00Z",
    "cancelDescription": "cancelDescription",
    "cancelReason": "cancelReason",
    "currencyNumber": "currencyNumber",
    "customerAccountId": "00000000-0000-0000-0000-000000000000",
    "customerApplicationId": "00000000-0000-0000-0000-000000000000",
    "customerId": "00000000-0000-0000-0000-000000000000",
    "customerRiskId": "00000000-0000-0000-0000-000000000000",
    "exchangeRate": 0,
    "externalReference": "externalReference",
    "externalTransactionid": "externalTransactionid",
    "fundingSource": 0,
    "id": "00000000-0000-0000-0000-000000000000",
    "latePenaltyRate": 0,
    "loanCloseDate": "2024-08-25T15:00:00Z",
    "loanCloseType": 0,
    "loanDate": "2024-08-25T15:00:00Z",
    "loanNumber": "loanNumber",
    "loanProductId": "00000000-0000-0000-0000-000000000000",
    "organizationId": "00000000-0000-0000-0000-000000000000",
    "parentLoanId": "00000000-0000-0000-0000-000000000000",
    "proposalId": "00000000-0000-0000-0000-000000000000",
    "status": 0,
    "vendorExternalId": "00000000-0000-0000-0000-000000000000"
  }
]

json

application/json

create-loan

POST

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

/loans

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

Field	Declared type	Nullable
`LoanNumber`	`string`	no

Member names are the service's declaration names.

Error codes this operation is known to raise

Code	Status	Meaning	Message
`ERR_LOAN_11`	400	`LOAN_PROPOSAL_MUST_NOT_BE_NULL`	Proposal cannot be found. : `{0}`
`ERR_LOAN_12`	400	`LOAN_PROPOSAL_IS_NOT_VALID`	Proposal is not valid. : `{0}`
`ERR_LOAN_13`	400	`LOAN_PAYBACK_PLAN_IS_NOT_FOUND`	not published in this snapshot
`ERR_LOAN_14`	400	`LOAN_PAYBACK_PLAN_IS_NOT_SELECTED`	Payback plan is not selected.: `{0}`

create-loan › Request Body

customerApplicationId

string · uuid · required

customerId

string · uuid · required

earlyPaymentDiscountRate

number · decimal · required

exchangeRate

number · decimal · required

fundingSource

integer · int32 · required

Permitted values — validated against the funding_source parameter.

Value	Meaning
`1`	equity
`2`	pool

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

Value	Token	Labels
`1`	`equity`	en: equity · tr: Öz Kaynak · ar: الملكية
`2`	`pool`	en: pool · tr: Havuz · ar: حوض سباحة

latePenaltyRate

number · decimal · required

loanProductId

string · uuid · required

monthlyRepaymentRate

number · decimal · required

organizationId

string · uuid · required

proposalPaybackPlanId

string · uuid · required

currencyNumber

string

expenses

string[]

externalReference

string

externalTransactionid

string

proposalId

string · uuid

vendorExternalId

string · uuid

create-loan › 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

loanNumber

string

POST/loans

curl https://dg-sandbox.dgpays.com/loan-service/loans \
  --request POST \
  --header 'Content-Type: application/json' \
  --data '{
  "currencyNumber": "",
  "customerApplicationId": "",
  "customerId": "",
  "earlyPaymentDiscountRate": 0,
  "exchangeRate": 0,
  "expenses": [
    ""
  ],
  "externalReference": "",
  "externalTransactionid": "",
  "fundingSource": 0,
  "latePenaltyRate": 0,
  "loanProductId": "",
  "monthlyRepaymentRate": 0,
  "organizationId": "",
  "proposalId": "",
  "proposalPaybackPlanId": "",
  "vendorExternalId": ""
}'

Example Request Body

{
  "currencyNumber": "",
  "customerApplicationId": "",
  "customerId": "",
  "earlyPaymentDiscountRate": 0,
  "exchangeRate": 0,
  "expenses": [
    ""
  ],
  "externalReference": "",
  "externalTransactionid": "",
  "fundingSource": 0,
  "latePenaltyRate": 0,
  "loanProductId": "",
  "monthlyRepaymentRate": 0,
  "organizationId": "",
  "proposalId": "",
  "proposalPaybackPlanId": "",
  "vendorExternalId": ""
}

json

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

application/json

Example Responses

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

json

application/json

get-loan-by-id

GET

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

/loans/{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 LoanDto.

Field	Declared type	Nullable
`Id`	`Guid?`	yes
`CustomerId`	`Guid?`	yes
`ProposalId`	`Guid?`	yes
`CustomerApplicationId`	`Guid?`	yes
`CustomerAccountId`	`Guid?`	yes
`LoanProductId`	`Guid`	no
`LoanNumber`	`string`	no
`FundingSource`	`int?`	yes
`OrganizationId`	`Guid?`	yes
`CurrencyNumber`	`string`	no
`Amount`	`decimal?`	yes
`LoanDate`	`DateTime?`	yes
`Status`	`int?`	yes
`ExchangeRate`	`decimal?`	yes
`AccountingEntryId`	`Guid?`	yes
`LoanCloseDate`	`DateTime?`	yes
`LoanCloseType`	`int?`	yes
`CustomerRiskId`	`Guid?`	yes
`AllotmentQueryId`	`Guid?`	yes
`ParentLoanId`	`Guid?`	yes
`CancelDate`	`DateTime?`	yes
`CancelReason`	`int?`	yes
`CancelDescription`	`string`	no
`LatePenaltyRate`	`decimal?`	yes
`EarlyPaymentDiscountRate`	`decimal?`	yes
`AccrualStatus`	`int?`	yes
`ExternalReference`	`string`	no
`ExternalTransactionid`	`string`	no
`VendorExternalId`	`Guid?`	yes
`StatusContext`	`string`	no
`PartnerId`	`Guid?`	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-loan-by-id › path Parameters

id

string · uuid · required

get-loan-by-id › Responses

accountingEntryId

string · uuid

accrualStatus

integer · int32

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

Value	Token	Labels
`1`	`Not Accrued`	no label seeded
`2`	`Accrual Completed`	no label seeded
`3`	`Error at Accrual`	no label seeded
`4`	`Accrul Canceled`	no label seeded
`5`	`Collection Exist - Accrual Not Canceled`	no label seeded

allotmentAssignmentId

string · uuid

amount

number · decimal

cancelDate

string · date-time

cancelDescription

string

cancelReason

string

currencyNumber

string

customerAccountId

string · uuid

customerApplicationId

string · uuid

customerId

string · uuid

customerRiskId

string · uuid

exchangeRate

number · decimal

externalReference

string

externalTransactionid

string

fundingSource

integer · int32

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

Value	Token	Labels
`1`	`equity`	en: equity · tr: Öz Kaynak · ar: الملكية
`2`	`pool`	en: pool · tr: Havuz · ar: حوض سباحة

id

string · uuid

latePenaltyRate

number · decimal

loanCloseDate

string · date-time

loanCloseType

integer · int32

loanDate

string · date-time

loanNumber

string

loanProductId

string · uuid

organizationId

string · uuid

parentLoanId

string · uuid

proposalId

string · uuid

status

integer · int32

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

Value	Token	Labels
`1`	`Pending Money Transfer`	en: Pending Money Transfer · tr: Para Transferi Bekliyor · ar: التحويل المالي المعلق
`2`	`Completed`	en: Completed · tr: Ödeme Gerçekleşti · ar: تمّ.

vendorExternalId

string · uuid

GET/loans/{id}

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

Example Responses

{
  "accountingEntryId": "00000000-0000-0000-0000-000000000000",
  "accrualStatus": 0,
  "allotmentAssignmentId": "00000000-0000-0000-0000-000000000000",
  "amount": 0,
  "cancelDate": "2024-08-25T15:00:00Z",
  "cancelDescription": "cancelDescription",
  "cancelReason": "cancelReason",
  "currencyNumber": "currencyNumber",
  "customerAccountId": "00000000-0000-0000-0000-000000000000",
  "customerApplicationId": "00000000-0000-0000-0000-000000000000",
  "customerId": "00000000-0000-0000-0000-000000000000",
  "customerRiskId": "00000000-0000-0000-0000-000000000000",
  "exchangeRate": 0,
  "externalReference": "externalReference",
  "externalTransactionid": "externalTransactionid",
  "fundingSource": 0,
  "id": "00000000-0000-0000-0000-000000000000",
  "latePenaltyRate": 0,
  "loanCloseDate": "2024-08-25T15:00:00Z",
  "loanCloseType": 0,
  "loanDate": "2024-08-25T15:00:00Z",
  "loanNumber": "loanNumber",
  "loanProductId": "00000000-0000-0000-0000-000000000000",
  "organizationId": "00000000-0000-0000-0000-000000000000",
  "parentLoanId": "00000000-0000-0000-0000-000000000000",
  "proposalId": "00000000-0000-0000-0000-000000000000",
  "status": 0,
  "vendorExternalId": "00000000-0000-0000-0000-000000000000"
}

json

application/json

loans--finalization loans--guarantors

Loan Service

loans--general

Operations addressed under /loans — 79 operations.

get-loan-list

GET

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

/loans

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

Field	Declared type	Nullable
`Id`	`Guid?`	yes
`CustomerId`	`Guid?`	yes
`ProposalId`	`Guid?`	yes
`CustomerApplicationId`	`Guid?`	yes
`CustomerAccountId`	`Guid?`	yes
`LoanProductId`	`Guid`	no
`LoanNumber`	`string`	no
`FundingSource`	`int?`	yes
`OrganizationId`	`Guid?`	yes
`CurrencyNumber`	`string`	no
`Amount`	`decimal?`	yes
`LoanDate`	`DateTime?`	yes
`Status`	`int?`	yes
`ExchangeRate`	`decimal?`	yes
`AccountingEntryId`	`Guid?`	yes
`LoanCloseDate`	`DateTime?`	yes
`LoanCloseType`	`int?`	yes
`CustomerRiskId`	`Guid?`	yes
`AllotmentQueryId`	`Guid?`	yes
`ParentLoanId`	`Guid?`	yes
`CancelDate`	`DateTime?`	yes
`CancelReason`	`int?`	yes
`CancelDescription`	`string`	no
`LatePenaltyRate`	`decimal?`	yes
`EarlyPaymentDiscountRate`	`decimal?`	yes
`AccrualStatus`	`int?`	yes
`ExternalReference`	`string`	no
`ExternalTransactionid`	`string`	no
`VendorExternalId`	`Guid?`	yes
`StatusContext`	`string`	no
`PartnerId`	`Guid?`	yes

Member names are the service's declaration names.

get-loan-list › query Parameters

object

orderBy

string

orderSort

string

pageIndex

integer · int32

pageSize

integer · int32

get-loan-list › Responses

object[]

Array of catalog-declared response records.

accountingEntryId

string · uuid

accrualStatus

integer · int32

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

Value	Token	Labels
`1`	`Not Accrued`	no label seeded
`2`	`Accrual Completed`	no label seeded
`3`	`Error at Accrual`	no label seeded
`4`	`Accrul Canceled`	no label seeded
`5`	`Collection Exist - Accrual Not Canceled`	no label seeded

amount

number · decimal

cancelDate

string · date-time

cancelDescription

string

cancelReason

string

currencyNumber

string

customerAccountId

string · uuid

customerApplicationId

string · uuid

customerId

string · uuid

customerRiskId

string · uuid

exchangeRate

number · decimal

externalReference

string

externalTransactionid

string

fundingSource

integer · int32

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

Value	Token	Labels
`1`	`equity`	en: equity · tr: Öz Kaynak · ar: الملكية
`2`	`pool`	en: pool · tr: Havuz · ar: حوض سباحة

id

string · uuid

latePenaltyRate

number · decimal

loanCloseDate

string · date-time

loanCloseType

integer · int32

loanDate

string · date-time

loanNumber

string

loanProductId

string · uuid

organizationId

string · uuid

parentLoanId

string · uuid

proposalId

string · uuid

status

integer · int32

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

Value	Token	Labels
`1`	`Pending Money Transfer`	en: Pending Money Transfer · tr: Para Transferi Bekliyor · ar: التحويل المالي المعلق
`2`	`Completed`	en: Completed · tr: Ödeme Gerçekleşti · ar: تمّ.

vendorExternalId

string · uuid

GET/loans

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

Example Responses

[
  {
    "accountingEntryId": "00000000-0000-0000-0000-000000000000",
    "accrualStatus": 0,
    "amount": 0,
    "cancelDate": "2024-08-25T15:00:00Z",
    "cancelDescription": "cancelDescription",
    "cancelReason": "cancelReason",
    "currencyNumber": "currencyNumber",
    "customerAccountId": "00000000-0000-0000-0000-000000000000",
    "customerApplicationId": "00000000-0000-0000-0000-000000000000",
    "customerId": "00000000-0000-0000-0000-000000000000",
    "customerRiskId": "00000000-0000-0000-0000-000000000000",
    "exchangeRate": 0,
    "externalReference": "externalReference",
    "externalTransactionid": "externalTransactionid",
    "fundingSource": 0,
    "id": "00000000-0000-0000-0000-000000000000",
    "latePenaltyRate": 0,
    "loanCloseDate": "2024-08-25T15:00:00Z",
    "loanCloseType": 0,
    "loanDate": "2024-08-25T15:00:00Z",
    "loanNumber": "loanNumber",
    "loanProductId": "00000000-0000-0000-0000-000000000000",
    "organizationId": "00000000-0000-0000-0000-000000000000",
    "parentLoanId": "00000000-0000-0000-0000-000000000000",
    "proposalId": "00000000-0000-0000-0000-000000000000",
    "status": 0,
    "vendorExternalId": "00000000-0000-0000-0000-000000000000"
  }
]

json

application/json

create-loan

POST

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

/loans

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

Field	Declared type	Nullable
`LoanNumber`	`string`	no

Member names are the service's declaration names.

Error codes this operation is known to raise

Code	Status	Meaning	Message
`ERR_LOAN_11`	400	`LOAN_PROPOSAL_MUST_NOT_BE_NULL`	Proposal cannot be found. : `{0}`
`ERR_LOAN_12`	400	`LOAN_PROPOSAL_IS_NOT_VALID`	Proposal is not valid. : `{0}`
`ERR_LOAN_13`	400	`LOAN_PAYBACK_PLAN_IS_NOT_FOUND`	not published in this snapshot
`ERR_LOAN_14`	400	`LOAN_PAYBACK_PLAN_IS_NOT_SELECTED`	Payback plan is not selected.: `{0}`

create-loan › Request Body

customerApplicationId

string · uuid · required

customerId

string · uuid · required

earlyPaymentDiscountRate

number · decimal · required

exchangeRate

number · decimal · required

fundingSource

integer · int32 · required

Permitted values — validated against the funding_source parameter.

Value	Meaning
`1`	equity
`2`	pool

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

Value	Token	Labels
`1`	`equity`	en: equity · tr: Öz Kaynak · ar: الملكية
`2`	`pool`	en: pool · tr: Havuz · ar: حوض سباحة

latePenaltyRate

number · decimal · required

loanProductId

string · uuid · required

monthlyRepaymentRate

number · decimal · required

organizationId

string · uuid · required

proposalPaybackPlanId

string · uuid · required

currencyNumber

string

expenses

string[]

externalReference

string

externalTransactionid

string

proposalId

string · uuid

vendorExternalId

string · uuid

create-loan › Responses

id

string · uuid

loanNumber

string

POST/loans

curl https://dg-sandbox.dgpays.com/loan-service/loans \
  --request POST \
  --header 'Content-Type: application/json' \
  --data '{
  "currencyNumber": "",
  "customerApplicationId": "",
  "customerId": "",
  "earlyPaymentDiscountRate": 0,
  "exchangeRate": 0,
  "expenses": [
    ""
  ],
  "externalReference": "",
  "externalTransactionid": "",
  "fundingSource": 0,
  "latePenaltyRate": 0,
  "loanProductId": "",
  "monthlyRepaymentRate": 0,
  "organizationId": "",
  "proposalId": "",
  "proposalPaybackPlanId": "",
  "vendorExternalId": ""
}'

Example Request Body

{
  "currencyNumber": "",
  "customerApplicationId": "",
  "customerId": "",
  "earlyPaymentDiscountRate": 0,
  "exchangeRate": 0,
  "expenses": [
    ""
  ],
  "externalReference": "",
  "externalTransactionid": "",
  "fundingSource": 0,
  "latePenaltyRate": 0,
  "loanProductId": "",
  "monthlyRepaymentRate": 0,
  "organizationId": "",
  "proposalId": "",
  "proposalPaybackPlanId": "",
  "vendorExternalId": ""
}

json

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

application/json

Example Responses

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

json

application/json

get-loan-by-id

GET

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

/loans/{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 LoanDto.

Field	Declared type	Nullable
`Id`	`Guid?`	yes
`CustomerId`	`Guid?`	yes
`ProposalId`	`Guid?`	yes
`CustomerApplicationId`	`Guid?`	yes
`CustomerAccountId`	`Guid?`	yes
`LoanProductId`	`Guid`	no
`LoanNumber`	`string`	no
`FundingSource`	`int?`	yes
`OrganizationId`	`Guid?`	yes
`CurrencyNumber`	`string`	no
`Amount`	`decimal?`	yes
`LoanDate`	`DateTime?`	yes
`Status`	`int?`	yes
`ExchangeRate`	`decimal?`	yes
`AccountingEntryId`	`Guid?`	yes
`LoanCloseDate`	`DateTime?`	yes
`LoanCloseType`	`int?`	yes
`CustomerRiskId`	`Guid?`	yes
`AllotmentQueryId`	`Guid?`	yes
`ParentLoanId`	`Guid?`	yes
`CancelDate`	`DateTime?`	yes
`CancelReason`	`int?`	yes
`CancelDescription`	`string`	no
`LatePenaltyRate`	`decimal?`	yes
`EarlyPaymentDiscountRate`	`decimal?`	yes
`AccrualStatus`	`int?`	yes
`ExternalReference`	`string`	no
`ExternalTransactionid`	`string`	no
`VendorExternalId`	`Guid?`	yes
`StatusContext`	`string`	no
`PartnerId`	`Guid?`	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-loan-by-id › path Parameters

id

string · uuid · required

get-loan-by-id › Responses

accountingEntryId

string · uuid

accrualStatus

integer · int32

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

Value	Token	Labels
`1`	`Not Accrued`	no label seeded
`2`	`Accrual Completed`	no label seeded
`3`	`Error at Accrual`	no label seeded
`4`	`Accrul Canceled`	no label seeded
`5`	`Collection Exist - Accrual Not Canceled`	no label seeded

allotmentAssignmentId

string · uuid

amount

number · decimal

cancelDate

string · date-time

cancelDescription

string

cancelReason

string

currencyNumber

string

customerAccountId

string · uuid

customerApplicationId

string · uuid

customerId

string · uuid

customerRiskId

string · uuid

exchangeRate

number · decimal

externalReference

string

externalTransactionid

string

fundingSource

integer · int32

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

Value	Token	Labels
`1`	`equity`	en: equity · tr: Öz Kaynak · ar: الملكية
`2`	`pool`	en: pool · tr: Havuz · ar: حوض سباحة

id

string · uuid

latePenaltyRate

number · decimal

loanCloseDate

string · date-time

loanCloseType

integer · int32

loanDate

string · date-time

loanNumber

string

loanProductId

string · uuid

organizationId

string · uuid

parentLoanId

string · uuid

proposalId

string · uuid

status

integer · int32

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

Value	Token	Labels
`1`	`Pending Money Transfer`	en: Pending Money Transfer · tr: Para Transferi Bekliyor · ar: التحويل المالي المعلق
`2`	`Completed`	en: Completed · tr: Ödeme Gerçekleşti · ar: تمّ.

vendorExternalId

string · uuid

GET/loans/{id}

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

Example Responses

{
  "accountingEntryId": "00000000-0000-0000-0000-000000000000",
  "accrualStatus": 0,
  "allotmentAssignmentId": "00000000-0000-0000-0000-000000000000",
  "amount": 0,
  "cancelDate": "2024-08-25T15:00:00Z",
  "cancelDescription": "cancelDescription",
  "cancelReason": "cancelReason",
  "currencyNumber": "currencyNumber",
  "customerAccountId": "00000000-0000-0000-0000-000000000000",
  "customerApplicationId": "00000000-0000-0000-0000-000000000000",
  "customerId": "00000000-0000-0000-0000-000000000000",
  "customerRiskId": "00000000-0000-0000-0000-000000000000",
  "exchangeRate": 0,
  "externalReference": "externalReference",
  "externalTransactionid": "externalTransactionid",
  "fundingSource": 0,
  "id": "00000000-0000-0000-0000-000000000000",
  "latePenaltyRate": 0,
  "loanCloseDate": "2024-08-25T15:00:00Z",
  "loanCloseType": 0,
  "loanDate": "2024-08-25T15:00:00Z",
  "loanNumber": "loanNumber",
  "loanProductId": "00000000-0000-0000-0000-000000000000",
  "organizationId": "00000000-0000-0000-0000-000000000000",
  "parentLoanId": "00000000-0000-0000-0000-000000000000",
  "proposalId": "00000000-0000-0000-0000-000000000000",
  "status": 0,
  "vendorExternalId": "00000000-0000-0000-0000-000000000000"
}

json

application/json

loans--finalization loans--guarantors