consent-items

Operations addressed under /consent-items — 16 operations.

POST

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

/consent-items

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

code

string · required

description

string · required

documentItemId

string · uuid · required

name

string · required

templateDesignId

string · uuid · required

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

GET

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

/consent-items/by-customer-id/{customerId}

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

customerId

string · uuid · required

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

GET

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

/consent-items/dimensions

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

object

orderBy

string

orderSort

string

pageIndex

integer · int32

pageSize

integer · int32

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.

consentItemId

string · uuid

id

string · uuid

isActive

boolean

transactionType

integer · int32

GET

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

/consent-items/{id}

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

id

string · uuid · required

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

object[]

description

string

documentItemId

string · uuid

id

string · uuid

isActive

boolean

name

string

templateDesignId

string · uuid

object[]

GET/consent-items/{id}

curl https://dg-sandbox.dgpays.com/customer-service/consent-items/:id

Example Responses

{
  "code": "code",
  "consentItemDimensions": [
    {
      "consentItemId": "00000000-0000-0000-0000-000000000000",
      "id": "00000000-0000-0000-0000-000000000000",
      "isActive": true,
      "transactionType": 0
    }
  ],
  "consentServiceMaps": [
    {
      "code": "code",
      "consentItemId": "00000000-0000-0000-0000-000000000000",
      "description": "description",
      "documentItemId": "00000000-0000-0000-0000-000000000000",
      "id": "00000000-0000-0000-0000-000000000000",
      "isActive": true,
      "name": "name",
      "necessity": 0,
      "processDefinitionId": "00000000-0000-0000-0000-000000000000",
      "sequenceNumber": 0,
      "templateDesignId": "00000000-0000-0000-0000-000000000000"
    }
  ],
  "description": "description",
  "documentItemId": "00000000-0000-0000-0000-000000000000",
  "id": "00000000-0000-0000-0000-000000000000",
  "isActive": true,
  "name": "name",
  "templateDesignId": "00000000-0000-0000-0000-000000000000",
  "translations": [
    {
      "languageCode": "languageCode",
      "name": "name"
    }
  ]
}

json

application/json

PUT

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

/consent-items/{id}

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

id

string · uuid · required

description

string · required

documentItemId

string · uuid · required

isActive

boolean · required

name

string · required

templateDesignId

string · uuid · required

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

No data returned

DELETE

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

/consent-items/{id}

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

id

string · uuid · required

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

No data returned

POST

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

/consent-items/{id}/consent-service-maps

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

id

string · uuid · required

necessity

integer · int32 · required

partnerId

string · uuid · required

processDefinitionId

string · uuid · required

sequenceNumber

integer · int32 · required

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

GET

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

/consent-items/{id}/consent-service-maps/{consentServiceMapId}

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

id

string · uuid · required

consentServiceMapId

string · uuid · required

code

string

consentItemId

string · uuid

description

string

documentItemId

string · uuid

id

string · uuid

isActive

boolean

name

string

necessity

integer · int32

processDefinitionId

string · uuid

sequenceNumber

integer · int32

templateDesignId

string · uuid

PUT

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

/consent-items/{id}/consent-service-maps/{consentServiceMapId}

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

id

string · uuid · required

consentServiceMapId

string · uuid · required

isActive

boolean · required

necessity

integer · int32 · required

sequenceNumber

integer · int32 · required

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

No data returned

DELETE

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

/consent-items/{id}/consent-service-maps/{consentServiceMapId}

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

id

string · uuid · required

consentServiceMapId

string · uuid · required

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

No data returned

POST

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

/consent-items/{id}/dimensions

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

id

string · uuid · required

transactionType

integer · int32 · required

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

GET

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

/consent-items/{id}/dimensions/{consentItemDimensionId}

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

id

string · uuid · required

consentItemDimensionId

string · uuid · required

consentItemId

string · uuid

id

string · uuid

isActive

boolean

transactionType

integer · int32

PUT

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

/consent-items/{id}/dimensions/{consentItemDimensionId}

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

id

string · uuid · required

consentItemDimensionId

string · uuid · required

isActive

boolean · required

transactionType

integer · int32 · required

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

No data returned

DELETE

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

/consent-items/{id}/dimensions/{consentItemDimensionId}

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

id

string · uuid · required

consentItemDimensionId

string · uuid · required

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

No data returned

GET

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

/consent-items/{id}/dimensions/{consentItemDimensionId}/usage

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

id

string · uuid · required

consentItemDimensionId

string · uuid · required

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

No data returned

GET

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

/consent-items/{id}/usage

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

id

string · uuid · required

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

No data returned

compensating-transactions consents

consent-items

create-consent-item

create-consent-item › Request Body

create-consent-item › Responses

Decision Table

get-consent-item-list-by-customer-id

get-consent-item-list-by-customer-id › path Parameters

get-consent-item-list-by-customer-id › Responses

get-consent-item-dimension-list

get-consent-item-dimension-list › query Parameters

get-consent-item-dimension-list › Responses

get-consent-item-by-id

get-consent-item-by-id › path Parameters

get-consent-item-by-id › Responses

update-consent-item

update-consent-item › path Parameters

update-consent-item › Request Body

update-consent-item › Responses

delete-consent-item

delete-consent-item › path Parameters

delete-consent-item › Responses

create-consent-service-map

create-consent-service-map › path Parameters

create-consent-service-map › Request Body

create-consent-service-map › Responses

Decision Table

get-consent-service-map-by-id

get-consent-service-map-by-id › path Parameters

get-consent-service-map-by-id › Responses

update-consent-service-map

update-consent-service-map › path Parameters

update-consent-service-map › Request Body

update-consent-service-map › Responses

delete-consent-service-map

delete-consent-service-map › path Parameters

delete-consent-service-map › Responses

create-consent-item-dimension

create-consent-item-dimension › path Parameters

create-consent-item-dimension › Request Body

create-consent-item-dimension › Responses

Decision Table

get-consent-item-dimension-by-id

get-consent-item-dimension-by-id › path Parameters

get-consent-item-dimension-by-id › Responses

update-consent-item-dimension

update-consent-item-dimension › path Parameters

update-consent-item-dimension › Request Body

update-consent-item-dimension › Responses

delete-consent-item-dimension

delete-consent-item-dimension › path Parameters

delete-consent-item-dimension › Responses

has-consent-item-dimension-usage

has-consent-item-dimension-usage › path Parameters

has-consent-item-dimension-usage › Responses

has-consent-item-usage

has-consent-item-usage › path Parameters

has-consent-item-usage › Responses