Permissions and restrictions

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

getPrepaidCardPermission

POST

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

/IntegrationDigitalChannelPrepaid/prepaid/api/getPrepaidCardPermission

Gets the permissions assigned to a prepaid card.

getPrepaidCardPermission › 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

getPrepaidCardPermission › Request Body

GetPrepaidCardPermissionRequest

shadowCardNumber

string | null

Shadow Card Number - [Optional]

getPrepaidCardPermission › Responses

Success

GetPrepaidCardPermissionResponse

array | null

Card Permissions List - [Optional]

POST/IntegrationDigitalChannelPrepaid/prepaid/api/getPrepaidCardPermission

curl https://everest-sandboxapi.dgpays.com/SandBox/IntegrationDigitalChannelPrepaid/prepaid/api/getPrepaidCardPermission \
  --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"
    }
  ]
}

json

application/json

savePrepaidCardPermission

POST

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

/IntegrationDigitalChannelPrepaid/prepaid/api/savePrepaidCardPermission

Saves the permissions for a prepaid card.

savePrepaidCardPermission › 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

savePrepaidCardPermission › Request Body

SavePrepaidCardPermissionRequest

channel

string | null

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

cardRefNumber

string | null

Card Ref Number - [Optional]

shadowCardNumber

string | null

Shadow Card Number - [Optional]

array | null

Permissions - [Optional]

savePrepaidCardPermission › Responses

Success

SavePrepaidCardPermissionResponse

changedCount

integer · int32 · required

Changed Count

POST/IntegrationDigitalChannelPrepaid/prepaid/api/savePrepaidCardPermission

curl https://everest-sandboxapi.dgpays.com/SandBox/IntegrationDigitalChannelPrepaid/prepaid/api/savePrepaidCardPermission \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'evrst-ptrnid: x_request_id' \
  --data '{
  "channel": "channel",
  "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": "channel",
  "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
}

json

application/json

Operation limits PIN and card security

Prepaid 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.

getPrepaidCardPermission

POST

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

/IntegrationDigitalChannelPrepaid/prepaid/api/getPrepaidCardPermission

Gets the permissions assigned to a prepaid card.

getPrepaidCardPermission › 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

getPrepaidCardPermission › Request Body

GetPrepaidCardPermissionRequest

shadowCardNumber

string | null

Shadow Card Number - [Optional]

getPrepaidCardPermission › Responses

Success

GetPrepaidCardPermissionResponse

array | null

Card Permissions List - [Optional]

POST/IntegrationDigitalChannelPrepaid/prepaid/api/getPrepaidCardPermission

curl https://everest-sandboxapi.dgpays.com/SandBox/IntegrationDigitalChannelPrepaid/prepaid/api/getPrepaidCardPermission \
  --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"
    }
  ]
}

json

application/json

savePrepaidCardPermission

POST

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

/IntegrationDigitalChannelPrepaid/prepaid/api/savePrepaidCardPermission

Saves the permissions for a prepaid card.

savePrepaidCardPermission › 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

savePrepaidCardPermission › Request Body

SavePrepaidCardPermissionRequest

channel

string | null

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

cardRefNumber

string | null

Card Ref Number - [Optional]

shadowCardNumber

string | null

Shadow Card Number - [Optional]

array | null

Permissions - [Optional]

savePrepaidCardPermission › Responses

Success

SavePrepaidCardPermissionResponse

changedCount

integer · int32 · required

Changed Count

POST/IntegrationDigitalChannelPrepaid/prepaid/api/savePrepaidCardPermission

curl https://everest-sandboxapi.dgpays.com/SandBox/IntegrationDigitalChannelPrepaid/prepaid/api/savePrepaidCardPermission \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'evrst-ptrnid: x_request_id' \
  --data '{
  "channel": "channel",
  "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": "channel",
  "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
}

json

application/json

Operation limits PIN and card security