customers--relationships

Operations addressed under /customers — 126 operations.

Rendered section: This page contains the relationships route group from customers. This is a presentation-only partition; it does not change the API contract or operation tags in the downloadable OpenAPI.

get-customer-relationship-list

GET

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

/customers/relationships

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

get-customer-relationship-list › query Parameters

object

orderBy

string

orderSort

string

pageIndex

integer · int32

pageSize

integer · int32

get-customer-relationship-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.

object[]

description

string

endDate

string · date

fromCustomerId

string · uuid

id

string · uuid

relationType

integer · int32

startDate

string · date-time

toCitizenid

string

toCustomerId

string · uuid

GET/customers/relationships

curl https://dg-sandbox.dgpays.com/customer-service/customers/relationships

Example Responses

[
  {
    "customerShareholders": [
      {
        "customerRelationshipId": "00000000-0000-0000-0000-000000000000",
        "endDate": "2024-08-25",
        "id": "00000000-0000-0000-0000-000000000000",
        "shareRate": 0,
        "startDate": "2024-08-25T15:00:00Z"
      }
    ],
    "description": "description",
    "endDate": "2024-08-25",
    "fromCustomerId": "00000000-0000-0000-0000-000000000000",
    "id": "00000000-0000-0000-0000-000000000000",
    "relationType": 0,
    "startDate": "2024-08-25T15:00:00Z",
    "toCitizenid": "toCitizenid",
    "toCustomerId": "00000000-0000-0000-0000-000000000000"
  }
]

json

application/json

get-customer-shareholder-list

GET

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

/customers/relationships/shareholders

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

get-customer-shareholder-list › query Parameters

object

orderBy

string

orderSort

string

pageIndex

integer · int32

pageSize

integer · int32

get-customer-shareholder-list › Responses

object[]

Array of catalog-declared response records.

customerRelationshipId

string · uuid

endDate

string · date-time

id

string · uuid

shareRate

number · decimal

startDate

string · date-time

get-customer-relationship-list-by-customer-id

GET

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

/customers/{id}/relationships

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

get-customer-relationship-list-by-customer-id › path Parameters

id

string · uuid · required

get-customer-relationship-list-by-customer-id › query Parameters

orderBy

string

orderSort

string

pageIndex

integer · int32

pageSize

integer · int32

get-customer-relationship-list-by-customer-id › Responses

object[]

Array of catalog-declared response records.

object[]

description

string

endDate

string · date

fromCustomerId

string · uuid

id

string · uuid

relationType

integer · int32

startDate

string · date-time

toCitizenid

string

toCustomerId

string · uuid

GET/customers/{id}/relationships

curl https://dg-sandbox.dgpays.com/customer-service/customers/:id/relationships

Example Responses

[
  {
    "customerShareholders": [
      {
        "customerRelationshipId": "00000000-0000-0000-0000-000000000000",
        "endDate": "2024-08-25",
        "id": "00000000-0000-0000-0000-000000000000",
        "shareRate": 0,
        "startDate": "2024-08-25T15:00:00Z"
      }
    ],
    "description": "description",
    "endDate": "2024-08-25",
    "fromCustomerId": "00000000-0000-0000-0000-000000000000",
    "id": "00000000-0000-0000-0000-000000000000",
    "relationType": 0,
    "startDate": "2024-08-25T15:00:00Z",
    "toCitizenid": "toCitizenid",
    "toCustomerId": "00000000-0000-0000-0000-000000000000"
  }
]

json

application/json

create-customer-relationship

POST

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

/customers/{id}/relationships

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

create-customer-relationship › path Parameters

id

string · uuid · required

create-customer-relationship › Request Body

relationType

integer · int32 · required

description

string

endDate

string · date

startDate

string · date-time

toCitizenid

string

toCustomerId

string · uuid

create-customer-relationship › 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

get-customer-relationship-by-id

GET

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

/customers/{id}/relationships/{relationshipId}

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

get-customer-relationship-by-id › path Parameters

id

string · uuid · required

relationshipId

string · uuid · required

get-customer-relationship-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.

object[]

description

string

endDate

string · date

fromCustomerId

string · uuid

id

string · uuid

relationType

integer · int32

startDate

string · date-time

toCitizenid

string

toCustomerId

string · uuid

GET/customers/{id}/relationships/{relationshipId}

curl https://dg-sandbox.dgpays.com/customer-service/customers/:id/relationships/:relationshipId

Example Responses

{
  "customerShareholders": [
    {
      "customerRelationshipId": "00000000-0000-0000-0000-000000000000",
      "endDate": "2024-08-25",
      "id": "00000000-0000-0000-0000-000000000000",
      "shareRate": 0,
      "startDate": "2024-08-25T15:00:00Z"
    }
  ],
  "description": "description",
  "endDate": "2024-08-25",
  "fromCustomerId": "00000000-0000-0000-0000-000000000000",
  "id": "00000000-0000-0000-0000-000000000000",
  "relationType": 0,
  "startDate": "2024-08-25T15:00:00Z",
  "toCitizenid": "toCitizenid",
  "toCustomerId": "00000000-0000-0000-0000-000000000000"
}

json

application/json

update-customer-relationship

PUT

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

/customers/{id}/relationships/{relationshipId}

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

update-customer-relationship › path Parameters

id

string · uuid · required

relationshipId

string · uuid · required

update-customer-relationship › Request Body

relationType

integer · int32 · required

description

string

endDate

string · date

startDate

string · date-time

toCitizenid

string

toCustomerId

string · uuid

update-customer-relationship › Responses

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

No data returned

delete-customer-relationship

DELETE

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

/customers/{id}/relationships/{relationshipId}

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

delete-customer-relationship › path Parameters

id

string · uuid · required

relationshipId

string · uuid · required

delete-customer-relationship › Responses

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

No data returned

get-customer-shareholder-list-by-relationship-id

GET

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

/customers/{id}/relationships/{relationshipId}/shareholders

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

get-customer-shareholder-list-by-relationship-id › path Parameters

id

string · uuid · required

relationshipId

string · uuid · required

get-customer-shareholder-list-by-relationship-id › query Parameters

orderBy

string

orderSort

string

pageIndex

integer · int32

pageSize

integer · int32

get-customer-shareholder-list-by-relationship-id › Responses

object[]

Array of catalog-declared response records.

customerRelationshipId

string · uuid

endDate

string · date-time

id

string · uuid

shareRate

number · decimal

startDate

string · date-time

create-customer-shareholder

POST

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

/customers/{id}/relationships/{relationshipId}/shareholders

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

create-customer-shareholder › path Parameters

id

string · uuid · required

relationshipId

string · uuid · required

create-customer-shareholder › Request Body

shareRate

number · decimal · required

startDate

string · date-time · required

endDate

string · date-time

create-customer-shareholder › 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

get-customer-shareholder-by-id

GET

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

/customers/{id}/relationships/{relationshipId}/shareholders/{shareholderId}

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

get-customer-shareholder-by-id › path Parameters

id

string · uuid · required

relationshipId

string · uuid · required

shareholderId

string · uuid · required

get-customer-shareholder-by-id › Responses

customerRelationshipId

string · uuid

endDate

string · date-time

id

string · uuid

shareRate

number · decimal

startDate

string · date-time

update-customer-shareholder

PUT

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

/customers/{id}/relationships/{relationshipId}/shareholders/{shareholderId}

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

update-customer-shareholder › path Parameters

id

string · uuid · required

relationshipId

string · uuid · required

shareholderId

string · uuid · required

update-customer-shareholder › Request Body

shareRate

number · decimal · required

startDate

string · date-time · required

endDate

string · date-time

update-customer-shareholder › Responses

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

No data returned

delete-customer-shareholder

DELETE

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

/customers/{id}/relationships/{relationshipId}/shareholders/{shareholderId}

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

delete-customer-shareholder › path Parameters

id

string · uuid · required

relationshipId

string · uuid · required

shareholderId

string · uuid · required

delete-customer-shareholder › Responses

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

No data returned

customers--publish-create-virtual-iban customers--residentials