account-products
Operations addressed under /account-products — 10 operations.
aurax-bff-dynamic-get-account-product-list
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-product-list; this entry declares none of its own.
query Parameters
orderByorderSortpageIndexpageSizeaurax-bff-dynamic-get-account-product-list › Responses
Success. Returns a page of records: the collection under data, with total carrying the unpaged count.
Response records carried by this page.
totalTotal matching records, ignoring paging.
account-product-create-ui-bpm
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
Invokes the aurax-bff-dynamic-account-product-create-ui-bpm service definition through POST /account-products.
Request and response fields are declared on the routing target account-product-create-ui-bpm; this entry declares none of its own.
account-product-create-ui-bpm › Request Body
accountProductTypecodedescriptionnamebalanceControlEndTimebalanceControlStartTimecontributionCalculateTypehasMaturityinterimContributionPaymentisAutoRenewalisDepositedisDirectMoneyOutflowisInterimContributionPaymentisMaturityToFirstWorkdayisRegularPaymentMandatoryisSpecialRateAvailableisWithdrawnmaxSpecialRateminSpecialRateminimumMaturityForPenaltyFreeWithdrawalparentAccountProductIdregularDepositPeriodicityvalueDayvalueStartDayaccount-product-create-ui-bpm › Responses
Success. The schema is an anyOf over three envelopes: the record, a bare array of it, and a page {total, data[]} carrying the same record.
Decision Table
| Variant | Matching Criteria |
|---|---|
| type = object | |
| type = array | |
| type = object · requires: data |
idaurax-bff-dynamic-get-account-product-by-id
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-product-by-id; this entry declares none of its own.
path Parameters
idaurax-bff-dynamic-get-account-product-by-id › Responses
Success. The catalog declares this returns a single record. Of 25 operations in this state with a probeable route, 8 answered and 6 returned a single record — the other two returned a collection and a bare boolean.
accountProductTypebalanceControlEndTimebalanceControlStartTimecodecontributionCalculateTypedescriptionextensionDayextensionTypehasMaturityidinterimContributionPaymentisActiveisAutoRenewalisDepositedisDirectMoneyOutflowisInterimContributionPaymentisLeafLevelisMaturityToFirstWorkdayisRegularPaymentMandatoryisSpecialRateAvailableisWithdrawnmaxSpecialRateminSpecialRateminimumMaturityForPenaltyFreeWithdrawalnameparentAccountProductIdregularDepositPeriodicityvalueDayvalueStartDayaccount-product-edit-ui-bpm
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
Invokes the aurax-bff-dynamic-account-product-edit-ui-bpm service definition through PUT /account-products/{id}.
Request and response fields are declared on the routing target account-product-edit-ui-bpm; this entry declares none of its own.
path Parameters
idPresent in this route template but not among the Route-bound fields of the routing target account-product-edit-ui-bpm, whose own path is decoupled from this one.
account-product-edit-ui-bpm › Request Body
idisActivenameaccountProductTypebalanceControlEndTimebalanceControlStartTimecodecontributionCalculateTypedescriptionextensionDayextensionTypehasMaturityinterimContributionPaymentisAutoRenewalisDepositedisDirectMoneyOutflowisInterimContributionPaymentisMaturityToFirstWorkdayisRegularPaymentMandatoryisSpecialRateAvailableisWithdrawnmaxSpecialRateminSpecialRateminimumMaturityForPenaltyFreeWithdrawalparentAccountProductIdregularDepositPeriodicityvalueDayvalueStartDayaccount-product-edit-ui-bpm › Responses
Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.
account-product-delete-ui-bpm
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
Invokes the aurax-bff-dynamic-account-product-delete-ui-bpm service definition through DELETE /account-products/{id}.
Request and response fields are declared on the routing target account-product-delete-ui-bpm; this entry declares none of its own.
path Parameters
idaccount-product-delete-ui-bpm › Responses
Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.
aurax-bff-redirect-get-account-product-transaction-limit-list
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
path Parameters
idPresent in the route template but not declared as a Route-bound field in the catalog.
accountProductContributionIdPresent in the route template but not declared as a Route-bound field in the catalog.
aurax-bff-redirect-get-account-product-transaction-limit-list › Responses
Success. The catalog declares no response fields for this operation. It returns a page of records under data, with total carrying the unpaged count — but the record's fields are not declared.
aurax-bff-redirect-get-account-product-transaction-limit-by-id
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
path Parameters
idPresent in the route template but not declared as a Route-bound field in the catalog.
accountProductContributionIdPresent in the route template but not declared as a Route-bound field in the catalog.
transactionLimitIdPresent in the route template but not declared as a Route-bound field in the catalog.
aurax-bff-redirect-get-account-product-transaction-limit-by-id › Responses
Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.
aurax-bff-redirect-get-account-product-contribution-by-id
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
path Parameters
idPresent in the route template but not declared as a Route-bound field in the catalog.
contributionIdPresent in the route template but not declared as a Route-bound field in the catalog.
aurax-bff-redirect-get-account-product-contribution-by-id › Responses
Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.
aurax-bff-redirect-get-account-product-convertible-currency-list
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
path Parameters
idPresent in the route template but not declared as a Route-bound field in the catalog.
aurax-bff-redirect-get-account-product-convertible-currency-list › Responses
Success. The catalog declares no response fields for this operation. It returns a page of records under data, with total carrying the unpaged count — but the record's fields are not declared.
aurax-bff-redirect-get-account-product-contribution-list
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-product-contribution-list; this entry declares none of its own.
Response body, read from the service source
The route declares its response as IEnumerable<AccountProductContributionDto>.
| Field | Declared type | Nullable |
|---|---|---|
Id | Guid | no |
AccountProductId | Guid | no |
CurrencyNumber | string | no |
CurrencyCode | string | no |
MinAmount | decimal? | yes |
MaxAmount | decimal? | yes |
MinMaturity | int? | yes |
MaxMaturity | int? | yes |
MaturityUnit | int? | yes |
ContributionRate | decimal? | yes |
MinBalance | decimal? | yes |
MaxBalance | decimal? | yes |
BeginDate | DateOnly? | yes |
EndDate | DateOnly? | yes |
PoolDefinitionId | Guid? | yes |
PoolDefinitionRateId | Guid? | yes |
AccountProductTaxes | List<AccountProductTaxDto> (collection) | no |
AccountProductTransactionLimits | List<AccountProductTransactionLimitDto> (collection) | no |
Member names are the service's declaration names.
query Parameters
orderByorderSortpageIndexpageSizeaurax-bff-redirect-get-account-product-contribution-list › Responses
Success. Returns a page of records: the collection under data, with total carrying the unpaged count.
Response records carried by this page.
totalTotal matching records, ignoring paging.