committees

Operations addressed under /committees — 5 operations.

aurax-bff-get-committee-list

GET

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

/committees

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-committee-list; this entry declares none of its own.

Response body, read from the service source

The route declares its response as IEnumerable<CommitteeDto>.

Field	Declared type	Nullable
`IsActive`	`bool`	no
`CommitteeName`	`string`	no
`RequiredSignerCount`	`int`	no
`MaxAuthorizationLimitAmount`	`decimal`	no
`Signatories`	`List<CommitteeSignatoryDto>` (collection)	no

Member names are the service's declaration names.

aurax-bff-get-committee-list › query Parameters

object

orderBy

string

orderSort

string

pageIndex

integer · int32

pageSize

integer · int32

aurax-bff-get-committee-list › Responses

Success. Returns a page of records: the collection under data, with total carrying the unpaged count.

Paged response envelope observed on the BFF response path.

object[] · required

Response records carried by this page.

total

integer · int64

Total matching records, ignoring paging.

aurax-bff-create-committee-ui-bpmn

POST

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

/committees

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 create-committee-ui-bpmn; this entry declares none of its own.

aurax-bff-create-committee-ui-bpmn › Request Body

committeeName

string · required

maxAuthorizationLimitAmount

number · decimal · required

requiredSignerCount

integer · int32 · required

object[] · required

aurax-bff-create-committee-ui-bpmn › Responses

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

No data returned

aurax-bff-get-committee-by-id

GET

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

/committees/{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-committee-by-id; this entry declares none of its own.

Response body, read from the service source

The route declares its response as CommitteeDto.

Field	Declared type	Nullable
`IsActive`	`bool`	no
`CommitteeName`	`string`	no
`RequiredSignerCount`	`int`	no
`MaxAuthorizationLimitAmount`	`decimal`	no
`Signatories`	`List<CommitteeSignatoryDto>` (collection)	no

Member names are the service's declaration names.

Error codes this operation is known to raise

Code	Status	Meaning	Message
`ERR_COMMITTEE_3`	400	`COMMITTEE_NOT_FOUND`	Committee not found. Id: `{0}`

aurax-bff-get-committee-by-id › path Parameters

id

string · uuid · required

aurax-bff-get-committee-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.

committeeName

string

id

string · uuid

isActive

boolean

maxAuthorizationLimitAmount

number · decimal

requiredSignerCount

integer · int32

object[]

aurax-bff-update-committee-ui-bpmn

PUT

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

/committees/{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 update-committee-ui-bpmn; this entry declares none of its own.

aurax-bff-update-committee-ui-bpmn › path Parameters

id

string · uuid · required

aurax-bff-update-committee-ui-bpmn › Request Body

committeeName

string · required

isActive

boolean · required

maxAuthorizationLimitAmount

number · decimal · required

requiredSignerCount

integer · int32 · required

object[]

aurax-bff-update-committee-ui-bpmn › Responses

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

No data returned

PUT/committees/{id}

curl https://dg-sandbox.dgpays.com/aurax-bff-service/committees/:id \
  --request PUT \
  --header 'Content-Type: application/json' \
  --data '{
  "committeeName": "",
  "isActive": false,
  "maxAuthorizationLimitAmount": 0,
  "requiredSignerCount": 0,
  "signatories": [
    {
      "_rowStatus": 0,
      "id": "",
      "userId": ""
    }
  ]
}'

Example Request Body

{
  "committeeName": "",
  "isActive": false,
  "maxAuthorizationLimitAmount": 0,
  "requiredSignerCount": 0,
  "signatories": [
    {
      "_rowStatus": 0,
      "id": "",
      "userId": ""
    }
  ]
}

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

aurax-bff-delete-committee-ui-bpmn

DELETE

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

/committees/{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 delete-committee-ui-bpmn; this entry declares none of its own.

aurax-bff-delete-committee-ui-bpmn › path Parameters

id

string · uuid · required

aurax-bff-delete-committee-ui-bpmn › Responses

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

No data returned

collaterals compensating-transactions