accounts

Operations addressed under /accounts — 20 operations.

get-account-list

GET

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

/accounts

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

Field	Declared type	Nullable
`Id`	`Guid`	no
`CustomerId`	`Guid`	no
`AccountName`	`string`	no
`ProductName`	`string`	no
`AccountNumber`	`string`	no
`OrganizationId`	`Guid?`	yes
`AccountProductId`	`Guid`	no
`AccountProductType`	`int?`	yes
`LedgerCode`	`string`	no
`CurrencyNumber`	`string`	no
`CurrencyCode`	`string`	no
`Iban`	`string`	no
`OpenedDate`	`DateOnly?`	yes
`ClosedDate`	`DateTime?`	yes
`ClosedReason`	`int?`	yes
`ClosedDescription`	`string`	no
`IsActive`	`bool`	no
`PassbookNumber`	`string`	no
`IsPassbookRejected`	`bool?`	yes
`OrganizationParentId`	`Guid?`	yes
`OrganizationCode`	`string`	no
`OrganizationName`	`string`	no
`OrganizationAttributes`	`Dictionary<string, string[]>`	no
`Citizenid`	`string`	no
`CitizenidType`	`int`	no
`FullName`	`string`	no
`CustomerType`	`int`	no
`ProductValueStartDay`	`int?`	yes
`ProductValueDay`	`int?`	yes
`ProductValueDateCutOffTime`	`TimeOnly?`	yes
`IsDigital`	`bool?`	yes
`IsSalary`	`bool?`	yes
`IsDirectMoneyOutflow`	`bool`	no
`AccountQardHassanLimit`	`AccountQardHassanLimitDto`	no
`AccountDetails`	`List<AccountDetailDto>` (collection)	no
`Constraints`	`List<AccountConstraintDetailDto>` (collection)	no

Member names are the service's declaration names.

get-account-list › query Parameters

object

orderBy

string

orderSort

string

pageIndex

integer · int32

pageSize

integer · int32

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

object[]

accountName

string

accountNumber

string

accountProductId

string · uuid

closedDate

string · date

closedDescription

string

closedReason

integer · int32

currencyCode

string

currencyNumber

string

customerId

string · uuid

iban

string

id

string · uuid

isActive

boolean

isDigital

boolean

isPassbookRejected

boolean

ledgerCode

string

openedDate

string · date

organizationCode

string

organizationId

string · uuid

organizationName

string

organizationParentId

passbookNumber

string

productName

string

GET/accounts

curl https://dg-sandbox.dgpays.com/account-service/accounts

Example Responses

[
  {
    "accountDetails": [
      {
        "accountId": "00000000-0000-0000-0000-000000000000",
        "contributionCalculateType": 0,
        "contributionRate": 0,
        "extensionDay": 0,
        "extensionType": 0,
        "id": "00000000-0000-0000-0000-000000000000",
        "isAutoRenewal": true,
        "isDeposited": true,
        "isMaturityToFirstWorkday": true,
        "isWithdrawn": true,
        "maturityBreakDate": "2024-08-25",
        "maturityDate": "2024-08-25T15:00:00Z",
        "maturityEndDate": "2024-08-25",
        "maturityStartDate": "2024-08-25",
        "maturityUnit": 0,
        "returnAccountId": "00000000-0000-0000-0000-000000000000",
        "valueStartDay": 0
      }
    ],
    "accountName": "accountName",
    "accountNumber": "accountNumber",
    "accountProductId": "00000000-0000-0000-0000-000000000000",
    "closedDate": "2024-08-25",
    "closedDescription": "closedDescription",
    "closedReason": 0,
    "currencyCode": "currencyCode",
    "currencyNumber": "currencyNumber",
    "customerId": "00000000-0000-0000-0000-000000000000",
    "iban": "iban",
    "id": "00000000-0000-0000-0000-000000000000",
    "isActive": true,
    "isDigital": true,
    "isPassbookRejected": true,
    "ledgerCode": "ledgerCode",
    "openedDate": "2024-08-25",
    "organizationCode": "organizationCode",
    "organizationId": "00000000-0000-0000-0000-000000000000",
    "organizationName": "organizationName",
    "organizationParentId": {},
    "passbookNumber": "passbookNumber",
    "productName": "productName"
  }
]

json

application/json

Get Account Availability By AccountNumber

POST

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

/accounts/availability

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

Invokes the Get-Account-Availability-By-AccountNumber service definition through POST /accounts/availability.

Turkish display name: Hesabin varlik ve aktiflik kontrolu

Response body, read from the service source

The route declares its response as IEnumerable<AccountAvailabilityDto>.

Field	Declared type	Nullable
`AccountNumber`	`string`	no
`Availability`	`bool`	no

Member names are the service's declaration names.

Get Account Availability By AccountNumber › Request Body

accountNumbers

string[] · required

Get Account Availability By AccountNumber › Responses

object[]

Array of catalog-declared response records.

accountNumber

string

availability

string

get-account-id-by-account-number

GET

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

/accounts/by-account-number/{accountNumber}/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 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_ACCNT_16`	400	`ACCOUNT_MUST_BE_NOT_NULL`	Account not found.

get-account-id-by-account-number › path Parameters

accountNumber

string · required

get-account-id-by-account-number › 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

get-account-by-customer-id

GET

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

/accounts/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<AccountDto>.

Field	Declared type	Nullable
`Id`	`Guid`	no
`CustomerId`	`Guid`	no
`AccountName`	`string`	no
`ProductName`	`string`	no
`AccountNumber`	`string`	no
`OrganizationId`	`Guid?`	yes
`AccountProductId`	`Guid`	no
`AccountProductType`	`int?`	yes
`LedgerCode`	`string`	no
`CurrencyNumber`	`string`	no
`CurrencyCode`	`string`	no
`Iban`	`string`	no
`OpenedDate`	`DateOnly?`	yes
`ClosedDate`	`DateTime?`	yes
`ClosedReason`	`int?`	yes
`ClosedDescription`	`string`	no
`IsActive`	`bool`	no
`PassbookNumber`	`string`	no
`IsPassbookRejected`	`bool?`	yes
`OrganizationParentId`	`Guid?`	yes
`OrganizationCode`	`string`	no
`OrganizationName`	`string`	no
`OrganizationAttributes`	`Dictionary<string, string[]>`	no
`Citizenid`	`string`	no
`CitizenidType`	`int`	no
`FullName`	`string`	no
`CustomerType`	`int`	no
`ProductValueStartDay`	`int?`	yes
`ProductValueDay`	`int?`	yes
`ProductValueDateCutOffTime`	`TimeOnly?`	yes
`IsDigital`	`bool?`	yes
`IsSalary`	`bool?`	yes
`IsDirectMoneyOutflow`	`bool`	no
`AccountQardHassanLimit`	`AccountQardHassanLimitDto`	no
`AccountDetails`	`List<AccountDetailDto>` (collection)	no
`Constraints`	`List<AccountConstraintDetailDto>` (collection)	no

Member names are the service's declaration names.

Error codes this operation is known to raise

Code	Status	Meaning	Message
`ERR_ACCNT_16`	400	`ACCOUNT_MUST_BE_NOT_NULL`	Account not found.

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

customerId

string · uuid · required

get-account-by-customer-id › query Parameters

object

orderBy

string

orderSort

string

get-account-by-customer-id › Responses

object[]

Array of catalog-declared response records.

object[]

accountName

string

accountNumber

string

accountProductId

string · uuid

accountProductType

integer · int32

closedDate

string · date

closedDescription

string

closedReason

integer · int32

currencyCode

string

currencyNumber

string

customerId

string · uuid

iban

string

id

string · uuid

isActive

boolean

isDigital

boolean

isPassbookRejected

boolean

ledgerCode

string

openedDate

string · date

organizationId

string · uuid

passbookNumber

string

productName

string

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

curl https://dg-sandbox.dgpays.com/account-service/accounts/by-customer-id/:customerId

Example Responses

[
  {
    "accountDetails": [
      {
        "accountId": "00000000-0000-0000-0000-000000000000",
        "contributionCalculateType": 0,
        "contributionRate": 0,
        "extensionDay": 0,
        "extensionType": 0,
        "id": "00000000-0000-0000-0000-000000000000",
        "isAutoRenewal": true,
        "isDeposited": true,
        "isMaturityToFirstWorkday": true,
        "isWithdrawn": true,
        "maturityBreakDate": "2024-08-25",
        "maturityEndDate": "2024-08-25",
        "maturityUnit": 0,
        "returnAccountId": "00000000-0000-0000-0000-000000000000",
        "valueStartDay": 0
      }
    ],
    "accountName": "accountName",
    "accountNumber": "accountNumber",
    "accountProductId": "00000000-0000-0000-0000-000000000000",
    "accountProductType": 0,
    "closedDate": "2024-08-25",
    "closedDescription": "closedDescription",
    "closedReason": 0,
    "currencyCode": "currencyCode",
    "currencyNumber": "currencyNumber",
    "customerId": "00000000-0000-0000-0000-000000000000",
    "iban": "iban",
    "id": "00000000-0000-0000-0000-000000000000",
    "isActive": true,
    "isDigital": true,
    "isPassbookRejected": true,
    "ledgerCode": "ledgerCode",
    "openedDate": "2024-08-25",
    "organizationId": "00000000-0000-0000-0000-000000000000",
    "passbookNumber": "passbookNumber",
    "productName": "productName"
  }
]

json

application/json

create-account

POST

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

/accounts/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 AccountCustomerDto.

Field	Declared type	Nullable
`Iban`	`string`	no
`AccountId`	`Guid`	no
`AccountNumber`	`string`	no

Member names are the service's declaration names.

Error codes this operation is known to raise

Code	Status	Meaning	Message
`ERR_ACCNT_11`	400	`ACCOUNT_PRODUCT_MUST_BE_IS_LEAF_LEVEL`	For account opening, product must be leaflevel.
`ERR_ACCNT_18`	400	`CURRENCY_ID_NOT_FOUND`	Currency not found.
`ERR_ACCNT_32`	400	`CUSTOMER_TYPE_IS_UN_MATCHING`	CustomerType is unmatching.
`ERR_ACCNT_48`	400	`ACCOUNT_PRODUCT_IS_PASSIVE`	Account product is passive.
`ERR_ACCNT_72`	400	`CUSTOMER_TYPE_MUST_NOT_BE_EMPTY`	CustomerType must not be empty.
`ERR_ACCNT_73`	400	`IS_PASSBOOK_REJECTED_MUST_NOT_BE_EMPTY`	IsPassbookRejected must not be empty.
`ERR_ACCNT_74`	400	`ACCOUNT_PRODUCT_ID_MUST_NOT_BE_EMPTY`	AccountProductId must not be empty.
`ERR_ACCNT_82`	400	`ACCOUNT_NUMBER_ALSO_FOUND`	Account Number is also found.

create-account › path Parameters

customerId

string · uuid · required

create-account › Request Body

accountName

string · required

accountNumber

string · required

accountProductId

string · uuid · required

currencyNumber

string · required

customerType

integer · int32 · required

iban

string · required

isPassbookRejected

boolean · required

ledgerCode

string · required

passbookNumber

string · required

isDigital

boolean

organizationId

string · uuid

create-account › Responses

accountId

string · uuid

accountNumber

string

iban

string

POST/accounts/by-customer-id/{customerId}

curl https://dg-sandbox.dgpays.com/account-service/accounts/by-customer-id/:customerId \
  --request POST \
  --header 'Content-Type: application/json' \
  --data '{
  "accountName": "",
  "accountNumber": "",
  "accountProductId": "",
  "currencyNumber": "",
  "customerType": 0,
  "iban": "",
  "isDigital": false,
  "isPassbookRejected": false,
  "ledgerCode": "",
  "organizationId": "",
  "passbookNumber": ""
}'

Example Request Body

{
  "accountName": "",
  "accountNumber": "",
  "accountProductId": "",
  "currencyNumber": "",
  "customerType": 0,
  "iban": "",
  "isDigital": false,
  "isPassbookRejected": false,
  "ledgerCode": "",
  "organizationId": "",
  "passbookNumber": ""
}

json

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

application/json

Example Responses

{
  "accountId": "00000000-0000-0000-0000-000000000000",
  "accountNumber": "accountNumber",
  "iban": "iban"
}

json

application/json

get-account-by-customer-id-and-product-type

GET

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

/accounts/by-customer-id/{customerId}/by-product-type/{accountProductType}

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

Field	Declared type	Nullable
`Id`	`Guid`	no
`CustomerId`	`Guid`	no
`AccountName`	`string`	no
`ProductName`	`string`	no
`AccountNumber`	`string`	no
`OrganizationId`	`Guid?`	yes
`AccountProductId`	`Guid`	no
`AccountProductType`	`int?`	yes
`LedgerCode`	`string`	no
`CurrencyNumber`	`string`	no
`CurrencyCode`	`string`	no
`Iban`	`string`	no
`OpenedDate`	`DateOnly?`	yes
`ClosedDate`	`DateTime?`	yes
`ClosedReason`	`int?`	yes
`ClosedDescription`	`string`	no
`IsActive`	`bool`	no
`PassbookNumber`	`string`	no
`IsPassbookRejected`	`bool?`	yes
`OrganizationParentId`	`Guid?`	yes
`OrganizationCode`	`string`	no
`OrganizationName`	`string`	no
`OrganizationAttributes`	`Dictionary<string, string[]>`	no
`Citizenid`	`string`	no
`CitizenidType`	`int`	no
`FullName`	`string`	no
`CustomerType`	`int`	no
`ProductValueStartDay`	`int?`	yes
`ProductValueDay`	`int?`	yes
`ProductValueDateCutOffTime`	`TimeOnly?`	yes
`IsDigital`	`bool?`	yes
`IsSalary`	`bool?`	yes
`IsDirectMoneyOutflow`	`bool`	no
`AccountQardHassanLimit`	`AccountQardHassanLimitDto`	no
`AccountDetails`	`List<AccountDetailDto>` (collection)	no
`Constraints`	`List<AccountConstraintDetailDto>` (collection)	no

Member names are the service's declaration names.

Error codes this operation is known to raise

Code	Status	Meaning	Message
`ERR_ACCNT_16`	400	`ACCOUNT_MUST_BE_NOT_NULL`	Account not found.

get-account-by-customer-id-and-product-type › path Parameters

customerId

string · uuid · required

accountProductType

integer · int32 · required

get-account-by-customer-id-and-product-type › query Parameters

object

orderBy

string

orderSort

string

get-account-by-customer-id-and-product-type › Responses

object[]

Array of catalog-declared response records.

object[]

accountName

string

accountNumber

string

accountProductId

string · uuid

accountProductType

integer · int32

closedDate

string · date

closedDescription

string

closedReason

integer · int32

currencyCode

string

currencyNumber

string

customerId

string · uuid

iban

string

id

string · uuid

isActive

boolean

isDigital

boolean

isPassbookRejected

boolean

ledgerCode

string

openedDate

string · date

organizationId

string · uuid

passbookNumber

string

productName

string

GET/accounts/by-customer-id/{customerId}/by-product-type/{accountProductType}

curl https://dg-sandbox.dgpays.com/account-service/accounts/by-customer-id/:customerId/by-product-type/:accountProductType

Example Responses

[
  {
    "accountDetails": [
      {
        "accountId": "00000000-0000-0000-0000-000000000000",
        "contributionCalculateType": 0,
        "contributionRate": 0,
        "extensionDay": 0,
        "extensionType": 0,
        "id": "00000000-0000-0000-0000-000000000000",
        "isAutoRenewal": true,
        "isDeposited": true,
        "isMaturityToFirstWorkday": true,
        "isWithdrawn": true,
        "maturityBreakDate": "2024-08-25",
        "maturityEndDate": "2024-08-25",
        "maturityPeriod": 0,
        "maturityStartDate": "2024-08-25",
        "maturityUnit": 0,
        "returnAccountId": "00000000-0000-0000-0000-000000000000",
        "valueStartDay": 0
      }
    ],
    "accountName": "accountName",
    "accountNumber": "accountNumber",
    "accountProductId": "00000000-0000-0000-0000-000000000000",
    "accountProductType": 0,
    "closedDate": "2024-08-25",
    "closedDescription": "closedDescription",
    "closedReason": 0,
    "currencyCode": "currencyCode",
    "currencyNumber": "currencyNumber",
    "customerId": "00000000-0000-0000-0000-000000000000",
    "iban": "iban",
    "id": "00000000-0000-0000-0000-000000000000",
    "isActive": true,
    "isDigital": true,
    "isPassbookRejected": true,
    "ledgerCode": "ledgerCode",
    "openedDate": "2024-08-25",
    "organizationId": "00000000-0000-0000-0000-000000000000",
    "passbookNumber": "passbookNumber",
    "productName": "productName"
  }
]

json

application/json

Get Account Summary By Customer Id

GET

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

/accounts/by-customer-id/{customerId}/summary

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

Invokes the get-account-summary-by-customer-id service definition through GET /accounts/by-customer-id/{customerId}/summary.

Turkish display name: Müşteri numarası ile özet hesap bilgisi getirme

Response body, read from the service source

The route declares its response as IEnumerable<AccountSummaryDto>.

Field	Declared type	Nullable
`Id`	`Guid`	no
`AccountNumber`	`string`	no
`LedgerCode`	`string`	no

Member names are the service's declaration names.

Get Account Summary By Customer Id › path Parameters

customerId

string · uuid · required

Get Account Summary By Customer Id › query Parameters

object

orderBy

string

orderSort

string

Get Account Summary By Customer Id › Responses

object[]

Array of catalog-declared response records.

Id

string · uuid

accountNumber

string

ledgerCode

string

get-account-detail-list

GET

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

/accounts/details

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

Field	Declared type	Nullable
`AccountId`	`Guid`	no
`ContributionCalculateType`	`int?`	yes
`ExtensionType`	`int?`	yes
`ValueStartDay`	`int?`	yes
`MaturityUnit`	`int?`	yes
`MaturityPeriod`	`int?`	yes
`IsAutoRenewal`	`bool?`	yes
`IsDeposited`	`bool?`	yes
`IsWithdrawn`	`bool?`	yes
`IsMaturityClosed`	`bool`	no
`IsMaturityToFirstWorkday`	`bool?`	yes
`ExtensionDay`	`int?`	yes
`ContributionRate`	`decimal?`	yes
`MaturityStartDate`	`DateOnly?`	yes
`MaturityEndDate`	`DateOnly?`	yes
`MaturityBreakDate`	`DateOnly?`	yes
`ReturnAccountId`	`Guid?`	yes
`AccountProductContributionId`	`Guid?`	yes
`LastContributionRate`	`decimal?`	yes
`PoolDefinitionRateId`	`Guid?`	yes
`MaxPenaltyFreeMaturityDays`	`int?`	yes
`Transferid`	`Guid?`	yes
`TransferAction`	`string`	no
`OpeningUnitValue`	`decimal?`	yes
`ClosingUnitValue`	`decimal?`	yes
`NetProfit`	`decimal?`	yes
`GrossProfit`	`decimal?`	yes
`TaxAmount`	`decimal?`	yes

Member names are the service's declaration names.

get-account-detail-list › query Parameters

object

orderBy

string

orderSort

string

pageIndex

integer · int32

pageSize

integer · int32

get-account-detail-list › Responses

object[]

Array of catalog-declared response records.

accountId

string · uuid

contributionCalculateType

integer · int32

contributionRate

number · decimal

extensionDay

integer · int32

extensionType

integer · int32

id

string · uuid

isAutoRenewal

boolean

isDeposited

boolean

isMaturityToFirstWorkday

boolean

isWithdrawn

boolean

maturityBreakDate

string · date

maturityEndDate

string · date

maturityPeriod

integer · int32

maturityStartDate

string · date

maturityUnit

integer · int32

returnAccountId

string · uuid

valueStartDay

integer · int32

get-account-passbook-count-list

GET

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

/accounts/passbooks/count

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

Field	Declared type	Nullable
`Count`	`int?`	yes
`OrganizationId`	`Guid`	no
`AccountId`	`Guid`	no

Member names are the service's declaration names.

get-account-passbook-count-list › query Parameters

object

get-account-passbook-count-list › Responses

object[]

Array of catalog-declared response records.

accountId

string · uuid

count

integer · int32

organizationId

string · uuid

get-account-by-id

GET

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

/accounts/{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 AccountDto.

Field	Declared type	Nullable
`Id`	`Guid`	no
`CustomerId`	`Guid`	no
`AccountName`	`string`	no
`ProductName`	`string`	no
`AccountNumber`	`string`	no
`OrganizationId`	`Guid?`	yes
`AccountProductId`	`Guid`	no
`AccountProductType`	`int?`	yes
`LedgerCode`	`string`	no
`CurrencyNumber`	`string`	no
`CurrencyCode`	`string`	no
`Iban`	`string`	no
`OpenedDate`	`DateOnly?`	yes
`ClosedDate`	`DateTime?`	yes
`ClosedReason`	`int?`	yes
`ClosedDescription`	`string`	no
`IsActive`	`bool`	no
`PassbookNumber`	`string`	no
`IsPassbookRejected`	`bool?`	yes
`OrganizationParentId`	`Guid?`	yes
`OrganizationCode`	`string`	no
`OrganizationName`	`string`	no
`OrganizationAttributes`	`Dictionary<string, string[]>`	no
`Citizenid`	`string`	no
`CitizenidType`	`int`	no
`FullName`	`string`	no
`CustomerType`	`int`	no
`ProductValueStartDay`	`int?`	yes
`ProductValueDay`	`int?`	yes
`ProductValueDateCutOffTime`	`TimeOnly?`	yes
`IsDigital`	`bool?`	yes
`IsSalary`	`bool?`	yes
`IsDirectMoneyOutflow`	`bool`	no
`AccountQardHassanLimit`	`AccountQardHassanLimitDto`	no
`AccountDetails`	`List<AccountDetailDto>` (collection)	no
`Constraints`	`List<AccountConstraintDetailDto>` (collection)	no

Member names are the service's declaration names.

Error codes this operation is known to raise

Code	Status	Meaning	Message
`ERR_ACCNT_16`	400	`ACCOUNT_MUST_BE_NOT_NULL`	Account not found.

get-account-by-id › path Parameters

id

string · uuid · required

get-account-by-id › Responses

object[]

accountName

string

accountNumber

string

accountProductId

string · uuid

accountProductType

integer · int32

citizenid

string

citizenidType

integer · int32

closedDate

string · date

closedDescription

string

closedReason

integer · int32

currencyCode

string

currencyNumber

string

customerId

string · uuid

customerType

integer · int32

fullName

string

iban

string

id

string · uuid

isActive

boolean

isDigital

boolean

isPassbookRejected

boolean

ledgerCode

string

openedDate

string · date

organizationCode

string

organizationId

string · uuid

organizationName

string

organizationParentId

passbookNumber

string

productName

string

GET/accounts/{id}

curl https://dg-sandbox.dgpays.com/account-service/accounts/:id

Example Responses

{
  "accountDetails": [
    {
      "accountId": "00000000-0000-0000-0000-000000000000",
      "contributionCalculateType": 0,
      "contributionRate": 0,
      "extensionDay": 0,
      "extensionType": 0,
      "id": "00000000-0000-0000-0000-000000000000",
      "isAutoRenewal": true,
      "isDeposited": true,
      "isMaturityToFirstWorkday": true,
      "isWithdrawn": true,
      "maturityBreakDate": "2024-08-25",
      "maturityDate": "2024-08-25T15:00:00Z",
      "maturityEndDate": "2024-08-25",
      "maturityStartDate": "2024-08-25",
      "maturityUnit": 0,
      "returnAccountId": "00000000-0000-0000-0000-000000000000",
      "valueStartDay": 0
    }
  ],
  "accountName": "accountName",
  "accountNumber": "accountNumber",
  "accountProductId": "00000000-0000-0000-0000-000000000000",
  "accountProductType": 0,
  "citizenid": "citizenid",
  "citizenidType": 0,
  "closedDate": "2024-08-25",
  "closedDescription": "closedDescription",
  "closedReason": 0,
  "currencyCode": "currencyCode",
  "currencyNumber": "currencyNumber",
  "customerId": "00000000-0000-0000-0000-000000000000",
  "customerType": 0,
  "fullName": "fullName",
  "iban": "iban",
  "id": "00000000-0000-0000-0000-000000000000",
  "isActive": true,
  "isDigital": true,
  "isPassbookRejected": true,
  "ledgerCode": "ledgerCode",
  "openedDate": "2024-08-25",
  "organizationCode": "organizationCode",
  "organizationId": "00000000-0000-0000-0000-000000000000",
  "organizationName": "organizationName",
  "organizationParentId": {},
  "passbookNumber": "passbookNumber",
  "productName": "productName"
}

json

application/json

update-account

PUT

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

/accounts/{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_ACCNT_16`	400	`ACCOUNT_MUST_BE_NOT_NULL`	Account not found.

update-account › path Parameters

id

string · uuid · required

update-account › Request Body

name

string · required

passbookNumber

string · required

update-account › 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

get-blockable-amount-by-account-id

GET

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

/accounts/{id}/blockable-amount

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

get-blockable-amount-by-account-id › path Parameters

id

string · required

Present in the route template but not declared as a Route-bound field in the catalog.

get-blockable-amount-by-account-id › Responses

Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.

No data returned

close-account

PUT

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

/accounts/{id}/close

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_ACCNT_16`	400	`ACCOUNT_MUST_BE_NOT_NULL`	Account not found.
`ERR_ACCNT_17`	400	`ACCOUNT_IS_ALSO_CLOSED`	Account is also closed.

close-account › path Parameters

id

string · uuid · required

close-account › Request Body

description

string · required

reason

string · required

closeDate

string · date

close-account › Responses

No data returned

create-account-detail

POST

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

/accounts/{id}/details

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_ACCNT_16`	400	`ACCOUNT_MUST_BE_NOT_NULL`	Account not found.

create-account-detail › path Parameters

id

string · uuid · required

create-account-detail › Request Body

contributionCalculateType

integer · int32 · required

contributionRate

number · decimal · required

isAutoRenewal

boolean · required

isDeposited

boolean · required

isMaturityToFirstWorkday

boolean · required

isWithdrawn

boolean · required

maturityEndDate

string · date · required

maturityStartDate

string · date · required

maturityUnit

integer · int32 · required

valueStartDay

integer · int32 · required

extensionDay

integer · int32

extensionType

integer · int32

maturityBreakDate

string · date

maturityPeriod

integer · int32

returnAccountId

string · uuid

create-account-detail › 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/accounts/{id}/details

curl https://dg-sandbox.dgpays.com/account-service/accounts/:id/details \
  --request POST \
  --header 'Content-Type: application/json' \
  --data '{
  "contributionCalculateType": 0,
  "contributionRate": 0,
  "extensionDay": 0,
  "extensionType": 0,
  "isAutoRenewal": false,
  "isDeposited": false,
  "isMaturityToFirstWorkday": false,
  "isWithdrawn": false,
  "maturityBreakDate": "",
  "maturityEndDate": "",
  "maturityPeriod": 0,
  "maturityStartDate": "",
  "maturityUnit": 0,
  "returnAccountId": "",
  "valueStartDay": 0
}'

Example Request Body

{
  "contributionCalculateType": 0,
  "contributionRate": 0,
  "extensionDay": 0,
  "extensionType": 0,
  "isAutoRenewal": false,
  "isDeposited": false,
  "isMaturityToFirstWorkday": false,
  "isWithdrawn": false,
  "maturityBreakDate": "",
  "maturityEndDate": "",
  "maturityPeriod": 0,
  "maturityStartDate": "",
  "maturityUnit": 0,
  "returnAccountId": "",
  "valueStartDay": 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-account-detail-by-id

GET

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

/accounts/{id}/details/{accountDetailId}

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

Field	Declared type	Nullable
`AccountId`	`Guid`	no
`ContributionCalculateType`	`int?`	yes
`ExtensionType`	`int?`	yes
`ValueStartDay`	`int?`	yes
`MaturityUnit`	`int?`	yes
`MaturityPeriod`	`int?`	yes
`IsAutoRenewal`	`bool?`	yes
`IsDeposited`	`bool?`	yes
`IsWithdrawn`	`bool?`	yes
`IsMaturityClosed`	`bool`	no
`IsMaturityToFirstWorkday`	`bool?`	yes
`ExtensionDay`	`int?`	yes
`ContributionRate`	`decimal?`	yes
`MaturityStartDate`	`DateOnly?`	yes
`MaturityEndDate`	`DateOnly?`	yes
`MaturityBreakDate`	`DateOnly?`	yes
`ReturnAccountId`	`Guid?`	yes
`AccountProductContributionId`	`Guid?`	yes
`LastContributionRate`	`decimal?`	yes
`PoolDefinitionRateId`	`Guid?`	yes
`MaxPenaltyFreeMaturityDays`	`int?`	yes
`Transferid`	`Guid?`	yes
`TransferAction`	`string`	no
`OpeningUnitValue`	`decimal?`	yes
`ClosingUnitValue`	`decimal?`	yes
`NetProfit`	`decimal?`	yes
`GrossProfit`	`decimal?`	yes
`TaxAmount`	`decimal?`	yes

Member names are the service's declaration names.

Error codes this operation is known to raise

Code	Status	Meaning	Message
`ERR_ACCNT_16`	400	`ACCOUNT_MUST_BE_NOT_NULL`	Account not found.
`ERR_ACCNT_96`	400	`ACCOUNT_DETAIL_MUST_BE_NOT_NULL`	Account detail not found.

get-account-detail-by-id › path Parameters

id

string · uuid · required

accountDetailId

string · uuid · required

get-account-detail-by-id › Responses

object[]

Array of catalog-declared response records.

accountId

string · uuid

contributionCalculateType

integer · int32

contributionRate

number · decimal

extensionDay

integer · int32

extensionType

integer · int32

id

string · uuid

isAutoRenewal

boolean

isDeposited

boolean

isMaturityToFirstWorkday

boolean

isWithdrawn

boolean

maturityBreakDate

string · date

maturityEndDate

string · date

maturityPeriod

integer · int32

maturityStartDate

string · date

maturityUnit

integer · int32

returnAccountId

string · uuid

valueStartDay

integer · int32

GET/accounts/{id}/details/{accountDetailId}

curl https://dg-sandbox.dgpays.com/account-service/accounts/:id/details/:accountDetailId

Example Responses

[
  {
    "accountId": "00000000-0000-0000-0000-000000000000",
    "contributionCalculateType": 0,
    "contributionRate": 0,
    "extensionDay": 0,
    "extensionType": 0,
    "id": "00000000-0000-0000-0000-000000000000",
    "isAutoRenewal": true,
    "isDeposited": true,
    "isMaturityToFirstWorkday": true,
    "isWithdrawn": true,
    "maturityBreakDate": "2024-08-25",
    "maturityEndDate": "2024-08-25",
    "maturityPeriod": 0,
    "maturityStartDate": "2024-08-25",
    "maturityUnit": 0,
    "returnAccountId": "00000000-0000-0000-0000-000000000000",
    "valueStartDay": 0
  }
]

json

application/json

update-account-detail

PUT

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

/accounts/{id}/details/{accountDetailId}

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_ACCNT_16`	400	`ACCOUNT_MUST_BE_NOT_NULL`	Account not found.
`ERR_ACCNT_96`	400	`ACCOUNT_DETAIL_MUST_BE_NOT_NULL`	Account detail not found.

update-account-detail › path Parameters

id

string · uuid · required

accountDetailId

string · uuid · required

update-account-detail › Request Body

contributionCalculateType

integer · int32 · required

contributionRate

number · decimal · required

extensionType

integer · int32 · required

isAutoRenewal

boolean · required

isDeposited

boolean · required

isMaturityToFirstWorkday

boolean · required

isWithdrawn

boolean · required

maturityBreakDate

string · date · required

maturityEndDate

string · date · required

maturityStartDate

string · date · required

maturityUnit

integer · int32 · required

valueStartDay

integer · int32 · required

extensionDay

integer · int32

maturityPeriod

integer · int32

returnAccountId

string · uuid

update-account-detail › Responses

No data returned

PUT/accounts/{id}/details/{accountDetailId}

curl https://dg-sandbox.dgpays.com/account-service/accounts/:id/details/:accountDetailId \
  --request PUT \
  --header 'Content-Type: application/json' \
  --data '{
  "contributionCalculateType": 0,
  "contributionRate": 0,
  "extensionDay": 0,
  "extensionType": 0,
  "isAutoRenewal": false,
  "isDeposited": false,
  "isMaturityToFirstWorkday": false,
  "isWithdrawn": false,
  "maturityBreakDate": "",
  "maturityEndDate": "",
  "maturityPeriod": 0,
  "maturityStartDate": "",
  "maturityUnit": 0,
  "returnAccountId": "",
  "valueStartDay": 0
}'

Example Request Body

{
  "contributionCalculateType": 0,
  "contributionRate": 0,
  "extensionDay": 0,
  "extensionType": 0,
  "isAutoRenewal": false,
  "isDeposited": false,
  "isMaturityToFirstWorkday": false,
  "isWithdrawn": false,
  "maturityBreakDate": "",
  "maturityEndDate": "",
  "maturityPeriod": 0,
  "maturityStartDate": "",
  "maturityUnit": 0,
  "returnAccountId": "",
  "valueStartDay": 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

delete-account-detail

DELETE

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

/accounts/{id}/details/{accountDetailId}

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_ACCNT_16`	400	`ACCOUNT_MUST_BE_NOT_NULL`	Account not found.
`ERR_ACCNT_96`	400	`ACCOUNT_DETAIL_MUST_BE_NOT_NULL`	Account detail not found.

delete-account-detail › path Parameters

id

string · uuid · required

accountDetailId

string · uuid · required

delete-account-detail › Responses

No data returned

get-light-account-by-id

GET

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

/accounts/{id}/light

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

Field	Declared type	Nullable
`Id`	`Guid`	no
`CustomerId`	`Guid`	no
`AccountNumber`	`string`	no
`LedgerCode`	`string`	no
`CurrencyNumber`	`string`	no
`Iban`	`string`	no
`IsActive`	`bool`	no
`OrganizationCode`	`string`	no

Member names are the service's declaration names.

Error codes this operation is known to raise

Code	Status	Meaning	Message
`ERR_ACCNT_16`	400	`ACCOUNT_MUST_BE_NOT_NULL`	Account not found.

get-light-account-by-id › path Parameters

id

string · uuid · required

get-light-account-by-id › Responses

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

No data returned

print-passbook

POST

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

/accounts/{id}/passbooks

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

Field	Declared type	Nullable
`PassbookNumber`	`string`	no

Member names are the service's declaration names.

Error codes this operation is known to raise

Code	Status	Meaning	Message
`ERR_ACCNT_16`	400	`ACCOUNT_MUST_BE_NOT_NULL`	Account not found.
`ERR_ACCNT_21`	400	`ACCOUNT_CUSTOMER_MUST_NOT_BE_PASSIVE`	Account is passive.

print-passbook › path Parameters

id

string · uuid · required

print-passbook › Request Body

organizationId

string · uuid · required

print-passbook › Responses

No data returned

reopen-account

PUT

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

/accounts/{id}/reopen

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_ACCNT_16`	400	`ACCOUNT_MUST_BE_NOT_NULL`	Account not found.
`ERR_ACCNT_58`	400	`ACCOUNT_IS_ALSO_FOUND`	Account is also opened.

reopen-account › path Parameters

id

string · uuid · required

reopen-account › Responses

No data returned

account-products batch-catalog