Operation limits

Cap what a card may do per transaction, per day, per week and per month, by channel and operation type.

getCardLimitationParameterData

POST

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

/IntegrationDigitalChannelPrepaid/prepaid/api/getCardLimitationParameterData

Gets card limitation parameter data for a prepaid card.

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

getCardLimitationParameterData › Request Body

GetCardLimitationParametersRequest

shadowCardNumber

string | null

Shadow Card Number - [Optional]

getCardLimitationParameterData › Responses

Success

GetCardLimitationParametersResponse

array | null

Card Limitation Parameter Data List - [Optional]

POST/IntegrationDigitalChannelPrepaid/prepaid/api/getCardLimitationParameterData

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

{
  "cardLimitationParameterDataList": [
    {
      "shadowCardNumber": "shadowCardNumber",
      "customerLimitationFlag": true,
      "profileCode": "profileCode",
      "profileDescription": "profileDescription",
      "keys": {
        "limitProfileDetailId": 0,
        "trnLimitationGroupCode": "trnLimitationGroupCode",
        "trnLimitationGroupDescription": "trnLimitationGroupDescription",
        "trnMainLimitationGroupCode": "trnMainLimitationGroupCode",
        "trnMainLimitationGroupDescription": "trnMainLimitationGroupDescription",
        "networkType": "networkType",
        "networkDescription": "networkDescription",
        "channelType": "channelType",
        "channelDescription": "channelDescription",
        "eventCode": "eventCode",
        "eventDescription": "eventDescription",
        "customLimitationChangeFlag": true
      },
      "perTrnAmount": 0,
      "perTrnAmountLimitRatio": 0,
      "dailyTrnCount": 0,
      "dailyTrnAmount": 0,
      "weeklyTrnCount": 0,
      "weeklyTrnAmount": 0,
      "monthlyTrnCount": 0,
      "monthlyTrnAmount": 0,
      "yearlyTrnCount": 0,
      "yearlyTrnAmount": 0,
      "noCvmConsecutiveTransactionCount": 0,
      "noCvmConsecutiveTransactionLimit": 0
    }
  ]
}

json

application/json

getCustomerOperationLimit

POST

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

/IntegrationDigitalChannelPrepaid/prepaid/api/getCustomerOperationLimit

Gets the operation limit set for a customer.

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

getCustomerOperationLimit › Request Body

GetCustomerOperationLimitRequest

customerNumber

integer · int64 · required

Customer Number

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.

getCustomerOperationLimit › Responses

Success

GetCustomerOperationLimitResponse

array | null

List Of Operation Limit - [Optional]

POST/IntegrationDigitalChannelPrepaid/prepaid/api/getCustomerOperationLimit

curl https://everest-sandboxapi.dgpays.com/SandBox/IntegrationDigitalChannelPrepaid/prepaid/api/getCustomerOperationLimit \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'evrst-ptrnid: x_request_id' \
  --data '{
  "channel": "channel",
  "customerNumber": 0
}'

Example Request Body

{
  "channel": "channel",
  "customerNumber": 0
}

json

application/json

Example Responses

{
  "listOfOperationLimit": [
    {
      "keys": {
        "limitProfileDetailId": 0,
        "trnLimitationGroupCode": "trnLimitationGroupCode",
        "trnLimitationGroupDescription": "trnLimitationGroupDescription",
        "trnMainLimitationGroupCode": "trnMainLimitationGroupCode",
        "trnMainLimitationGroupDescription": "trnMainLimitationGroupDescription",
        "networkType": "networkType",
        "networkDescription": "networkDescription",
        "channelType": "channelType",
        "channelDescription": "channelDescription",
        "eventCode": "eventCode",
        "eventDescription": "eventDescription",
        "customLimitationChangeFlag": true
      },
      "profileCode": "profileCode",
      "profileDescription": "profileDescription",
      "perTrnAmount": 0,
      "perTrnAmountLimitRatio": 0,
      "dailyTrnCount": 0,
      "dailyTrnAmount": 0,
      "weeklyTrnCount": 0,
      "weeklyTrnAmount": 0,
      "monthlyTrnCount": 0,
      "monthlyTrnAmount": 0,
      "yearlyTrnCount": 0,
      "yearlyTrnAmount": 0,
      "cardType": "cardType"
    }
  ]
}

json

application/json

getCardOperationLimit

POST

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

/IntegrationDigitalChannelPrepaid/prepaid/api/getCardOperationLimit

Gets the operation limit set for a prepaid card.

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

getCardOperationLimit › Request Body

GetCardOperationLimitRequest

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]

getCardOperationLimit › Responses

Success

GetCardOperationLimitResponse

array | null

List Of Operation Limit - [Optional]

POST/IntegrationDigitalChannelPrepaid/prepaid/api/getCardOperationLimit

curl https://everest-sandboxapi.dgpays.com/SandBox/IntegrationDigitalChannelPrepaid/prepaid/api/getCardOperationLimit \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'evrst-ptrnid: x_request_id' \
  --data '{
  "channel": "channel",
  "cardRefNumber": "cardRefNumber"
}'

Example Request Body

{
  "channel": "channel",
  "cardRefNumber": "cardRefNumber"
}

json

application/json

Example Responses

{
  "listOfOperationLimit": [
    {
      "keys": {
        "limitProfileDetailId": 0,
        "trnLimitationGroupCode": "trnLimitationGroupCode",
        "trnLimitationGroupDescription": "trnLimitationGroupDescription",
        "trnMainLimitationGroupCode": "trnMainLimitationGroupCode",
        "trnMainLimitationGroupDescription": "trnMainLimitationGroupDescription",
        "networkType": "networkType",
        "networkDescription": "networkDescription",
        "channelType": "channelType",
        "channelDescription": "channelDescription",
        "eventCode": "eventCode",
        "eventDescription": "eventDescription",
        "customLimitationChangeFlag": true
      },
      "perTrnAmount": 0,
      "perTrnAmountLimitRatio": 0,
      "dailyTrnCount": 0,
      "dailyTrnAmount": 0,
      "weeklyTrnCount": 0,
      "weeklyTrnAmount": 0,
      "monthlyTrnCount": 0,
      "monthlyTrnAmount": 0,
      "yearlyTrnCount": 0,
      "yearlyTrnAmount": 0
    }
  ]
}

json

application/json

setCustomerOperationLimit

POST

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

/IntegrationDigitalChannelPrepaid/prepaid/api/setCustomerOperationLimit

Sets an operation limit on a prepaid customer.

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

setCustomerOperationLimit › Request Body

SetCustomerOperationLimitRequest

customerNumber

integer · int64 · required

Customer Number

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.

array | null

List Of Operation Limit - [Optional]

setCustomerOperationLimit › Responses

Success

SetCustomerOperationLimitResponse

array | null

List Of Result - [Optional]

POST/IntegrationDigitalChannelPrepaid/prepaid/api/setCustomerOperationLimit

curl https://everest-sandboxapi.dgpays.com/SandBox/IntegrationDigitalChannelPrepaid/prepaid/api/setCustomerOperationLimit \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'evrst-ptrnid: x_request_id' \
  --data '{
  "channel": "channel",
  "customerNumber": 0,
  "listOfOperationLimit": [
    {
      "keys": {
        "limitProfileDetailId": 0,
        "trnLimitationGroupCode": "trnLimitationGroupCode",
        "trnLimitationGroupDescription": "trnLimitationGroupDescription",
        "trnMainLimitationGroupCode": "trnMainLimitationGroupCode",
        "trnMainLimitationGroupDescription": "trnMainLimitationGroupDescription",
        "networkType": "networkType",
        "networkDescription": "networkDescription",
        "channelType": "channelType",
        "channelDescription": "channelDescription",
        "eventCode": "eventCode",
        "eventDescription": "eventDescription",
        "customLimitationChangeFlag": true
      },
      "profileCode": "profileCode",
      "profileDescription": "profileDescription",
      "perTrnAmount": 0,
      "perTrnAmountLimitRatio": 0,
      "dailyTrnCount": 0,
      "dailyTrnAmount": 0,
      "weeklyTrnCount": 0,
      "weeklyTrnAmount": 0,
      "monthlyTrnCount": 0,
      "monthlyTrnAmount": 0,
      "yearlyTrnCount": 0,
      "yearlyTrnAmount": 0,
      "cardType": "cardType"
    }
  ]
}'

Example Request Body

{
  "channel": "channel",
  "customerNumber": 0,
  "listOfOperationLimit": [
    {
      "keys": {
        "limitProfileDetailId": 0,
        "trnLimitationGroupCode": "trnLimitationGroupCode",
        "trnLimitationGroupDescription": "trnLimitationGroupDescription",
        "trnMainLimitationGroupCode": "trnMainLimitationGroupCode",
        "trnMainLimitationGroupDescription": "trnMainLimitationGroupDescription",
        "networkType": "networkType",
        "networkDescription": "networkDescription",
        "channelType": "channelType",
        "channelDescription": "channelDescription",
        "eventCode": "eventCode",
        "eventDescription": "eventDescription",
        "customLimitationChangeFlag": true
      },
      "profileCode": "profileCode",
      "profileDescription": "profileDescription",
      "perTrnAmount": 0,
      "perTrnAmountLimitRatio": 0,
      "dailyTrnCount": 0,
      "dailyTrnAmount": 0,
      "weeklyTrnCount": 0,
      "weeklyTrnAmount": 0,
      "monthlyTrnCount": 0,
      "monthlyTrnAmount": 0,
      "yearlyTrnCount": 0,
      "yearlyTrnAmount": 0,
      "cardType": "cardType"
    }
  ]
}

json

application/json

Example Responses

{
  "listOfResult": [
    {
      "actionType": 0,
      "success": true,
      "errors": [
        {
          "errorCode": "errorCode",
          "errorText": "errorText"
        }
      ],
      "operationLimit": {
        "keys": {
          "limitProfileDetailId": 0,
          "trnLimitationGroupCode": "trnLimitationGroupCode",
          "trnLimitationGroupDescription": "trnLimitationGroupDescription",
          "trnMainLimitationGroupCode": "trnMainLimitationGroupCode",
          "trnMainLimitationGroupDescription": "trnMainLimitationGroupDescription",
          "networkType": "networkType",
          "networkDescription": "networkDescription",
          "channelType": "channelType",
          "channelDescription": "channelDescription",
          "eventCode": "eventCode",
          "eventDescription": "eventDescription",
          "customLimitationChangeFlag": true
        },
        "profileCode": "profileCode",
        "profileDescription": "profileDescription",
        "perTrnAmount": 0,
        "perTrnAmountLimitRatio": 0,
        "dailyTrnCount": 0,
        "dailyTrnAmount": 0,
        "weeklyTrnCount": 0,
        "weeklyTrnAmount": 0,
        "monthlyTrnCount": 0,
        "monthlyTrnAmount": 0,
        "yearlyTrnCount": 0,
        "yearlyTrnAmount": 0,
        "cardType": "cardType"
      }
    }
  ]
}

json

application/json

setCardOperationLimit

POST

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

/IntegrationDigitalChannelPrepaid/prepaid/api/setCardOperationLimit

Sets an operation limit on a prepaid card.

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

setCardOperationLimit › Request Body

SetCardOperationLimitRequest

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]

array | null

List Of Operation Limit - [Optional]

setCardOperationLimit › Responses

Success

SetCardOperationLimitResponse

array | null

List Of Result - [Optional]

POST/IntegrationDigitalChannelPrepaid/prepaid/api/setCardOperationLimit

curl https://everest-sandboxapi.dgpays.com/SandBox/IntegrationDigitalChannelPrepaid/prepaid/api/setCardOperationLimit \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'evrst-ptrnid: x_request_id' \
  --data '{
  "channel": "channel",
  "cardRefNumber": "cardRefNumber",
  "listOfOperationLimit": [
    {
      "keys": {
        "limitProfileDetailId": 0,
        "trnLimitationGroupCode": "trnLimitationGroupCode",
        "trnLimitationGroupDescription": "trnLimitationGroupDescription",
        "trnMainLimitationGroupCode": "trnMainLimitationGroupCode",
        "trnMainLimitationGroupDescription": "trnMainLimitationGroupDescription",
        "networkType": "networkType",
        "networkDescription": "networkDescription",
        "channelType": "channelType",
        "channelDescription": "channelDescription",
        "eventCode": "eventCode",
        "eventDescription": "eventDescription",
        "customLimitationChangeFlag": true
      },
      "profileCode": "profileCode",
      "profileDescription": "profileDescription",
      "perTrnAmount": 0,
      "perTrnAmountLimitRatio": 0,
      "dailyTrnCount": 0,
      "dailyTrnAmount": 0,
      "weeklyTrnCount": 0,
      "weeklyTrnAmount": 0,
      "monthlyTrnCount": 0,
      "monthlyTrnAmount": 0,
      "yearlyTrnCount": 0,
      "yearlyTrnAmount": 0,
      "cardType": "cardType"
    }
  ]
}'

Example Request Body

{
  "channel": "channel",
  "cardRefNumber": "cardRefNumber",
  "listOfOperationLimit": [
    {
      "keys": {
        "limitProfileDetailId": 0,
        "trnLimitationGroupCode": "trnLimitationGroupCode",
        "trnLimitationGroupDescription": "trnLimitationGroupDescription",
        "trnMainLimitationGroupCode": "trnMainLimitationGroupCode",
        "trnMainLimitationGroupDescription": "trnMainLimitationGroupDescription",
        "networkType": "networkType",
        "networkDescription": "networkDescription",
        "channelType": "channelType",
        "channelDescription": "channelDescription",
        "eventCode": "eventCode",
        "eventDescription": "eventDescription",
        "customLimitationChangeFlag": true
      },
      "profileCode": "profileCode",
      "profileDescription": "profileDescription",
      "perTrnAmount": 0,
      "perTrnAmountLimitRatio": 0,
      "dailyTrnCount": 0,
      "dailyTrnAmount": 0,
      "weeklyTrnCount": 0,
      "weeklyTrnAmount": 0,
      "monthlyTrnCount": 0,
      "monthlyTrnAmount": 0,
      "yearlyTrnCount": 0,
      "yearlyTrnAmount": 0,
      "cardType": "cardType"
    }
  ]
}

json

application/json

Example Responses

{
  "listOfResult": [
    {
      "actionType": 0,
      "success": true,
      "errors": [
        {
          "errorCode": "errorCode",
          "errorText": "errorText"
        }
      ],
      "operationLimit": {
        "keys": {
          "limitProfileDetailId": 0,
          "trnLimitationGroupCode": "trnLimitationGroupCode",
          "trnLimitationGroupDescription": "trnLimitationGroupDescription",
          "trnMainLimitationGroupCode": "trnMainLimitationGroupCode",
          "trnMainLimitationGroupDescription": "trnMainLimitationGroupDescription",
          "networkType": "networkType",
          "networkDescription": "networkDescription",
          "channelType": "channelType",
          "channelDescription": "channelDescription",
          "eventCode": "eventCode",
          "eventDescription": "eventDescription",
          "customLimitationChangeFlag": true
        },
        "profileCode": "profileCode",
        "profileDescription": "profileDescription",
        "perTrnAmount": 0,
        "perTrnAmountLimitRatio": 0,
        "dailyTrnCount": 0,
        "dailyTrnAmount": 0,
        "weeklyTrnCount": 0,
        "weeklyTrnAmount": 0,
        "monthlyTrnCount": 0,
        "monthlyTrnAmount": 0,
        "yearlyTrnCount": 0,
        "yearlyTrnAmount": 0,
        "cardType": "cardType"
      }
    }
  ]
}

json

application/json

removeCustomerOperationLimit

POST

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

/IntegrationDigitalChannelPrepaid/prepaid/api/removeCustomerOperationLimit

Removes a specific operation limit from a prepaid customer.

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

removeCustomerOperationLimit › Request Body

RemoveCustomerOperationLimitRequest

customerNumber

integer · int64 · required

Customer Number

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.

array | null

List Of Operation Limit Keys - [Optional]

removeCustomerOperationLimit › Responses

Success

RemoveCustomerOperationLimitResponse

array | null

List Of Result - [Optional]

POST/IntegrationDigitalChannelPrepaid/prepaid/api/removeCustomerOperationLimit

curl https://everest-sandboxapi.dgpays.com/SandBox/IntegrationDigitalChannelPrepaid/prepaid/api/removeCustomerOperationLimit \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'evrst-ptrnid: x_request_id' \
  --data '{
  "channel": "channel",
  "customerNumber": 0,
  "listOfOperationLimitKeys": [
    {
      "operationLimitRecordId": 0
    }
  ]
}'

Example Request Body

{
  "channel": "channel",
  "customerNumber": 0,
  "listOfOperationLimitKeys": [
    {
      "operationLimitRecordId": 0
    }
  ]
}

json

application/json

Example Responses

{
  "listOfResult": [
    {
      "actionType": 0,
      "success": true,
      "errors": [
        {
          "errorCode": "errorCode",
          "errorText": "errorText"
        }
      ],
      "operationLimitKeys": {
        "operationLimitRecordId": 0
      }
    }
  ]
}

json

application/json

removeCardOperationLimit

POST

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

/IntegrationDigitalChannelPrepaid/prepaid/api/removeCardOperationLimit

Removes a specific operation limit from a prepaid card.

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

removeCardOperationLimit › Request Body

RemoveCardOperationLimitRequest

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]

array | null

List Of Remove Operation Limit Keys - [Optional]

removeCardOperationLimit › Responses

Success

RemoveCardOperationLimitResponse

array | null

List Of Result - [Optional]

POST/IntegrationDigitalChannelPrepaid/prepaid/api/removeCardOperationLimit

curl https://everest-sandboxapi.dgpays.com/SandBox/IntegrationDigitalChannelPrepaid/prepaid/api/removeCardOperationLimit \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'evrst-ptrnid: x_request_id' \
  --data '{
  "channel": "channel",
  "cardRefNumber": "cardRefNumber",
  "listOfRemoveOperationLimitKeys": [
    {
      "operationLimitRecordId": 0
    }
  ]
}'

Example Request Body

{
  "channel": "channel",
  "cardRefNumber": "cardRefNumber",
  "listOfRemoveOperationLimitKeys": [
    {
      "operationLimitRecordId": 0
    }
  ]
}

json

application/json

Example Responses

{
  "listOfResult": [
    {
      "actionType": 0,
      "success": true,
      "operationLimitKeys": {
        "operationLimitRecordId": 0
      },
      "errors": [
        {
          "errorCode": "errorCode",
          "errorText": "errorText"
        }
      ]
    }
  ]
}

json

application/json

getCustomerLimitationParameterData

POST

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

/IntegrationDigitalChannelPrepaid/prepaid/api/getCustomerLimitationParameterData

Gets customer limitation parameter data for prepaid operations.

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

getCustomerLimitationParameterData › Request Body

GetCustomerLimitationParametersRequest

customerNumber

integer · int64 · required

Customer Number

getCustomerLimitationParameterData › Responses

Success

GetCustomerLimitationParametersResponse

array | null

Customer Limitation Parameter Data List - [Optional]

POST/IntegrationDigitalChannelPrepaid/prepaid/api/getCustomerLimitationParameterData

curl https://everest-sandboxapi.dgpays.com/SandBox/IntegrationDigitalChannelPrepaid/prepaid/api/getCustomerLimitationParameterData \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'evrst-ptrnid: x_request_id' \
  --data '{
  "customerNumber": 0
}'

Example Request Body

{
  "customerNumber": 0
}

json

application/json

Example Responses

{
  "customerLimitationParameterDataList": [
    {
      "customerNumber": 0,
      "customerLimitationFlag": true,
      "profileCode": "profileCode",
      "profileDescription": "profileDescription",
      "keys": {
        "limitProfileDetailId": 0,
        "trnLimitationGroupCode": "trnLimitationGroupCode",
        "trnLimitationGroupDescription": "trnLimitationGroupDescription",
        "trnMainLimitationGroupCode": "trnMainLimitationGroupCode",
        "trnMainLimitationGroupDescription": "trnMainLimitationGroupDescription",
        "networkType": "networkType",
        "networkDescription": "networkDescription",
        "channelType": "channelType",
        "channelDescription": "channelDescription",
        "eventCode": "eventCode",
        "eventDescription": "eventDescription",
        "customLimitationChangeFlag": true
      },
      "perTrnAmount": 0,
      "perTrnAmountLimitRatio": 0,
      "dailyTrnCount": 0,
      "dailyTrnAmount": 0,
      "weeklyTrnCount": 0,
      "weeklyTrnAmount": 0,
      "monthlyTrnCount": 0,
      "monthlyTrnAmount": 0,
      "yearlyTrnCount": 0,
      "yearlyTrnAmount": 0,
      "cardType": "cardType",
      "limitationProfileDetailId": 0
    }
  ]
}

json

application/json

Transactions Permissions and restrictions

Prepaid Digital Channels Integration

Operation limits

Cap what a card may do per transaction, per day, per week and per month, by channel and operation type.

getCardLimitationParameterData

POST

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

/IntegrationDigitalChannelPrepaid/prepaid/api/getCardLimitationParameterData

Gets card limitation parameter data for a prepaid card.

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

getCardLimitationParameterData › Request Body

GetCardLimitationParametersRequest

shadowCardNumber

string | null

Shadow Card Number - [Optional]

getCardLimitationParameterData › Responses

Success

GetCardLimitationParametersResponse

array | null

Card Limitation Parameter Data List - [Optional]

POST/IntegrationDigitalChannelPrepaid/prepaid/api/getCardLimitationParameterData

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

{
  "cardLimitationParameterDataList": [
    {
      "shadowCardNumber": "shadowCardNumber",
      "customerLimitationFlag": true,
      "profileCode": "profileCode",
      "profileDescription": "profileDescription",
      "keys": {
        "limitProfileDetailId": 0,
        "trnLimitationGroupCode": "trnLimitationGroupCode",
        "trnLimitationGroupDescription": "trnLimitationGroupDescription",
        "trnMainLimitationGroupCode": "trnMainLimitationGroupCode",
        "trnMainLimitationGroupDescription": "trnMainLimitationGroupDescription",
        "networkType": "networkType",
        "networkDescription": "networkDescription",
        "channelType": "channelType",
        "channelDescription": "channelDescription",
        "eventCode": "eventCode",
        "eventDescription": "eventDescription",
        "customLimitationChangeFlag": true
      },
      "perTrnAmount": 0,
      "perTrnAmountLimitRatio": 0,
      "dailyTrnCount": 0,
      "dailyTrnAmount": 0,
      "weeklyTrnCount": 0,
      "weeklyTrnAmount": 0,
      "monthlyTrnCount": 0,
      "monthlyTrnAmount": 0,
      "yearlyTrnCount": 0,
      "yearlyTrnAmount": 0,
      "noCvmConsecutiveTransactionCount": 0,
      "noCvmConsecutiveTransactionLimit": 0
    }
  ]
}

json

application/json

getCustomerOperationLimit

POST

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

/IntegrationDigitalChannelPrepaid/prepaid/api/getCustomerOperationLimit

Gets the operation limit set for a customer.

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

getCustomerOperationLimit › Request Body

GetCustomerOperationLimitRequest

customerNumber

integer · int64 · required

Customer Number

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.

getCustomerOperationLimit › Responses

Success

GetCustomerOperationLimitResponse

array | null

List Of Operation Limit - [Optional]

POST/IntegrationDigitalChannelPrepaid/prepaid/api/getCustomerOperationLimit

curl https://everest-sandboxapi.dgpays.com/SandBox/IntegrationDigitalChannelPrepaid/prepaid/api/getCustomerOperationLimit \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'evrst-ptrnid: x_request_id' \
  --data '{
  "channel": "channel",
  "customerNumber": 0
}'

Example Request Body

{
  "channel": "channel",
  "customerNumber": 0
}

json

application/json

Example Responses

{
  "listOfOperationLimit": [
    {
      "keys": {
        "limitProfileDetailId": 0,
        "trnLimitationGroupCode": "trnLimitationGroupCode",
        "trnLimitationGroupDescription": "trnLimitationGroupDescription",
        "trnMainLimitationGroupCode": "trnMainLimitationGroupCode",
        "trnMainLimitationGroupDescription": "trnMainLimitationGroupDescription",
        "networkType": "networkType",
        "networkDescription": "networkDescription",
        "channelType": "channelType",
        "channelDescription": "channelDescription",
        "eventCode": "eventCode",
        "eventDescription": "eventDescription",
        "customLimitationChangeFlag": true
      },
      "profileCode": "profileCode",
      "profileDescription": "profileDescription",
      "perTrnAmount": 0,
      "perTrnAmountLimitRatio": 0,
      "dailyTrnCount": 0,
      "dailyTrnAmount": 0,
      "weeklyTrnCount": 0,
      "weeklyTrnAmount": 0,
      "monthlyTrnCount": 0,
      "monthlyTrnAmount": 0,
      "yearlyTrnCount": 0,
      "yearlyTrnAmount": 0,
      "cardType": "cardType"
    }
  ]
}

json

application/json

getCardOperationLimit

POST

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

/IntegrationDigitalChannelPrepaid/prepaid/api/getCardOperationLimit

Gets the operation limit set for a prepaid card.

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

getCardOperationLimit › Request Body

GetCardOperationLimitRequest

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]

getCardOperationLimit › Responses

Success

GetCardOperationLimitResponse

array | null

List Of Operation Limit - [Optional]

POST/IntegrationDigitalChannelPrepaid/prepaid/api/getCardOperationLimit

curl https://everest-sandboxapi.dgpays.com/SandBox/IntegrationDigitalChannelPrepaid/prepaid/api/getCardOperationLimit \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'evrst-ptrnid: x_request_id' \
  --data '{
  "channel": "channel",
  "cardRefNumber": "cardRefNumber"
}'

Example Request Body

{
  "channel": "channel",
  "cardRefNumber": "cardRefNumber"
}

json

application/json

Example Responses

{
  "listOfOperationLimit": [
    {
      "keys": {
        "limitProfileDetailId": 0,
        "trnLimitationGroupCode": "trnLimitationGroupCode",
        "trnLimitationGroupDescription": "trnLimitationGroupDescription",
        "trnMainLimitationGroupCode": "trnMainLimitationGroupCode",
        "trnMainLimitationGroupDescription": "trnMainLimitationGroupDescription",
        "networkType": "networkType",
        "networkDescription": "networkDescription",
        "channelType": "channelType",
        "channelDescription": "channelDescription",
        "eventCode": "eventCode",
        "eventDescription": "eventDescription",
        "customLimitationChangeFlag": true
      },
      "perTrnAmount": 0,
      "perTrnAmountLimitRatio": 0,
      "dailyTrnCount": 0,
      "dailyTrnAmount": 0,
      "weeklyTrnCount": 0,
      "weeklyTrnAmount": 0,
      "monthlyTrnCount": 0,
      "monthlyTrnAmount": 0,
      "yearlyTrnCount": 0,
      "yearlyTrnAmount": 0
    }
  ]
}

json

application/json

setCustomerOperationLimit

POST

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

/IntegrationDigitalChannelPrepaid/prepaid/api/setCustomerOperationLimit

Sets an operation limit on a prepaid customer.

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

setCustomerOperationLimit › Request Body

SetCustomerOperationLimitRequest

customerNumber

integer · int64 · required

Customer Number

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.

array | null

List Of Operation Limit - [Optional]

setCustomerOperationLimit › Responses

Success

SetCustomerOperationLimitResponse

array | null

List Of Result - [Optional]

POST/IntegrationDigitalChannelPrepaid/prepaid/api/setCustomerOperationLimit

curl https://everest-sandboxapi.dgpays.com/SandBox/IntegrationDigitalChannelPrepaid/prepaid/api/setCustomerOperationLimit \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'evrst-ptrnid: x_request_id' \
  --data '{
  "channel": "channel",
  "customerNumber": 0,
  "listOfOperationLimit": [
    {
      "keys": {
        "limitProfileDetailId": 0,
        "trnLimitationGroupCode": "trnLimitationGroupCode",
        "trnLimitationGroupDescription": "trnLimitationGroupDescription",
        "trnMainLimitationGroupCode": "trnMainLimitationGroupCode",
        "trnMainLimitationGroupDescription": "trnMainLimitationGroupDescription",
        "networkType": "networkType",
        "networkDescription": "networkDescription",
        "channelType": "channelType",
        "channelDescription": "channelDescription",
        "eventCode": "eventCode",
        "eventDescription": "eventDescription",
        "customLimitationChangeFlag": true
      },
      "profileCode": "profileCode",
      "profileDescription": "profileDescription",
      "perTrnAmount": 0,
      "perTrnAmountLimitRatio": 0,
      "dailyTrnCount": 0,
      "dailyTrnAmount": 0,
      "weeklyTrnCount": 0,
      "weeklyTrnAmount": 0,
      "monthlyTrnCount": 0,
      "monthlyTrnAmount": 0,
      "yearlyTrnCount": 0,
      "yearlyTrnAmount": 0,
      "cardType": "cardType"
    }
  ]
}'

Example Request Body

{
  "channel": "channel",
  "customerNumber": 0,
  "listOfOperationLimit": [
    {
      "keys": {
        "limitProfileDetailId": 0,
        "trnLimitationGroupCode": "trnLimitationGroupCode",
        "trnLimitationGroupDescription": "trnLimitationGroupDescription",
        "trnMainLimitationGroupCode": "trnMainLimitationGroupCode",
        "trnMainLimitationGroupDescription": "trnMainLimitationGroupDescription",
        "networkType": "networkType",
        "networkDescription": "networkDescription",
        "channelType": "channelType",
        "channelDescription": "channelDescription",
        "eventCode": "eventCode",
        "eventDescription": "eventDescription",
        "customLimitationChangeFlag": true
      },
      "profileCode": "profileCode",
      "profileDescription": "profileDescription",
      "perTrnAmount": 0,
      "perTrnAmountLimitRatio": 0,
      "dailyTrnCount": 0,
      "dailyTrnAmount": 0,
      "weeklyTrnCount": 0,
      "weeklyTrnAmount": 0,
      "monthlyTrnCount": 0,
      "monthlyTrnAmount": 0,
      "yearlyTrnCount": 0,
      "yearlyTrnAmount": 0,
      "cardType": "cardType"
    }
  ]
}

json

application/json

Example Responses

{
  "listOfResult": [
    {
      "actionType": 0,
      "success": true,
      "errors": [
        {
          "errorCode": "errorCode",
          "errorText": "errorText"
        }
      ],
      "operationLimit": {
        "keys": {
          "limitProfileDetailId": 0,
          "trnLimitationGroupCode": "trnLimitationGroupCode",
          "trnLimitationGroupDescription": "trnLimitationGroupDescription",
          "trnMainLimitationGroupCode": "trnMainLimitationGroupCode",
          "trnMainLimitationGroupDescription": "trnMainLimitationGroupDescription",
          "networkType": "networkType",
          "networkDescription": "networkDescription",
          "channelType": "channelType",
          "channelDescription": "channelDescription",
          "eventCode": "eventCode",
          "eventDescription": "eventDescription",
          "customLimitationChangeFlag": true
        },
        "profileCode": "profileCode",
        "profileDescription": "profileDescription",
        "perTrnAmount": 0,
        "perTrnAmountLimitRatio": 0,
        "dailyTrnCount": 0,
        "dailyTrnAmount": 0,
        "weeklyTrnCount": 0,
        "weeklyTrnAmount": 0,
        "monthlyTrnCount": 0,
        "monthlyTrnAmount": 0,
        "yearlyTrnCount": 0,
        "yearlyTrnAmount": 0,
        "cardType": "cardType"
      }
    }
  ]
}

json

application/json

setCardOperationLimit

POST

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

/IntegrationDigitalChannelPrepaid/prepaid/api/setCardOperationLimit

Sets an operation limit on a prepaid card.

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

setCardOperationLimit › Request Body

SetCardOperationLimitRequest

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]

array | null

List Of Operation Limit - [Optional]

setCardOperationLimit › Responses

Success

SetCardOperationLimitResponse

array | null

List Of Result - [Optional]

POST/IntegrationDigitalChannelPrepaid/prepaid/api/setCardOperationLimit

curl https://everest-sandboxapi.dgpays.com/SandBox/IntegrationDigitalChannelPrepaid/prepaid/api/setCardOperationLimit \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'evrst-ptrnid: x_request_id' \
  --data '{
  "channel": "channel",
  "cardRefNumber": "cardRefNumber",
  "listOfOperationLimit": [
    {
      "keys": {
        "limitProfileDetailId": 0,
        "trnLimitationGroupCode": "trnLimitationGroupCode",
        "trnLimitationGroupDescription": "trnLimitationGroupDescription",
        "trnMainLimitationGroupCode": "trnMainLimitationGroupCode",
        "trnMainLimitationGroupDescription": "trnMainLimitationGroupDescription",
        "networkType": "networkType",
        "networkDescription": "networkDescription",
        "channelType": "channelType",
        "channelDescription": "channelDescription",
        "eventCode": "eventCode",
        "eventDescription": "eventDescription",
        "customLimitationChangeFlag": true
      },
      "profileCode": "profileCode",
      "profileDescription": "profileDescription",
      "perTrnAmount": 0,
      "perTrnAmountLimitRatio": 0,
      "dailyTrnCount": 0,
      "dailyTrnAmount": 0,
      "weeklyTrnCount": 0,
      "weeklyTrnAmount": 0,
      "monthlyTrnCount": 0,
      "monthlyTrnAmount": 0,
      "yearlyTrnCount": 0,
      "yearlyTrnAmount": 0,
      "cardType": "cardType"
    }
  ]
}'

Example Request Body

{
  "channel": "channel",
  "cardRefNumber": "cardRefNumber",
  "listOfOperationLimit": [
    {
      "keys": {
        "limitProfileDetailId": 0,
        "trnLimitationGroupCode": "trnLimitationGroupCode",
        "trnLimitationGroupDescription": "trnLimitationGroupDescription",
        "trnMainLimitationGroupCode": "trnMainLimitationGroupCode",
        "trnMainLimitationGroupDescription": "trnMainLimitationGroupDescription",
        "networkType": "networkType",
        "networkDescription": "networkDescription",
        "channelType": "channelType",
        "channelDescription": "channelDescription",
        "eventCode": "eventCode",
        "eventDescription": "eventDescription",
        "customLimitationChangeFlag": true
      },
      "profileCode": "profileCode",
      "profileDescription": "profileDescription",
      "perTrnAmount": 0,
      "perTrnAmountLimitRatio": 0,
      "dailyTrnCount": 0,
      "dailyTrnAmount": 0,
      "weeklyTrnCount": 0,
      "weeklyTrnAmount": 0,
      "monthlyTrnCount": 0,
      "monthlyTrnAmount": 0,
      "yearlyTrnCount": 0,
      "yearlyTrnAmount": 0,
      "cardType": "cardType"
    }
  ]
}

json

application/json

Example Responses

{
  "listOfResult": [
    {
      "actionType": 0,
      "success": true,
      "errors": [
        {
          "errorCode": "errorCode",
          "errorText": "errorText"
        }
      ],
      "operationLimit": {
        "keys": {
          "limitProfileDetailId": 0,
          "trnLimitationGroupCode": "trnLimitationGroupCode",
          "trnLimitationGroupDescription": "trnLimitationGroupDescription",
          "trnMainLimitationGroupCode": "trnMainLimitationGroupCode",
          "trnMainLimitationGroupDescription": "trnMainLimitationGroupDescription",
          "networkType": "networkType",
          "networkDescription": "networkDescription",
          "channelType": "channelType",
          "channelDescription": "channelDescription",
          "eventCode": "eventCode",
          "eventDescription": "eventDescription",
          "customLimitationChangeFlag": true
        },
        "profileCode": "profileCode",
        "profileDescription": "profileDescription",
        "perTrnAmount": 0,
        "perTrnAmountLimitRatio": 0,
        "dailyTrnCount": 0,
        "dailyTrnAmount": 0,
        "weeklyTrnCount": 0,
        "weeklyTrnAmount": 0,
        "monthlyTrnCount": 0,
        "monthlyTrnAmount": 0,
        "yearlyTrnCount": 0,
        "yearlyTrnAmount": 0,
        "cardType": "cardType"
      }
    }
  ]
}

json

application/json

removeCustomerOperationLimit

POST

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

/IntegrationDigitalChannelPrepaid/prepaid/api/removeCustomerOperationLimit

Removes a specific operation limit from a prepaid customer.

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

removeCustomerOperationLimit › Request Body

RemoveCustomerOperationLimitRequest

customerNumber

integer · int64 · required

Customer Number

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.

array | null

List Of Operation Limit Keys - [Optional]

removeCustomerOperationLimit › Responses

Success

RemoveCustomerOperationLimitResponse

array | null

List Of Result - [Optional]

POST/IntegrationDigitalChannelPrepaid/prepaid/api/removeCustomerOperationLimit

curl https://everest-sandboxapi.dgpays.com/SandBox/IntegrationDigitalChannelPrepaid/prepaid/api/removeCustomerOperationLimit \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'evrst-ptrnid: x_request_id' \
  --data '{
  "channel": "channel",
  "customerNumber": 0,
  "listOfOperationLimitKeys": [
    {
      "operationLimitRecordId": 0
    }
  ]
}'

Example Request Body

{
  "channel": "channel",
  "customerNumber": 0,
  "listOfOperationLimitKeys": [
    {
      "operationLimitRecordId": 0
    }
  ]
}

json

application/json

Example Responses

{
  "listOfResult": [
    {
      "actionType": 0,
      "success": true,
      "errors": [
        {
          "errorCode": "errorCode",
          "errorText": "errorText"
        }
      ],
      "operationLimitKeys": {
        "operationLimitRecordId": 0
      }
    }
  ]
}

json

application/json

removeCardOperationLimit

POST

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

/IntegrationDigitalChannelPrepaid/prepaid/api/removeCardOperationLimit

Removes a specific operation limit from a prepaid card.

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

removeCardOperationLimit › Request Body

RemoveCardOperationLimitRequest

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]

array | null

List Of Remove Operation Limit Keys - [Optional]

removeCardOperationLimit › Responses

Success

RemoveCardOperationLimitResponse

array | null

List Of Result - [Optional]

POST/IntegrationDigitalChannelPrepaid/prepaid/api/removeCardOperationLimit

curl https://everest-sandboxapi.dgpays.com/SandBox/IntegrationDigitalChannelPrepaid/prepaid/api/removeCardOperationLimit \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'evrst-ptrnid: x_request_id' \
  --data '{
  "channel": "channel",
  "cardRefNumber": "cardRefNumber",
  "listOfRemoveOperationLimitKeys": [
    {
      "operationLimitRecordId": 0
    }
  ]
}'

Example Request Body

{
  "channel": "channel",
  "cardRefNumber": "cardRefNumber",
  "listOfRemoveOperationLimitKeys": [
    {
      "operationLimitRecordId": 0
    }
  ]
}

json

application/json

Example Responses

{
  "listOfResult": [
    {
      "actionType": 0,
      "success": true,
      "operationLimitKeys": {
        "operationLimitRecordId": 0
      },
      "errors": [
        {
          "errorCode": "errorCode",
          "errorText": "errorText"
        }
      ]
    }
  ]
}

json

application/json

getCustomerLimitationParameterData

POST

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

/IntegrationDigitalChannelPrepaid/prepaid/api/getCustomerLimitationParameterData

Gets customer limitation parameter data for prepaid operations.

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

getCustomerLimitationParameterData › Request Body

GetCustomerLimitationParametersRequest

customerNumber

integer · int64 · required

Customer Number

getCustomerLimitationParameterData › Responses

Success

GetCustomerLimitationParametersResponse

array | null

Customer Limitation Parameter Data List - [Optional]

POST/IntegrationDigitalChannelPrepaid/prepaid/api/getCustomerLimitationParameterData

curl https://everest-sandboxapi.dgpays.com/SandBox/IntegrationDigitalChannelPrepaid/prepaid/api/getCustomerLimitationParameterData \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'evrst-ptrnid: x_request_id' \
  --data '{
  "customerNumber": 0
}'

Example Request Body

{
  "customerNumber": 0
}

json

application/json

Example Responses

{
  "customerLimitationParameterDataList": [
    {
      "customerNumber": 0,
      "customerLimitationFlag": true,
      "profileCode": "profileCode",
      "profileDescription": "profileDescription",
      "keys": {
        "limitProfileDetailId": 0,
        "trnLimitationGroupCode": "trnLimitationGroupCode",
        "trnLimitationGroupDescription": "trnLimitationGroupDescription",
        "trnMainLimitationGroupCode": "trnMainLimitationGroupCode",
        "trnMainLimitationGroupDescription": "trnMainLimitationGroupDescription",
        "networkType": "networkType",
        "networkDescription": "networkDescription",
        "channelType": "channelType",
        "channelDescription": "channelDescription",
        "eventCode": "eventCode",
        "eventDescription": "eventDescription",
        "customLimitationChangeFlag": true
      },
      "perTrnAmount": 0,
      "perTrnAmountLimitRatio": 0,
      "dailyTrnCount": 0,
      "dailyTrnAmount": 0,
      "weeklyTrnCount": 0,
      "weeklyTrnAmount": 0,
      "monthlyTrnCount": 0,
      "monthlyTrnAmount": 0,
      "yearlyTrnCount": 0,
      "yearlyTrnAmount": 0,
      "cardType": "cardType",
      "limitationProfileDetailId": 0
    }
  ]
}

json

application/json

Transactions Permissions and restrictions