accounts

Operations addressed under /accounts — 8 operations.

aurax-bff-redirect-get-account-list

GET

https://dg-sandbox.dgpays.com/aurax-bff-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.

aurax-bff-redirect-get-account-list › 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

aurax-bff-redirect-customer-account-create-ui-bpm

POST

https://dg-sandbox.dgpays.com/aurax-bff-service

/accounts

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

aurax-bff-redirect-customer-account-create-ui-bpm › Responses

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

No data returned

aurax-bff-dynamic-get-calculate-available-balance-by-account-number

GET

https://dg-sandbox.dgpays.com/aurax-bff-service

/accounts/by-account-number/{accountNumber}/calculate-available-balance

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

Request and response fields are declared on the routing target get-calculate-available-balance-by-account-number; this entry declares none of its own.

Response body, read from the service source

The route declares its response as AvailableBalanceDto.

Field	Declared type	Nullable
`AccountId`	`Guid`	no
`AccountNumber`	`string`	no
`AvailableBalance`	`decimal?`	yes
`Balance`	`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.

aurax-bff-dynamic-get-calculate-available-balance-by-account-number › path Parameters

accountNumber

string · required

aurax-bff-dynamic-get-calculate-available-balance-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.

accountId

string · uuid

accountNumber

string

availableBalance

number · decimal

balance

number · decimal

aurax-bff-redirect-get-account-by-customer-id

GET

https://dg-sandbox.dgpays.com/aurax-bff-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.

aurax-bff-redirect-get-account-by-customer-id › path Parameters

customerId

string · required

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

aurax-bff-redirect-get-account-by-customer-id › Responses

No data returned

aurax-bff-redirect-get-account-by-customer-id-and-product-type

GET

https://dg-sandbox.dgpays.com/aurax-bff-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.

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

customerId

string · required

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

accountProductType

string · required

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

aurax-bff-redirect-get-account-by-customer-id-and-product-type › Responses

No data returned

aurax-bff-redirect-get-account-by-id

GET

https://dg-sandbox.dgpays.com/aurax-bff-service

/accounts/{accountId}

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`	`DateOnly?`	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
`IsDigital`	`bool?`	yes
`AccountQardHassanLimit`	`AccountQardHassanLimitDto`	no
`AccountDetails`	`List<AccountDetailDto>` (collection)	no
`ConsentItemIds`	`List<Guid>` (collection)	no

Member names are the service's declaration names.

Error codes this operation is known to raise

Code	Status	Meaning
`ERR_ACCNT_16`	400	`ACCOUNT_MUST_BE_NOT_NULL`

aurax-bff-redirect-get-account-by-id › path Parameters

accountId

string · required

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

aurax-bff-redirect-get-account-by-id › Responses

No data returned

aurax-bff-redirect-customer-account-edit-ui-bpm

PUT

https://dg-sandbox.dgpays.com/aurax-bff-service

/accounts/{accountId}

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

aurax-bff-redirect-customer-account-edit-ui-bpm › path Parameters

accountId

string · required

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

aurax-bff-redirect-customer-account-edit-ui-bpm › Responses

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

No data returned

aurax-bff-redirect-get-account-blocked-balance

GET

https://dg-sandbox.dgpays.com/aurax-bff-service

/api/accounts/{accountId}/blocked-balance

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

Request and response fields are declared on the routing target get-account-blocked-balance; this entry declares none of its own.

Response body, read from the service source

The route declares its response as AccountBlockedBalanceDto.

Field	Declared type	Nullable
`BlockedAmount`	`decimal?`	yes

Member names are the service's declaration names.

aurax-bff-redirect-get-account-blocked-balance › path Parameters

accountId

string · uuid · required

aurax-bff-redirect-get-account-blocked-balance › Responses

blockedAmount

number · decimal

accounting-transactions accrual-calculation