Permissions and restrictions

Turn individual capabilities on and off for a card — e-commerce, international use, mail order and other miscellaneous options.

getCardPermissions

POST

https://everest-sandboxapi.dgpays.com/SandBox

/IntegrationDigitalChannelCredit/credit/api/getCardPermissions

Retrieves permission restrictions for a credit card by shadow card number. Maps results from Lifecycle service to CreditCardPermissions objects including restriction codes, descriptions, permission indicators, channel, and security flags.

Part of:

Journey 02 · Managing a card product — step 1, Read current controls

getCardPermissions › Headers

evrst-ptrnid

string

Correlation id for this request. Echo it in your own logs to trace the call through the platform.

Default: x_request_id

getCardPermissions › Request Body

GetCardPermissionsRequest

shadowCardNumber

string · required

Required · NotNullOrWhiteSpace — The card whose permissions are read.

getCardPermissions › Responses

Success

GetCardPermissionsResponse

array | null

Card Permissions List - [Optional]

POST/IntegrationDigitalChannelCredit/credit/api/getCardPermissions

curl https://everest-sandboxapi.dgpays.com/SandBox/IntegrationDigitalChannelCredit/credit/api/getCardPermissions \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'evrst-ptrnid: x_request_id' \
  --data '{
  "shadowCardNumber": "shadowCardNumber"
}'

Example Request Body

{
  "shadowCardNumber": "shadowCardNumber"
}

json

application/json

Example Responses

{
  "cardPermissionsList": [
    {
      "restrictionCode": "restrictionCode",
      "restrictionCodeDescription": "restrictionCodeDescription",
      "restrictionPermissionIndicator": "restrictionPermissionIndicator",
      "restrictionPermissionIndicatorDescription": "restrictionPermissionIndicatorDescription",
      "channel": "002",
      "securityFlag": true
    }
  ]
}

json

application/json

saveCardPermissions

POST

https://everest-sandboxapi.dgpays.com/SandBox

/IntegrationDigitalChannelCredit/credit/api/saveCardPermissions

Saves the card permissions including restrictions, start date, end date, and transaction ID for the specified card.

Part of:

Journey 02 · Managing a card product — step 2, Update permissions

saveCardPermissions › Headers

evrst-ptrnid

string

Correlation id for this request. Echo it in your own logs to trace the call through the platform.

Default: x_request_id

saveCardPermissions › Request Body

SaveCardPermissionsRequest

channel

string · required

Required · Enum · NotNull — Three-digit channel code. Must be a defined channel.

Example: 002

SaveCardPermissionsRequestItem[] · required

Required · NotNull — The permissions to write. Must be sent; an empty list is accepted and changes nothing.

cardRefNumber

string | null

One-of · NotNull — The card to permit or restrict. Send this or shadowCardNumber; sending neither is refused with both named.

shadowCardNumber

string | null

One-of · NotNull — The card to permit or restrict. Send this or cardRefNumber; when both are sent this one finds the card.

saveCardPermissions › Responses

Success

SaveCardPermissionsResponse

changedCount

integer · int32 · required

How many entries actually changed. An entry already holding the value it was sent is skipped, so this can be lower than the number sent — and zero is a success.

listOfRecordId

array | null

List Of Record Id - [Optional]

POST/IntegrationDigitalChannelCredit/credit/api/saveCardPermissions

curl https://everest-sandboxapi.dgpays.com/SandBox/IntegrationDigitalChannelCredit/credit/api/saveCardPermissions \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'evrst-ptrnid: x_request_id' \
  --data '{
  "channel": "002",
  "cardRefNumber": "cardRefNumber",
  "shadowCardNumber": "shadowCardNumber",
  "permissions": [
    {
      "restrictionCode": "restrictionCode",
      "permitted": true,
      "startDate": "2024-08-25T15:00:00Z",
      "endDate": "2024-08-25T15:00:00Z",
      "transactionId": "transactionId"
    }
  ]
}'

Example Request Body

{
  "channel": "002",
  "cardRefNumber": "cardRefNumber",
  "shadowCardNumber": "shadowCardNumber",
  "permissions": [
    {
      "restrictionCode": "restrictionCode",
      "permitted": true,
      "startDate": "2024-08-25T15:00:00Z",
      "endDate": "2024-08-25T15:00:00Z",
      "transactionId": "transactionId"
    }
  ]
}

json

application/json

Example Responses

{
  "changedCount": 0,
  "listOfRecordId": [
    0
  ]
}

json

application/json

changeCardMiscOption

POST

https://everest-sandboxapi.dgpays.com/SandBox

/IntegrationDigitalChannelCredit/credit/api/changeCardMiscOption

Updates miscellaneous options for a credit card or a set of cards. Sends OptionType and OptionValue along with customer/card identifiers to the Lifecycle service and returns the list of CardMiscOptionLogRecordIds created for the change.

changeCardMiscOption › Headers

evrst-ptrnid

string

Correlation id for this request. Echo it in your own logs to trace the call through the platform.

Default: x_request_id

changeCardMiscOption › Request Body

ChangeCardMiscOptionRequest

channel

string | null

Three-digit channel code (for example "002", not "Internet"). Used for entitlement, limits and the audit trail. See the Channels page (sidebar, or from Get started) for the full code list.

Example: 002

optionType

string | null

Option Type - [Optional]

optionValue

string | null

Option Value - [Optional]

customerNumber

integer · int64

Customer Number - [Optional]

mainCardRefNumber

string | null

Main Card Ref Number - [Optional]

cardRefNumber

string | null

Card Ref Number - [Optional]

allMainCardFlag

boolean

All Main Card Flag - [Optional]

allCardFlag

boolean

All Card Flag - [Optional]

changeCardMiscOption › Responses

Success

CardMiscOptionResponse

listOfCardMiscOptionLogRecordId

array | null

List Of Card Misc Option Log Record Id - [Optional]

POST/IntegrationDigitalChannelCredit/credit/api/changeCardMiscOption

curl https://everest-sandboxapi.dgpays.com/SandBox/IntegrationDigitalChannelCredit/credit/api/changeCardMiscOption \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'evrst-ptrnid: x_request_id' \
  --data '{
  "channel": "002",
  "optionType": "optionType",
  "optionValue": "optionValue",
  "customerNumber": 0,
  "mainCardRefNumber": "mainCardRefNumber",
  "cardRefNumber": "cardRefNumber",
  "allMainCardFlag": true,
  "allCardFlag": true
}'

Example Request Body

{
  "channel": "002",
  "optionType": "optionType",
  "optionValue": "optionValue",
  "customerNumber": 0,
  "mainCardRefNumber": "mainCardRefNumber",
  "cardRefNumber": "cardRefNumber",
  "allMainCardFlag": true,
  "allCardFlag": true
}

json

application/json

Example Responses

{
  "listOfCardMiscOptionLogRecordId": [
    0
  ]
}

json

application/json

getCardMiscOption

POST

https://everest-sandboxapi.dgpays.com/SandBox

/IntegrationDigitalChannelCredit/credit/api/getCardMiscOption

Retrieves miscellaneous option settings for credit cards based on channel, option type, customer number, main card reference, individual or all card flags, and card reference. Maps results from Lifecycle service to CardMiscOptionData objects including option type, value, customer number, and card references.

getCardMiscOption › Headers

evrst-ptrnid

string

Correlation id for this request. Echo it in your own logs to trace the call through the platform.

Default: x_request_id

getCardMiscOption › Request Body

GetCardMiscOptionRequest

channel

string | null

Three-digit channel code (for example "002", not "Internet"). Used for entitlement, limits and the audit trail. See the Channels page (sidebar, or from Get started) for the full code list.

Example: 002

optionType

string | null

Option Type - [Optional]

customerNumber

integer · int64

Customer Number - [Optional]

mainCardRefNumber

string | null

Main Card Ref Number - [Optional]

cardRefNumber

string | null

Card Ref Number - [Optional]

onlyMainCardFlag

boolean

Only Main Card Flag

getCardMiscOption › Responses

Success

GetCardMiscOptionResponse

array | null

Card Misc Option Data List - [Optional]

POST/IntegrationDigitalChannelCredit/credit/api/getCardMiscOption

curl https://everest-sandboxapi.dgpays.com/SandBox/IntegrationDigitalChannelCredit/credit/api/getCardMiscOption \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'evrst-ptrnid: x_request_id' \
  --data '{
  "channel": "002",
  "optionType": "optionType",
  "customerNumber": 0,
  "mainCardRefNumber": "mainCardRefNumber",
  "cardRefNumber": "cardRefNumber",
  "onlyMainCardFlag": true
}'

Example Request Body

{
  "channel": "002",
  "optionType": "optionType",
  "customerNumber": 0,
  "mainCardRefNumber": "mainCardRefNumber",
  "cardRefNumber": "cardRefNumber",
  "onlyMainCardFlag": true
}

json

application/json

Example Responses

{
  "cardMiscOptionDataList": [
    {
      "customerNumber": 0,
      "mainCardRefNumber": "mainCardRefNumber",
      "cardRefNumber": "cardRefNumber",
      "optionType": "optionType",
      "optionValue": "optionValue"
    }
  ]
}

json

application/json

Operation limits Instalments

Credit Digital Channels Integration

Permissions and restrictions

Turn individual capabilities on and off for a card — e-commerce, international use, mail order and other miscellaneous options.

getCardPermissions

POST

https://everest-sandboxapi.dgpays.com/SandBox

/IntegrationDigitalChannelCredit/credit/api/getCardPermissions

Part of:

Journey 02 · Managing a card product — step 1, Read current controls

getCardPermissions › Headers

evrst-ptrnid

string

Correlation id for this request. Echo it in your own logs to trace the call through the platform.

Default: x_request_id

getCardPermissions › Request Body

GetCardPermissionsRequest

shadowCardNumber

string · required

Required · NotNullOrWhiteSpace — The card whose permissions are read.

getCardPermissions › Responses

Success

GetCardPermissionsResponse

array | null

Card Permissions List - [Optional]

POST/IntegrationDigitalChannelCredit/credit/api/getCardPermissions

curl https://everest-sandboxapi.dgpays.com/SandBox/IntegrationDigitalChannelCredit/credit/api/getCardPermissions \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'evrst-ptrnid: x_request_id' \
  --data '{
  "shadowCardNumber": "shadowCardNumber"
}'

Example Request Body

{
  "shadowCardNumber": "shadowCardNumber"
}

json

application/json

Example Responses

{
  "cardPermissionsList": [
    {
      "restrictionCode": "restrictionCode",
      "restrictionCodeDescription": "restrictionCodeDescription",
      "restrictionPermissionIndicator": "restrictionPermissionIndicator",
      "restrictionPermissionIndicatorDescription": "restrictionPermissionIndicatorDescription",
      "channel": "002",
      "securityFlag": true
    }
  ]
}

json

application/json

saveCardPermissions

POST

https://everest-sandboxapi.dgpays.com/SandBox

/IntegrationDigitalChannelCredit/credit/api/saveCardPermissions

Saves the card permissions including restrictions, start date, end date, and transaction ID for the specified card.

Part of:

Journey 02 · Managing a card product — step 2, Update permissions

saveCardPermissions › Headers

evrst-ptrnid

string

Correlation id for this request. Echo it in your own logs to trace the call through the platform.

Default: x_request_id

saveCardPermissions › Request Body

SaveCardPermissionsRequest

channel

string · required

Required · Enum · NotNull — Three-digit channel code. Must be a defined channel.

Example: 002

SaveCardPermissionsRequestItem[] · required

Required · NotNull — The permissions to write. Must be sent; an empty list is accepted and changes nothing.

cardRefNumber

string | null

One-of · NotNull — The card to permit or restrict. Send this or shadowCardNumber; sending neither is refused with both named.

shadowCardNumber

string | null

One-of · NotNull — The card to permit or restrict. Send this or cardRefNumber; when both are sent this one finds the card.

saveCardPermissions › Responses

Success

SaveCardPermissionsResponse

changedCount

integer · int32 · required

How many entries actually changed. An entry already holding the value it was sent is skipped, so this can be lower than the number sent — and zero is a success.

listOfRecordId

array | null

List Of Record Id - [Optional]

POST/IntegrationDigitalChannelCredit/credit/api/saveCardPermissions

curl https://everest-sandboxapi.dgpays.com/SandBox/IntegrationDigitalChannelCredit/credit/api/saveCardPermissions \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'evrst-ptrnid: x_request_id' \
  --data '{
  "channel": "002",
  "cardRefNumber": "cardRefNumber",
  "shadowCardNumber": "shadowCardNumber",
  "permissions": [
    {
      "restrictionCode": "restrictionCode",
      "permitted": true,
      "startDate": "2024-08-25T15:00:00Z",
      "endDate": "2024-08-25T15:00:00Z",
      "transactionId": "transactionId"
    }
  ]
}'

Example Request Body

{
  "channel": "002",
  "cardRefNumber": "cardRefNumber",
  "shadowCardNumber": "shadowCardNumber",
  "permissions": [
    {
      "restrictionCode": "restrictionCode",
      "permitted": true,
      "startDate": "2024-08-25T15:00:00Z",
      "endDate": "2024-08-25T15:00:00Z",
      "transactionId": "transactionId"
    }
  ]
}

json

application/json

Example Responses

{
  "changedCount": 0,
  "listOfRecordId": [
    0
  ]
}

json

application/json

changeCardMiscOption

POST

https://everest-sandboxapi.dgpays.com/SandBox

/IntegrationDigitalChannelCredit/credit/api/changeCardMiscOption

changeCardMiscOption › Headers

evrst-ptrnid

string

Correlation id for this request. Echo it in your own logs to trace the call through the platform.

Default: x_request_id

changeCardMiscOption › Request Body

ChangeCardMiscOptionRequest

channel

string | null

Three-digit channel code (for example "002", not "Internet"). Used for entitlement, limits and the audit trail. See the Channels page (sidebar, or from Get started) for the full code list.

Example: 002

optionType

string | null

Option Type - [Optional]

optionValue

string | null

Option Value - [Optional]

customerNumber

integer · int64

Customer Number - [Optional]

mainCardRefNumber

string | null

Main Card Ref Number - [Optional]

cardRefNumber

string | null

Card Ref Number - [Optional]

allMainCardFlag

boolean

All Main Card Flag - [Optional]

allCardFlag

boolean

All Card Flag - [Optional]

changeCardMiscOption › Responses

Success

CardMiscOptionResponse

listOfCardMiscOptionLogRecordId

array | null

List Of Card Misc Option Log Record Id - [Optional]

POST/IntegrationDigitalChannelCredit/credit/api/changeCardMiscOption

curl https://everest-sandboxapi.dgpays.com/SandBox/IntegrationDigitalChannelCredit/credit/api/changeCardMiscOption \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'evrst-ptrnid: x_request_id' \
  --data '{
  "channel": "002",
  "optionType": "optionType",
  "optionValue": "optionValue",
  "customerNumber": 0,
  "mainCardRefNumber": "mainCardRefNumber",
  "cardRefNumber": "cardRefNumber",
  "allMainCardFlag": true,
  "allCardFlag": true
}'

Example Request Body

{
  "channel": "002",
  "optionType": "optionType",
  "optionValue": "optionValue",
  "customerNumber": 0,
  "mainCardRefNumber": "mainCardRefNumber",
  "cardRefNumber": "cardRefNumber",
  "allMainCardFlag": true,
  "allCardFlag": true
}

json

application/json

Example Responses

{
  "listOfCardMiscOptionLogRecordId": [
    0
  ]
}

json

application/json

getCardMiscOption

POST

https://everest-sandboxapi.dgpays.com/SandBox

/IntegrationDigitalChannelCredit/credit/api/getCardMiscOption

getCardMiscOption › Headers

evrst-ptrnid

string

Correlation id for this request. Echo it in your own logs to trace the call through the platform.

Default: x_request_id

getCardMiscOption › Request Body

GetCardMiscOptionRequest

channel

string | null

Three-digit channel code (for example "002", not "Internet"). Used for entitlement, limits and the audit trail. See the Channels page (sidebar, or from Get started) for the full code list.

Example: 002

optionType

string | null

Option Type - [Optional]

customerNumber

integer · int64

Customer Number - [Optional]

mainCardRefNumber

string | null

Main Card Ref Number - [Optional]

cardRefNumber

string | null

Card Ref Number - [Optional]

onlyMainCardFlag

boolean

Only Main Card Flag

getCardMiscOption › Responses

Success

GetCardMiscOptionResponse

array | null

Card Misc Option Data List - [Optional]

POST/IntegrationDigitalChannelCredit/credit/api/getCardMiscOption

curl https://everest-sandboxapi.dgpays.com/SandBox/IntegrationDigitalChannelCredit/credit/api/getCardMiscOption \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'evrst-ptrnid: x_request_id' \
  --data '{
  "channel": "002",
  "optionType": "optionType",
  "customerNumber": 0,
  "mainCardRefNumber": "mainCardRefNumber",
  "cardRefNumber": "cardRefNumber",
  "onlyMainCardFlag": true
}'

Example Request Body

{
  "channel": "002",
  "optionType": "optionType",
  "customerNumber": 0,
  "mainCardRefNumber": "mainCardRefNumber",
  "cardRefNumber": "cardRefNumber",
  "onlyMainCardFlag": true
}

json

application/json

Example Responses

{
  "cardMiscOptionDataList": [
    {
      "customerNumber": 0,
      "mainCardRefNumber": "mainCardRefNumber",
      "cardRefNumber": "cardRefNumber",
      "optionType": "optionType",
      "optionValue": "optionValue"
    }
  ]
}

json

application/json

Operation limits Instalments