pool-definitions

Operations addressed under /pool-definitions — 23 operations.

create-pool-definition

POST

https://dg-sandbox.dgpays.com/profit-share-service

/pool-definitions

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
`ERR_PRFTSHR_12`	400	`POOL_DEFIFINITON_CODE_MUST_BE_UNIQUE`

create-pool-definition › Request Body

code

string · required

endDate

string · date · required

name

string · required

poolType

integer · int32 · required

startDate

string · date-time · required

object[]

create-pool-definition › 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/pool-definitions

curl https://dg-sandbox.dgpays.com/profit-share-service/pool-definitions \
  --request POST \
  --header 'Content-Type: application/json' \
  --data '{
  "code": "",
  "endDate": "",
  "name": "",
  "poolType": 0,
  "rates": [
    {
      "_rowStatus": 0,
      "bankLossRate": 0,
      "bankProfitRate": 0,
      "customerLossRate": 0,
      "customerProfitRate": 0,
      "id": "",
      "irrRate": 0,
      "perRate": 0
    }
  ],
  "startDate": ""
}'

Example Request Body

{
  "code": "",
  "endDate": "",
  "name": "",
  "poolType": 0,
  "rates": [
    {
      "_rowStatus": 0,
      "bankLossRate": 0,
      "bankProfitRate": 0,
      "customerLossRate": 0,
      "customerProfitRate": 0,
      "id": "",
      "irrRate": 0,
      "perRate": 0
    }
  ],
  "startDate": ""
}

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

update-pool-definition

PUT

https://dg-sandbox.dgpays.com/profit-share-service

/pool-definitions/{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
`ERR_PRFTSHR_1`	400	`POOL_DEFINITION_NOT_FOUND`

update-pool-definition › path Parameters

id

string · uuid · required

update-pool-definition › Request Body

endDate

string · date · required

isActive

boolean · required

name

string · required

poolType

integer · int32 · required

startDate

string · date-time · required

update-pool-definition › 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

delete-pool-definition

DELETE

https://dg-sandbox.dgpays.com/profit-share-service

/pool-definitions/{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
`ERR_PRFTSHR_1`	400	`POOL_DEFINITION_NOT_FOUND`

delete-pool-definition › path Parameters

id

string · uuid · required

delete-pool-definition › Responses

No data returned

get-pool-definition-currency-map-list

GET

https://dg-sandbox.dgpays.com/profit-share-service

/pool-definitions/{id}/currencies

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

Field	Declared type	Nullable
`Id`	`Guid`	no
`IsActive`	`bool?`	yes
`PoolDefinitionId`	`Guid`	no
`CurrencyId`	`int`	no
`PoolDefinitionRateId`	`Guid?`	yes

Member names are the service's declaration names.

get-pool-definition-currency-map-list › path Parameters

id

string · uuid · required

get-pool-definition-currency-map-list › query Parameters

object

orderBy

string

orderSort

string

pageIndex

integer · int32

pageSize

integer · int32

get-pool-definition-currency-map-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.

currencyId

integer · int32

id

string · uuid

isActive

boolean

poolDefinitionId

string · uuid

create-pool-definition-currency-map

POST

https://dg-sandbox.dgpays.com/profit-share-service

/pool-definitions/{id}/currencies

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

Response body, read from the service source

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
`ERR_PRFTSHR_1`	400	`POOL_DEFINITION_NOT_FOUND`
`ERR_PRFTSHR_7`	400	`POOL_DEFINITION_CURRENCY_ALREADY_EXISTS`

create-pool-definition-currency-map › path Parameters

id

string · uuid · required

create-pool-definition-currency-map › Request Body

currencyNumber

string · required

create-pool-definition-currency-map › 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.

get-pool-definition-currency-map-by-id

GET

https://dg-sandbox.dgpays.com/profit-share-service

/pool-definitions/{id}/currencies/{poolDefinitionCurrencyMapId}

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

Field	Declared type	Nullable
`Id`	`Guid`	no
`IsActive`	`bool?`	yes
`PoolDefinitionId`	`Guid`	no
`CurrencyId`	`int`	no
`PoolDefinitionRateId`	`Guid?`	yes

Member names are the service's declaration names.

Error codes this operation is known to raise

Code	Status	Meaning
`ERR_PRFTSHR_1`	400	`POOL_DEFINITION_NOT_FOUND`
`ERR_PRFTSHR_6`	400	`POOL_DEFINITION_CURRENCY_NOT_FOUND`

get-pool-definition-currency-map-by-id › path Parameters

id

string · uuid · required

poolDefinitionCurrencyMapId

string · uuid · required

get-pool-definition-currency-map-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.

currencyId

integer · int32

id

string · uuid

isActive

boolean

poolDefinitionId

string · uuid

update-pool-definition-currency-map

PUT

https://dg-sandbox.dgpays.com/profit-share-service

/pool-definitions/{id}/currencies/{poolDefinitionCurrencyMapId}

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
`ERR_PRFTSHR_1`	400	`POOL_DEFINITION_NOT_FOUND`
`ERR_PRFTSHR_6`	400	`POOL_DEFINITION_CURRENCY_NOT_FOUND`

update-pool-definition-currency-map › path Parameters

id

string · uuid · required

poolDefinitionCurrencyMapId

string · uuid · required

update-pool-definition-currency-map › Request Body

currencyNumber

string · required

isActive

boolean · required

update-pool-definition-currency-map › Responses

No data returned

delete-pool-definition-currency-map

DELETE

https://dg-sandbox.dgpays.com/profit-share-service

/pool-definitions/{id}/currencies/{poolDefinitionCurrencyMapId}

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
`ERR_PRFTSHR_1`	400	`POOL_DEFINITION_NOT_FOUND`
`ERR_PRFTSHR_6`	400	`POOL_DEFINITION_CURRENCY_NOT_FOUND`

delete-pool-definition-currency-map › path Parameters

id

string · uuid · required

poolDefinitionCurrencyMapId

string · uuid · required

delete-pool-definition-currency-map › Responses

No data returned

get-pool-product-map-list

GET

https://dg-sandbox.dgpays.com/profit-share-service

/pool-definitions/{id}/currencies/{poolDefinitionCurrencyMapId}/pool-product-maps

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

Field	Declared type	Nullable
`AccountProductId`	`Guid?`	yes
`ProductType`	`int?`	yes
`PoolDefinitionCurrencyMapId`	`Guid?`	yes

Member names are the service's declaration names.

Error codes this operation is known to raise

Code	Status	Meaning
`ERR_PRFTSHR_1`	400	`POOL_DEFINITION_NOT_FOUND`
`ERR_PRFTSHR_6`	400	`POOL_DEFINITION_CURRENCY_NOT_FOUND`

get-pool-product-map-list › path Parameters

id

string · uuid · required

poolDefinitionCurrencyMapId

string · uuid · required

get-pool-product-map-list › query Parameters

object

orderBy

string

orderSort

string

pageIndex

integer · int32

pageSize

integer · int32

get-pool-product-map-list › Responses

object[]

Array of catalog-declared response records.

accountProductId

string · uuid

id

string · uuid

poolDefinitionCurrencyMapId

string · uuid

productType

integer · int32

create-pool-product-map

POST

https://dg-sandbox.dgpays.com/profit-share-service

/pool-definitions/{id}/currencies/{poolDefinitionCurrencyMapId}/pool-product-maps

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

Response body, read from the service source

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
`ERR_PRFTSHR_1`	400	`POOL_DEFINITION_NOT_FOUND`
`ERR_PRFTSHR_6`	400	`POOL_DEFINITION_CURRENCY_NOT_FOUND`

create-pool-product-map › path Parameters

id

string · uuid · required

poolDefinitionCurrencyMapId

string · uuid · required

create-pool-product-map › Request Body

accountProductId

string · uuid · required

productType

integer · int32 · required

create-pool-product-map › 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.

get-pool-product-map-by-id

GET

https://dg-sandbox.dgpays.com/profit-share-service

/pool-definitions/{id}/currencies/{poolDefinitionCurrencyMapId}/pool-product-maps/{poolProductMapId}

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

Field	Declared type	Nullable
`AccountProductId`	`Guid?`	yes
`ProductType`	`int?`	yes
`PoolDefinitionCurrencyMapId`	`Guid?`	yes

Member names are the service's declaration names.

Error codes this operation is known to raise

Code	Status	Meaning
`ERR_PRFTSHR_1`	400	`POOL_DEFINITION_NOT_FOUND`
`ERR_PRFTSHR_42`	400	`POOL_PRODUCT_MAP_NOT_FOUND`
`ERR_PRFTSHR_6`	400	`POOL_DEFINITION_CURRENCY_NOT_FOUND`

get-pool-product-map-by-id › path Parameters

id

string · uuid · required

poolDefinitionCurrencyMapId

string · uuid · required

poolProductMapId

string · uuid · required

get-pool-product-map-by-id › Responses

accountProductId

string · uuid

id

string · uuid

poolDefinitionCurrencyMapId

string · uuid

productType

integer · int32

update-pool-product-map

PUT

https://dg-sandbox.dgpays.com/profit-share-service

/pool-definitions/{id}/currencies/{poolDefinitionCurrencyMapId}/pool-product-maps/{poolProductMapId}

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
`ERR_PRFTSHR_1`	400	`POOL_DEFINITION_NOT_FOUND`
`ERR_PRFTSHR_42`	400	`POOL_PRODUCT_MAP_NOT_FOUND`
`ERR_PRFTSHR_6`	400	`POOL_DEFINITION_CURRENCY_NOT_FOUND`

update-pool-product-map › path Parameters

id

string · uuid · required

poolDefinitionCurrencyMapId

string · uuid · required

poolProductMapId

string · uuid · required

update-pool-product-map › Request Body

accountProductId

string · uuid · required

productType

integer · int32 · required

update-pool-product-map › Responses

No data returned

delete-pool-product-map

DELETE

https://dg-sandbox.dgpays.com/profit-share-service

/pool-definitions/{id}/currencies/{poolDefinitionCurrencyMapId}/pool-product-maps/{poolProductMapId}

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
`ERR_PRFTSHR_1`	400	`POOL_DEFINITION_NOT_FOUND`
`ERR_PRFTSHR_42`	400	`POOL_PRODUCT_MAP_NOT_FOUND`
`ERR_PRFTSHR_6`	400	`POOL_DEFINITION_CURRENCY_NOT_FOUND`

delete-pool-product-map › path Parameters

id

string · uuid · required

poolDefinitionCurrencyMapId

string · uuid · required

poolProductMapId

string · uuid · required

delete-pool-product-map › Responses

No data returned

get-account-renewal-list

GET

https://dg-sandbox.dgpays.com/profit-share-service

/pool-definitions/{id}/currencies/{poolDefinitionCurrencyMapId}/pool-product-maps/{poolProductMapId}/account-renewals

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

Field	Declared type	Nullable
`AccountId`	`Guid?`	yes
`RenewalDate`	`DateOnly?`	yes
`GrossProfit`	`decimal?`	yes
`NetProfit`	`decimal?`	yes
`Tax`	`decimal?`	yes
`CurrentBalance`	`decimal?`	yes
`UnitValue`	`decimal?`	yes
`AccountValue`	`decimal?`	yes
`AccountProductId`	`Guid?`	yes
`MaturityBegin`	`DateOnly?`	yes
`MaturityTerm`	`DateOnly?`	yes
`PoolProductMapId`	`Guid?`	yes

Member names are the service's declaration names.

Error codes this operation is known to raise

Code	Status	Meaning
`ERR_PRFTSHR_1`	400	`POOL_DEFINITION_NOT_FOUND`
`ERR_PRFTSHR_42`	400	`POOL_PRODUCT_MAP_NOT_FOUND`
`ERR_PRFTSHR_6`	400	`POOL_DEFINITION_CURRENCY_NOT_FOUND`

get-account-renewal-list › path Parameters

id

string · uuid · required

poolDefinitionCurrencyMapId

string · uuid · required

poolProductMapId

string · uuid · required

get-account-renewal-list › query Parameters

object

orderBy

string

orderSort

string

pageIndex

integer · int32

pageSize

integer · int32

get-account-renewal-list › Responses

object[]

Array of catalog-declared response records.

accountId

string · uuid

accountProductId

string · uuid

accountValue

number · decimal

currentBalance

number · decimal

grossProfit

number · decimal

id

string · uuid

maturityBegin

string · date

maturityTerm

string · date

netProfit

number · decimal

poolProductMapId

string · uuid

renewalDate

string · date

tax

number

unitValue

number · decimal

GET/pool-definitions/{id}/currencies/{poolDefinitionCurrencyMapId}/pool-product-maps/{poolProductMapId}/account-renewals

curl https://dg-sandbox.dgpays.com/profit-share-service/pool-definitions/:id/currencies/:poolDefinitionCurrencyMapId/pool-product-maps/:poolProductMapId/account-renewals

Example Responses

[
  {
    "accountId": "00000000-0000-0000-0000-000000000000",
    "accountProductId": "00000000-0000-0000-0000-000000000000",
    "accountValue": 0,
    "currentBalance": 0,
    "grossProfit": 0,
    "id": "00000000-0000-0000-0000-000000000000",
    "maturityBegin": "2024-08-25",
    "maturityTerm": "2024-08-25",
    "netProfit": 0,
    "poolProductMapId": "00000000-0000-0000-0000-000000000000",
    "renewalDate": "2024-08-25",
    "tax": 0,
    "unitValue": 0
  }
]

json

application/json

create-account-renewal

POST

https://dg-sandbox.dgpays.com/profit-share-service

/pool-definitions/{id}/currencies/{poolDefinitionCurrencyMapId}/pool-product-maps/{poolProductMapId}/account-renewals

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

Response body, read from the service source

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
`ERR_PRFTSHR_1`	400	`POOL_DEFINITION_NOT_FOUND`
`ERR_PRFTSHR_42`	400	`POOL_PRODUCT_MAP_NOT_FOUND`
`ERR_PRFTSHR_6`	400	`POOL_DEFINITION_CURRENCY_NOT_FOUND`

create-account-renewal › path Parameters

id

string · uuid · required

poolDefinitionCurrencyMapId

string · uuid · required

poolProductMapId

string · uuid · required

create-account-renewal › Request Body

accountProductId

string · uuid · required

accountId

string · uuid

accountValue

number · decimal

currentBalance

number · decimal

grossProfit

number · decimal

maturityBegin

string · date

maturityTerm

string · date

netProfit

number · decimal

renewalDate

string · date

tax

number

unitValue

number · decimal

create-account-renewal › 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/pool-definitions/{id}/currencies/{poolDefinitionCurrencyMapId}/pool-product-maps/{poolProductMapId}/account-renewals

curl https://dg-sandbox.dgpays.com/profit-share-service/pool-definitions/:id/currencies/:poolDefinitionCurrencyMapId/pool-product-maps/:poolProductMapId/account-renewals \
  --request POST \
  --header 'Content-Type: application/json' \
  --data '{
  "accountId": "",
  "accountProductId": "",
  "accountValue": 0,
  "currentBalance": 0,
  "grossProfit": 0,
  "maturityBegin": "",
  "maturityTerm": "",
  "netProfit": 0,
  "renewalDate": "",
  "tax": 0,
  "unitValue": 0
}'

Example Request Body

{
  "accountId": "",
  "accountProductId": "",
  "accountValue": 0,
  "currentBalance": 0,
  "grossProfit": 0,
  "maturityBegin": "",
  "maturityTerm": "",
  "netProfit": 0,
  "renewalDate": "",
  "tax": 0,
  "unitValue": 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-renewal-by-id

GET

https://dg-sandbox.dgpays.com/profit-share-service

/pool-definitions/{id}/currencies/{poolDefinitionCurrencyMapId}/pool-product-maps/{poolProductMapId}/account-renewals/{accountRenewalId}

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

Field	Declared type	Nullable
`AccountId`	`Guid?`	yes
`RenewalDate`	`DateOnly?`	yes
`GrossProfit`	`decimal?`	yes
`NetProfit`	`decimal?`	yes
`Tax`	`decimal?`	yes
`CurrentBalance`	`decimal?`	yes
`UnitValue`	`decimal?`	yes
`AccountValue`	`decimal?`	yes
`AccountProductId`	`Guid?`	yes
`MaturityBegin`	`DateOnly?`	yes
`MaturityTerm`	`DateOnly?`	yes
`PoolProductMapId`	`Guid?`	yes

Member names are the service's declaration names.

Error codes this operation is known to raise

Code	Status	Meaning
`ERR_PRFTSHR_1`	400	`POOL_DEFINITION_NOT_FOUND`
`ERR_PRFTSHR_42`	400	`POOL_PRODUCT_MAP_NOT_FOUND`
`ERR_PRFTSHR_54`	400	`ACCOUNT_RENEWAL_NOT_FOUND`
`ERR_PRFTSHR_6`	400	`POOL_DEFINITION_CURRENCY_NOT_FOUND`

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

id

string · uuid · required

poolDefinitionCurrencyMapId

string · uuid · required

poolProductMapId

string · uuid · required

accountRenewalId

string · uuid · required

get-account-renewal-by-id › Responses

accountId

string · uuid

accountProductId

string · uuid

accountValue

number · decimal

currentBalance

number · decimal

grossProfit

number · decimal

id

string · uuid

maturityBegin

string · date

maturityTerm

string · date

netProfit

number · decimal

poolProductMapId

string · uuid

renewalDate

string · date

tax

number

unitValue

number · decimal

GET/pool-definitions/{id}/currencies/{poolDefinitionCurrencyMapId}/pool-product-maps/{poolProductMapId}/account-renewals/{accountRenewalId}

curl https://dg-sandbox.dgpays.com/profit-share-service/pool-definitions/:id/currencies/:poolDefinitionCurrencyMapId/pool-product-maps/:poolProductMapId/account-renewals/:accountRenewalId

Example Responses

{
  "accountId": "00000000-0000-0000-0000-000000000000",
  "accountProductId": "00000000-0000-0000-0000-000000000000",
  "accountValue": 0,
  "currentBalance": 0,
  "grossProfit": 0,
  "id": "00000000-0000-0000-0000-000000000000",
  "maturityBegin": "2024-08-25",
  "maturityTerm": "2024-08-25",
  "netProfit": 0,
  "poolProductMapId": "00000000-0000-0000-0000-000000000000",
  "renewalDate": "2024-08-25",
  "tax": 0,
  "unitValue": 0
}

json

application/json

update-account-renewal

PUT

https://dg-sandbox.dgpays.com/profit-share-service

/pool-definitions/{id}/currencies/{poolDefinitionCurrencyMapId}/pool-product-maps/{poolProductMapId}/account-renewals/{accountRenewalId}

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
`ERR_PRFTSHR_1`	400	`POOL_DEFINITION_NOT_FOUND`
`ERR_PRFTSHR_42`	400	`POOL_PRODUCT_MAP_NOT_FOUND`
`ERR_PRFTSHR_54`	400	`ACCOUNT_RENEWAL_NOT_FOUND`
`ERR_PRFTSHR_6`	400	`POOL_DEFINITION_CURRENCY_NOT_FOUND`

update-account-renewal › path Parameters

id

string · uuid · required

poolDefinitionCurrencyMapId

string · uuid · required

poolProductMapId

string · uuid · required

accountRenewalId

string · uuid · required

update-account-renewal › Request Body optional

accountId

string · uuid

accountProductId

string · uuid

accountValue

number · decimal

currentBalance

number · decimal

grossProfit

number · decimal

maturityBegin

string · date

maturityTerm

string · date

netProfit

number · decimal

renewalDate

string · date

tax

number

unitValue

number · decimal

update-account-renewal › Responses

No data returned

PUT/pool-definitions/{id}/currencies/{poolDefinitionCurrencyMapId}/pool-product-maps/{poolProductMapId}/account-renewals/{accountRenewalId}

curl https://dg-sandbox.dgpays.com/profit-share-service/pool-definitions/:id/currencies/:poolDefinitionCurrencyMapId/pool-product-maps/:poolProductMapId/account-renewals/:accountRenewalId \
  --request PUT \
  --header 'Content-Type: application/json' \
  --data '{
  "accountId": "",
  "accountProductId": "",
  "accountValue": 0,
  "currentBalance": 0,
  "grossProfit": 0,
  "maturityBegin": "",
  "maturityTerm": "",
  "netProfit": 0,
  "renewalDate": "",
  "tax": 0,
  "unitValue": 0
}'

Example Request Body

{
  "accountId": "",
  "accountProductId": "",
  "accountValue": 0,
  "currentBalance": 0,
  "grossProfit": 0,
  "maturityBegin": "",
  "maturityTerm": "",
  "netProfit": 0,
  "renewalDate": "",
  "tax": 0,
  "unitValue": 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-renewal

DELETE

https://dg-sandbox.dgpays.com/profit-share-service

/pool-definitions/{id}/currencies/{poolDefinitionCurrencyMapId}/pool-product-maps/{poolProductMapId}/account-renewals/{accountRenewalId}

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
`ERR_PRFTSHR_1`	400	`POOL_DEFINITION_NOT_FOUND`
`ERR_PRFTSHR_42`	400	`POOL_PRODUCT_MAP_NOT_FOUND`
`ERR_PRFTSHR_54`	400	`ACCOUNT_RENEWAL_NOT_FOUND`
`ERR_PRFTSHR_6`	400	`POOL_DEFINITION_CURRENCY_NOT_FOUND`

delete-account-renewal › path Parameters

id

string · uuid · required

poolDefinitionCurrencyMapId

string · uuid · required

poolProductMapId

string · uuid · required

accountRenewalId

string · uuid · required

delete-account-renewal › Responses

No data returned

get-pool-definition-rate-list

GET

https://dg-sandbox.dgpays.com/profit-share-service

/pool-definitions/{id}/rates

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

Field	Declared type	Nullable
`Id`	`Guid`	no
`CustomerProfitRate`	`decimal?`	yes
`BankProfitRate`	`decimal?`	yes
`CustomerLossRate`	`decimal?`	yes
`BankLossRate`	`decimal?`	yes
`PerRate`	`decimal?`	yes
`IrrRate`	`decimal?`	yes
`Currencies`	`IEnumerable<PoolDefinitionRateCurrencyMapDto>` (collection)	no

Member names are the service's declaration names.

get-pool-definition-rate-list › path Parameters

id

string · required

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

get-pool-definition-rate-list › Responses

Success. The catalog declares no response fields for this operation. It returns a collection of records — but the record's fields are not declared.

No data returned

create-pool-definition-rate

POST

https://dg-sandbox.dgpays.com/profit-share-service

/pool-definitions/{id}/rates

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

Response body, read from the service source

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
`ERR_PRFTSHR_1`	400	`POOL_DEFINITION_NOT_FOUND`

create-pool-definition-rate › path Parameters

id

string · uuid · required

create-pool-definition-rate › Request Body

bankLossRate

number · decimal · required

bankProfitRate

number · decimal · required

customerLossRate

number · decimal · required

customerProfitRate

number · decimal · required

irrRate

number · decimal · required

perRate

number · decimal · required

create-pool-definition-rate › 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.

get-pool-definition-rate-by-id

GET

https://dg-sandbox.dgpays.com/profit-share-service

/pool-definitions/{id}/rates/{poolDefinitionRateId}

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

Field	Declared type	Nullable
`Id`	`Guid`	no
`CustomerProfitRate`	`decimal?`	yes
`BankProfitRate`	`decimal?`	yes
`CustomerLossRate`	`decimal?`	yes
`BankLossRate`	`decimal?`	yes
`PerRate`	`decimal?`	yes
`IrrRate`	`decimal?`	yes
`Currencies`	`IEnumerable<PoolDefinitionRateCurrencyMapDto>` (collection)	no

Member names are the service's declaration names.

Error codes this operation is known to raise

Code	Status	Meaning
`ERR_PRFTSHR_1`	400	`POOL_DEFINITION_NOT_FOUND`
`ERR_PRFTSHR_44`	400	`POOL_DEFINITION_RATE_NOT_FOUND`

get-pool-definition-rate-by-id › path Parameters

id

string · required

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

poolDefinitionRateId

string · required

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

get-pool-definition-rate-by-id › Responses

No data returned

update-pool-definition-rate

PUT

https://dg-sandbox.dgpays.com/profit-share-service

/pool-definitions/{id}/rates/{poolDefinitionRateId}

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
`ERR_PRFTSHR_1`	400	`POOL_DEFINITION_NOT_FOUND`
`ERR_PRFTSHR_44`	400	`POOL_DEFINITION_RATE_NOT_FOUND`

update-pool-definition-rate › path Parameters

id

string · uuid · required

poolDefinitionRateId

string · uuid · required

update-pool-definition-rate › Request Body

bankLossRate

number · decimal · required

bankProfitRate

number · decimal · required

customerLossRate

number · decimal · required

customerProfitRate

number · decimal · required

irrRate

number · decimal · required

perRate

number · decimal · required

update-pool-definition-rate › Responses

No data returned

delete-pool-definition-rate

DELETE

https://dg-sandbox.dgpays.com/profit-share-service

/pool-definitions/{id}/rates/{poolDefinitionRateId}

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
`ERR_PRFTSHR_1`	400	`POOL_DEFINITION_NOT_FOUND`
`ERR_PRFTSHR_44`	400	`POOL_DEFINITION_RATE_NOT_FOUND`

delete-pool-definition-rate › path Parameters

id

string · uuid · required

poolDefinitionRateId

string · uuid · required

delete-pool-definition-rate › Responses

No data returned