currencies

Operations addressed under /currencies — 8 operations.

get-currency-list

GET

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

/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<CurrencyDto>.

Field	Declared type	Nullable
`Code`	`string`	no
`Name`	`string`	no
`SubUnitName`	`string`	no
`Numeric`	`string`	no
`Group`	`string`	no
`CurrencyDecimal`	`int`	no
`Translations`	`IEnumerable<CurrencyTranslationDto>` (collection)	no

Member names are the service's declaration names.

get-currency-list › query Parameters

object

orderBy

string

orderSort

string

pageIndex

integer · int32

pageSize

integer · int32

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

code

string

group

string

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

Value	Token	Labels
`1`	`FX`	no label seeded
`2`	`PM`	no label seeded

id

integer · int32

name

string

numeric

string

object[]

create-currency

POST

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

/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 returns AuraCommandDto<int>, 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 int. 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`	`int`	no

Member names are the service's declaration names.

Error codes this operation is known to raise

Code	Status	Meaning	Message
`ERR_CORE_6`	400	`CURRENCY_EXISTS_WITH_THIS_NUMERIC`	Cannot be defined with the same numeric code: `{0}`.
`ERR_CORE_7`	400	`CURRENCY_EXISTS_WITH_SAME_CODE`	Cannot be defined with the same currency code: `{0}`.

create-currency › Request Body

code

string · required

currencyDecimal

integer · int32 · required

group

string · required

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

Value	Token	Labels
`1`	`FX`	no label seeded
`2`	`PM`	no label seeded

numeric

string · required

object[] · required

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

anyOf

At least one variant must match. Multiple variants may match simultaneously.

Decision Table

Variant	Matching Criteria
	type = object
	type = array
	type = object · requires: data

Properties for Variant 1:

id

string · uuid

convert-currency-amount-to-text-by-code

POST

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

/currencies/by-code/{code}/convert-amount-to-text

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_CORE_11`	400	`CURRENCY_ID_IS_NOT_FOUND`

convert-currency-amount-to-text-by-code › path Parameters

code

string · required

convert-currency-amount-to-text-by-code › Request Body

amount

number · decimal · required

languageCode

string · required

convert-currency-amount-to-text-by-code › 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.

anyOf

At least one variant must match. Multiple variants may match simultaneously.

Decision Table

Variant	Matching Criteria
	type = object
	type = array
	type = object · requires: data

Properties for Variant 1:

textCurrencyAmount

string

get-currency-by-numeric

GET

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

/currencies/by-numeric/{numeric}

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

Field	Declared type	Nullable
`Code`	`string`	no
`Name`	`string`	no
`SubUnitName`	`string`	no
`Numeric`	`string`	no
`Group`	`string`	no
`CurrencyDecimal`	`int`	no
`Translations`	`IEnumerable<CurrencyTranslationDto>` (collection)	no

Member names are the service's declaration names.

get-currency-by-numeric › path Parameters

numeric

string · required

get-currency-by-numeric › 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.

code

string

group

string

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

Value	Token	Labels
`1`	`FX`	no label seeded
`2`	`PM`	no label seeded

id

integer · int32

name

string

numeric

string

get-currency-by-id

GET

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

/currencies/{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 CurrencyDto.

Field	Declared type	Nullable
`Code`	`string`	no
`Name`	`string`	no
`SubUnitName`	`string`	no
`Numeric`	`string`	no
`Group`	`string`	no
`CurrencyDecimal`	`int`	no
`Translations`	`IEnumerable<CurrencyTranslationDto>` (collection)	no

Member names are the service's declaration names.

get-currency-by-id › path Parameters

id

integer · int32 · required

get-currency-by-id › Responses

code

string

group

string

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

Value	Token	Labels
`1`	`FX`	no label seeded
`2`	`PM`	no label seeded

id

integer · int32

name

string

numeric

string

update-currency

PUT

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

/currencies/{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_CORE_10`	400	`CURRENCY_EXISTS_WITH_THIS_CODE`	Currency code is defined on another currency: `{0}`.
`ERR_CORE_11`	400	`CURRENCY_ID_IS_NOT_FOUND`	not published in this snapshot

update-currency › path Parameters

id

integer · int32 · required

update-currency › Request Body

code

string · required

group

string · required

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

Value	Token	Labels
`1`	`FX`	no label seeded
`2`	`PM`	no label seeded

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

DELETE

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

/currencies/{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_CORE_11`	400	`CURRENCY_ID_IS_NOT_FOUND`

delete-currency › path Parameters

id

integer · int32 · required

delete-currency › Responses

No data returned

convert-currency-amount-to-text

POST

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

/currencies/{id}/convert-amount-to-text

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_CORE_11`	400	`CURRENCY_ID_IS_NOT_FOUND`

convert-currency-amount-to-text › path Parameters

id

integer · int32 · required

convert-currency-amount-to-text › Request Body

amount

number · decimal · required

languageCode

string · required

convert-currency-amount-to-text › 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.

anyOf

At least one variant must match. Multiple variants may match simultaneously.

Decision Table

Variant	Matching Criteria
	type = object
	type = array
	type = object · requires: data

Properties for Variant 1:

textCurrencyAmount

string

countries customer-loan-collections