key-formats

Operations addressed under /key-formats — 10 operations.

customer-get-key-format-list

GET

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

/key-formats

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

customer-get-key-format-list › query Parameters

object

orderBy

string

orderSort

string

pageIndex

integer · int32

pageSize

integer · int32

customer-get-key-format-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

description

string

id

string · uuid

isActive

boolean

maxLength

integer · int32

customer-create-key-format

POST

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

/key-formats

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

customer-create-key-format › Request Body

code

string · required

isActive

boolean · required

maxLength

integer · int32 · required

object[] · required

customer-create-key-format › 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.

id

string · uuid

customer-get-key-format-id-by-code

GET

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

/key-formats/by-code/{code}

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

customer-get-key-format-id-by-code › path Parameters

code

string · required

customer-get-key-format-id-by-code › Responses

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

No data returned

customer-reset-key-format-counter-by-code

PUT

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

/key-formats/by-code/{code}/reset-counter

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

customer-reset-key-format-counter-by-code › path Parameters

code

string · required

customer-reset-key-format-counter-by-code › Responses

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

No data returned

customer-get-key-format-by-id

GET

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

/key-formats/{id}

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

customer-get-key-format-by-id › path Parameters

id

string · uuid · required

customer-get-key-format-by-id › Responses

code

string

description

string

id

string · uuid

isActive

boolean

maxLength

integer · int32

customer-update-key-format

PUT

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

/key-formats/{id}

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

customer-update-key-format › path Parameters

id

string · uuid · required

customer-update-key-format › Request Body

isActive

boolean · required

maxLength

integer · int32 · required

object[] · required

customer-update-key-format › Responses

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

No data returned

customer-get-key-format-item-id-by-key-format-id

GET

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

/key-formats/{id}/item-summaries

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

customer-get-key-format-item-id-by-key-format-id › path Parameters

id

string · uuid · required

customer-get-key-format-item-id-by-key-format-id › Responses

object[]

customer-get-key-format-item-by-key-format-id

GET

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

/key-formats/{id}/items

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

customer-get-key-format-item-by-key-format-id › path Parameters

id

string · uuid · required

customer-get-key-format-item-by-key-format-id › Responses

object[]

customer-create-key-format-item

POST

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

/key-formats/{id}/items

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

customer-create-key-format-item › path Parameters

id

string · uuid · required

customer-create-key-format-item › Request Body

object[] · required

customer-create-key-format-item › Responses

object[]

POST/key-formats/{id}/items

curl https://dg-sandbox.dgpays.com/customer-service/key-formats/:id/items \
  --request POST \
  --header 'Content-Type: application/json' \
  --data '{
  "itemList": [
    {
      "defaultValue": "",
      "hasPadding": "",
      "itemLength": 0,
      "itemSequence": 0,
      "itemValue": "",
      "paddingDirection": "",
      "seperator": "",
      "translations": [
        {
          "languageCode": "",
          "name": ""
        }
      ],
      "type": 0
    }
  ]
}'

Example Request Body

{
  "itemList": [
    {
      "defaultValue": "",
      "hasPadding": "",
      "itemLength": 0,
      "itemSequence": 0,
      "itemValue": "",
      "paddingDirection": "",
      "seperator": "",
      "translations": [
        {
          "languageCode": "",
          "name": ""
        }
      ],
      "type": 0
    }
  ]
}

json

The field names and types this operation declares. Replace the values before sending.

application/json

Example Responses

{
  "itemList": [
    {
      "itemId": "00000000-0000-0000-0000-000000000000",
      "name": "name"
    }
  ]
}

json

application/json

customer-delete-key-format-item

DELETE

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

/key-formats/{id}/items/{itemId}

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

customer-delete-key-format-item › path Parameters

id

string · uuid · required

itemId

string · uuid · required

customer-delete-key-format-item › Responses

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

No data returned

identity-types localizations