Card issuance and personalisation

Create individual, corporate and virtual cards, and check which products a customer is eligible to hold before you issue.

createIndividualCard

POST

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

/IntegrationDigitalChannelCredit/credit/api/createIndividualCard

Creates a new individual credit card for a customer. Supports digital and physical cards, multiple accounts, addresses, auto payment, permissions, and optional card miscellaneous options. Returns card reference, shadow card number, masked card number, and sensitive card data if applicable.

Part of:

Journey 01 · Launching a new card product — step 4, Issue the card

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

createIndividualCard › Request Body

CreateIndividualCardRequest

channel

string · required

Required · Enum · NotNull — Three-digit channel code. Must be a defined channel, and the product must list it as an applicable channel.

Example: 002

productNumber

string · required

Required · NotNull — The product the card is issued on. Must be defined, applicable, and have at least one applicable channel.

customerNumber

integer · int64 · required

Required · NotNull — The customer the card is issued to.

branchCode

integer · int32 · required

Required · NotNull — The branch the card is issued from. Must be a defined branch.

digitalCardFlag

boolean

Digital Card Flag

nameOnCard

string | null

Name On Card - [Optional]

secondNameOnCard

string | null

Second Name On Card - [Optional]

cardDeliveryType

string | null

Optional — How the card reaches the cardholder. Branch makes cardDeliveryBranchCode mandatory.

cardSendAddressType

string | null

Card Send Address Type - [Optional]

cardDeliveryBranchCode

integer | null · int32

Conditional · NotNull — The branch the card is delivered to. Mandatory when cardDeliveryType is Branch.

cardSendAddressId

integer | null · int64

Card Send Address Id - [Optional]

object

Permissions - [Optional]

array | null

List Of Account - [Optional]

object

Card Misc Option - [Optional]

enrollMasterpass

boolean | null

Enroll Masterpass - [Optional]

contractType

string | null

Contract Type - [Optional]

contractVersionNumber

string | null

Contract Version Number - [Optional]

statementPeriod

string | null

Statement Period - [Optional]

statementCurrencyCode

string | null

Statement Currency Code - [Optional]

statementSendingAddressType

string | null

Statement Sending Address Type - [Optional]

statementPostFlag

boolean

Statement Post Flag - [Optional]

statementSmsSendFlag

boolean

Statement Sms Send Flag - [Optional]

statementEmailSendFlag

boolean

Statement Email Send Flag - [Optional]

statementSendAddressId

integer | null · int64

Statement Send Address Id - [Optional]

cardLimitValue

number · double

Card Limit Value - [Optional]

customerLimitValue

number | null · double

Customer Limit Value - [Optional]

authorizationSmsSendFlag

boolean

Authorization Sms Send Flag - [Optional]

authorizationSmsSendMinimumAmount

number | null · double

Authorization Sms Send Minimum Amount - [Optional]

autoInstallmentCount

integer | null · int32

Auto Installment Count - [Optional]

autoDeferringMonthCount

integer | null · int32

Auto Deferring Month Count - [Optional]

autoLimitIncreaseFlag

boolean

Auto Limit Increase Flag - [Optional]

autoPaymentFlag

boolean

Auto Payment Flag - [Optional]

object

Auto Payment Account - [Optional]

applicationChannel

string | null

Application Channel - [Optional]

applicationId

string | null

Application Id - [Optional]

applicationDate

string | null · date-time

Application Date - [Optional]

applicationContractId

string | null

Application Contract Id - [Optional]

createIndividualCard › Responses

Success

CreateIndividualCardResponse

recordId

integer · int64 · required

Record Id

maskedCardNumber

string | null

Masked Card Number - [Optional]

shadowCardNumber

string | null

Shadow Card Number - [Optional]

cardRefNumber

string | null

Card Ref Number - [Optional]

mainCardRefNumber

string | null

Main Card Ref Number - [Optional]

object | null

Warnings - [Optional]

object

Sensitive Card Data - [Optional]

POST/IntegrationDigitalChannelCredit/credit/api/createIndividualCard

curl https://everest-sandboxapi.dgpays.com/SandBox/IntegrationDigitalChannelCredit/credit/api/createIndividualCard \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'evrst-ptrnid: x_request_id' \
  --data '{
  "channel": "005",
  "productNumber": "60002",
  "digitalCardFlag": true,
  "customerNumber": 73140,
  "branchCode": 100,
  "cardDeliveryType": "S",
  "cardDeliveryBranchCode": 100,
  "enrollMasterpass": false,
  "permissions": {
    "eCommercePermitted": true,
    "mailOrderPermitted": true,
    "internationalPurchasePermitted": true
  },
  "listOfAccount": [
    {
      "fecCode": 0,
      "accountBranchId": 100,
      "accountType": "A",
      "accountSuffix": 41,
      "accountNumber": 141414,
      "accountAlias": "test",
      "currencyCode": "784",
      "iban": "TR330006100519786457841326"
    }
  ],
  "nameOnCard": "test card",
  "statementPeriod": "070101",
  "statementCurrencyCode": "784",
  "statementSendingAddressType": "AL",
  "statementPostFlag": true,
  "statementSmsSendFlag": true,
  "statementEmailSendFlag": true,
  "cardLimitValue": 50000,
  "customerLimitValue": 50000
}'

Example Request Body

{
  "channel": "005",
  "productNumber": "60002",
  "digitalCardFlag": true,
  "customerNumber": 73140,
  "branchCode": 100,
  "cardDeliveryType": "S",
  "cardDeliveryBranchCode": 100,
  "enrollMasterpass": false,
  "permissions": {
    "eCommercePermitted": true,
    "mailOrderPermitted": true,
    "internationalPurchasePermitted": true
  },
  "listOfAccount": [
    {
      "fecCode": 0,
      "accountBranchId": 100,
      "accountType": "A",
      "accountSuffix": 41,
      "accountNumber": 141414,
      "accountAlias": "test",
      "currencyCode": "784",
      "iban": "TR330006100519786457841326"
    }
  ],
  "nameOnCard": "test card",
  "statementPeriod": "070101",
  "statementCurrencyCode": "784",
  "statementSendingAddressType": "AL",
  "statementPostFlag": true,
  "statementSmsSendFlag": true,
  "statementEmailSendFlag": true,
  "cardLimitValue": 50000,
  "customerLimitValue": 50000
}

json

application/json

Example Responses

{
  "recordId": 0,
  "maskedCardNumber": "maskedCardNumber",
  "shadowCardNumber": "shadowCardNumber",
  "cardRefNumber": "cardRefNumber",
  "mainCardRefNumber": "mainCardRefNumber",
  "warnings": {
    "key": "string"
  },
  "sensitiveCardData": {
    "pan": "pan",
    "expiryDateStr": "expiryDateStr",
    "cvv": "cvv"
  }
}

json

application/json

createIndividualSupplementaryCard

POST

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

/IntegrationDigitalChannelCredit/credit/api/createIndividualSupplementaryCard

Creates a new individual supplementary credit card for a customer. Supports digital and physical cards, multiple accounts, addresses, auto payment, permissions, and optional card miscellaneous options. Returns card reference, shadow card number, masked card number, and sensitive card data if applicable.

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

createIndividualSupplementaryCard › Request Body

CreateIndividualSupplementaryCardRequest

productNumber

string · required

Product Number

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

digitalCardFlag

boolean

Digital Card Flag

customerNumber

integer · int64

Customer Number

shadowCardNumber

string | null

Shadow Card Number

nameOnCard

string | null

Name On Card

secondNameOnCard

string | null

Second Name On Card

branchCode

integer · int32

Branch Code

cardDeliveryType

string | null

Card Delivery Type

cardSendAddressType

string | null

Card Send Address Type

cardDeliveryBranchCode

integer | null · int32

Card Delivery Branch Code

cardSendAddressId

integer | null · int64

Card Send Address Id

object

Permissions

array | null

List Of Account

object

Card Misc Option

enrollMasterpass

boolean | null

Enroll Masterpass

contractType

string | null

Contract Type

contractVersionNumber

string | null

Contract Version Number

cardLimitValue

number · double

Card Limit Value

authorizationSmsSendFlag

boolean

Authorization Sms Send Flag

authorizationSmsSendMinimumAmount

number | null · double

Authorization Sms Send Minimum Amount

autoInstallmentCount

integer | null · int32

Auto Installment Count

autoDeferringMonthCount

integer | null · int32

Auto Deferring Month Count

applicationChannel

string | null

Application Channel

applicationId

string | null

Application Id

applicationDate

string | null · date-time

Application Date

applicationContractId

string | null

Application Contract Id

createIndividualSupplementaryCard › Responses

Success

CreateIndividualSupplementaryCardResponse

recordId

integer · int64 · required

Record Id

maskedCardNumber

string | null

Masked Card Number

shadowCardNumber

string | null

Shadow Card Number

cardRefNumber

string | null

Card Ref Number

mainCardRefNumber

string | null

Main Card Ref Number

object | null

Warnings

object

Sensitive Card Data

POST/IntegrationDigitalChannelCredit/credit/api/createIndividualSupplementaryCard

curl https://everest-sandboxapi.dgpays.com/SandBox/IntegrationDigitalChannelCredit/credit/api/createIndividualSupplementaryCard \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'evrst-ptrnid: x_request_id' \
  --data '{
  "channel": "002",
  "productNumber": "productNumber",
  "digitalCardFlag": true,
  "customerNumber": 0,
  "shadowCardNumber": "shadowCardNumber",
  "nameOnCard": "nameOnCard",
  "secondNameOnCard": "secondNameOnCard",
  "branchCode": 0,
  "cardDeliveryType": "cardDeliveryType",
  "cardSendAddressType": "cardSendAddressType",
  "cardDeliveryBranchCode": 0,
  "cardSendAddressId": 0,
  "permissions": {
    "eCommercePermitted": true,
    "mailOrderPermitted": true,
    "internationalPurchasePermitted": true
  },
  "listOfAccount": [
    {
      "accountType": "accountType",
      "accountNumber": 0,
      "accountOrderFlag": true,
      "currencyCode": "currencyCode"
    }
  ],
  "cardMiscOption": {
    "optionType": "optionType",
    "optionValue": "optionValue"
  },
  "enrollMasterpass": true,
  "contractType": "contractType",
  "contractVersionNumber": "contractVersionNumber",
  "cardLimitValue": 0,
  "authorizationSmsSendFlag": true,
  "authorizationSmsSendMinimumAmount": 0,
  "autoInstallmentCount": 0,
  "autoDeferringMonthCount": 0,
  "applicationChannel": "applicationChannel",
  "applicationId": "applicationId",
  "applicationDate": "2024-08-25T15:00:00Z",
  "applicationContractId": "applicationContractId"
}'

Example Request Body

{
  "channel": "002",
  "productNumber": "productNumber",
  "digitalCardFlag": true,
  "customerNumber": 0,
  "shadowCardNumber": "shadowCardNumber",
  "nameOnCard": "nameOnCard",
  "secondNameOnCard": "secondNameOnCard",
  "branchCode": 0,
  "cardDeliveryType": "cardDeliveryType",
  "cardSendAddressType": "cardSendAddressType",
  "cardDeliveryBranchCode": 0,
  "cardSendAddressId": 0,
  "permissions": {
    "eCommercePermitted": true,
    "mailOrderPermitted": true,
    "internationalPurchasePermitted": true
  },
  "listOfAccount": [
    {
      "accountType": "accountType",
      "accountNumber": 0,
      "accountOrderFlag": true,
      "currencyCode": "currencyCode"
    }
  ],
  "cardMiscOption": {
    "optionType": "optionType",
    "optionValue": "optionValue"
  },
  "enrollMasterpass": true,
  "contractType": "contractType",
  "contractVersionNumber": "contractVersionNumber",
  "cardLimitValue": 0,
  "authorizationSmsSendFlag": true,
  "authorizationSmsSendMinimumAmount": 0,
  "autoInstallmentCount": 0,
  "autoDeferringMonthCount": 0,
  "applicationChannel": "applicationChannel",
  "applicationId": "applicationId",
  "applicationDate": "2024-08-25T15:00:00Z",
  "applicationContractId": "applicationContractId"
}

json

application/json

Example Responses

{
  "recordId": 0,
  "maskedCardNumber": "maskedCardNumber",
  "shadowCardNumber": "shadowCardNumber",
  "cardRefNumber": "cardRefNumber",
  "mainCardRefNumber": "mainCardRefNumber",
  "warnings": {
    "key": "string"
  },
  "sensitiveCardData": {
    "pan": "pan",
    "expiryDateStr": "expiryDateStr",
    "cvv": "cvv"
  }
}

json

application/json

createDummyCorporateCard

POST

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

/IntegrationDigitalChannelCredit/credit/api/createDummyCorporateCard

Creates a new dummy corporate credit card. Supports specifying addresses, accounts, statement preferences, card limits, virtual card relation, auto payment accounts, and permissions. Returns card reference, shadow numbers, masked card number, record ID, warnings, and sensitive card data if applicable.

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

createDummyCorporateCard › Request Body

CreateDummyCorporateCardRequest

productNumber

string · required

Product Number

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

digitalCardFlag

boolean

Digital Card Flag

customerNumber

integer · int64

Customer Number

nameOnCard

string | null

Name On Card

branchCode

integer · int32

Branch Code

statementPeriod

string | null

Statement Period

statementCurrencyCode

string | null

Statement Currency Code

statementPostFlag

boolean

Statement Post Flag

statementSmsSendFlag

boolean

Statement Sms Send Flag

statementEmailSendFlag

boolean

Statement Email Send Flag

statementSendingAddressType

string | null

Statement Sending Address Type

statementSendAddressId

integer | null · int64

Statement Send Address Id

cardLimitValue

number · double

Card Limit Value

customerLimitValue

number | null · double

Customer Limit Value

autoInstallmentCount

integer | null · int32

Auto Installment Count

autoDeferringMonthCount

integer | null · int32

Auto Deferring Month Count

autoLimitIncreaseFlag

boolean

Auto Limit Increase Flag

autoPaymentFlag

boolean

Auto Payment Flag

object

Auto Payment Account

applicationId

string | null

Application Id

applicationDate

string | null · date-time

Application Date

applicationContractId

string | null

Application Contract Id

createDummyCorporateCard › Responses

Success

CreateDummyCorporateCardResponse

cardMasterRecordId

integer · int64 · required

Card Master Record Id

secureCardMasterRecordId

integer · int64 · required

Secure Card Master Record Id

cardRefNumber

string | null

Card Ref Number

mainCardRefNumber

string | null

Main Card Ref Number

shadowCardNumber

string | null

Shadow Card Number

object | null

Warnings

POST/IntegrationDigitalChannelCredit/credit/api/createDummyCorporateCard

curl https://everest-sandboxapi.dgpays.com/SandBox/IntegrationDigitalChannelCredit/credit/api/createDummyCorporateCard \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'evrst-ptrnid: x_request_id' \
  --data '{
  "channel": "002",
  "productNumber": "productNumber",
  "digitalCardFlag": true,
  "customerNumber": 0,
  "nameOnCard": "nameOnCard",
  "branchCode": 0,
  "statementPeriod": "statementPeriod",
  "statementCurrencyCode": "statementCurrencyCode",
  "statementPostFlag": true,
  "statementSmsSendFlag": true,
  "statementEmailSendFlag": true,
  "statementSendingAddressType": "statementSendingAddressType",
  "statementSendAddressId": 0,
  "cardLimitValue": 0,
  "customerLimitValue": 0,
  "autoInstallmentCount": 0,
  "autoDeferringMonthCount": 0,
  "autoLimitIncreaseFlag": true,
  "autoPaymentFlag": true,
  "autoPaymentAccount": {
    "paymentType": "paymentType",
    "accountBranchId": 0,
    "accountSuffix": 0,
    "accountNumber": 0
  },
  "applicationId": "applicationId",
  "applicationDate": "2024-08-25T15:00:00Z",
  "applicationContractId": "applicationContractId"
}'

Example Request Body

{
  "channel": "002",
  "productNumber": "productNumber",
  "digitalCardFlag": true,
  "customerNumber": 0,
  "nameOnCard": "nameOnCard",
  "branchCode": 0,
  "statementPeriod": "statementPeriod",
  "statementCurrencyCode": "statementCurrencyCode",
  "statementPostFlag": true,
  "statementSmsSendFlag": true,
  "statementEmailSendFlag": true,
  "statementSendingAddressType": "statementSendingAddressType",
  "statementSendAddressId": 0,
  "cardLimitValue": 0,
  "customerLimitValue": 0,
  "autoInstallmentCount": 0,
  "autoDeferringMonthCount": 0,
  "autoLimitIncreaseFlag": true,
  "autoPaymentFlag": true,
  "autoPaymentAccount": {
    "paymentType": "paymentType",
    "accountBranchId": 0,
    "accountSuffix": 0,
    "accountNumber": 0
  },
  "applicationId": "applicationId",
  "applicationDate": "2024-08-25T15:00:00Z",
  "applicationContractId": "applicationContractId"
}

json

application/json

Example Responses

{
  "cardRefNumber": "cardRefNumber",
  "mainCardRefNumber": "mainCardRefNumber",
  "shadowCardNumber": "shadowCardNumber",
  "cardMasterRecordId": 0,
  "secureCardMasterRecordId": 0,
  "warnings": {
    "key": "string"
  }
}

json

application/json

createCorporateCard

POST

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

/IntegrationDigitalChannelCredit/credit/api/createCorporateCard

Creates a new corporate credit card. Supports specifying addresses, accounts, statement preferences, card limits, virtual card relation, auto payment accounts, and permissions. Returns card reference, shadow numbers, masked card number, record ID, warnings, and sensitive card data if applicable.

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

createCorporateCard › Request Body

CreateCorporateCardRequest

productNumber

string · required

Product Number

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

digitalCardFlag

boolean

Digital Card Flag

customerNumber

integer · int64

Customer Number - [Optional]

shadowCardNumber

string | null

Shadow Card Number

nameOnCard

string | null

Name On Card - [Optional]

secondNameOnCard

string | null

Second Name On Card - [Optional]

branchCode

integer · int32

Branch Code - [Optional]

cardDeliveryType

string | null

Card Delivery Type - [Optional]

cardSendAddressType

string | null

Card Send Address Type - [Optional]

cardSendAddressId

integer | null · int64

Card Send Address Id - [Optional]

cardDeliveryBranchCode

integer | null · int32

Card Delivery Branch Code - [Optional]

enrollMasterpass

boolean | null

Enroll Masterpass - [Optional]

object

Permissions - [Optional]

array | null

List Of Account - [Optional]

contractType

string | null

Contract Type - [Optional]

contractVersionNumber

string | null

Contract Version Number - [Optional]

cardLimitValue

number · double

Card Limit Value - [Optional]

authorizationSmsSendFlag

boolean

Authorization Sms Send Flag - [Optional]

authorizationSmsSendMinimumAmount

number | null · double

Authorization Sms Send Minimum Amount - [Optional]

applicationChannel

string | null

Application Channel - [Optional]

applicationId

string | null

Application Id - [Optional]

applicationDate

string | null · date-time

Application Date - [Optional]

applicationContractId

string | null

Application Contract Id - [Optional]

createCorporateCard › Responses

Success

CreateCorporateCardResponse

recordId

integer · int64 · required

Record Id

maskedCardNumber

string | null

Masked Card Number - [Optional]

shadowCardNumber

string | null

Shadow Card Number - [Optional]

mainShadowCardNumber

string | null

Main Shadow Card Number - [Optional]

cardRefNumber

string | null

Card Ref Number - [Optional]

mainCardRefNumber

string | null

Main Card Ref Number - [Optional]

object | null

Warnings - [Optional]

object

Sensitive Card Data - [Optional]

POST/IntegrationDigitalChannelCredit/credit/api/createCorporateCard

curl https://everest-sandboxapi.dgpays.com/SandBox/IntegrationDigitalChannelCredit/credit/api/createCorporateCard \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'evrst-ptrnid: x_request_id' \
  --data '{
  "channel": "002",
  "productNumber": "productNumber",
  "digitalCardFlag": true,
  "customerNumber": 0,
  "shadowCardNumber": "shadowCardNumber",
  "nameOnCard": "nameOnCard",
  "secondNameOnCard": "secondNameOnCard",
  "branchCode": 0,
  "cardDeliveryType": "cardDeliveryType",
  "cardSendAddressType": "cardSendAddressType",
  "cardSendAddressId": 0,
  "cardDeliveryBranchCode": 0,
  "enrollMasterpass": true,
  "permissions": {
    "eCommercePermitted": true,
    "mailOrderPermitted": true,
    "internationalPurchasePermitted": true
  },
  "listOfAccount": [
    {
      "accountType": "accountType",
      "accountNumber": 0,
      "accountOrderFlag": true,
      "currencyCode": "currencyCode"
    }
  ],
  "contractType": "contractType",
  "contractVersionNumber": "contractVersionNumber",
  "cardLimitValue": 0,
  "authorizationSmsSendFlag": true,
  "authorizationSmsSendMinimumAmount": 0,
  "applicationChannel": "applicationChannel",
  "applicationId": "applicationId",
  "applicationDate": "2024-08-25T15:00:00Z",
  "applicationContractId": "applicationContractId"
}'

Example Request Body

{
  "channel": "002",
  "productNumber": "productNumber",
  "digitalCardFlag": true,
  "customerNumber": 0,
  "shadowCardNumber": "shadowCardNumber",
  "nameOnCard": "nameOnCard",
  "secondNameOnCard": "secondNameOnCard",
  "branchCode": 0,
  "cardDeliveryType": "cardDeliveryType",
  "cardSendAddressType": "cardSendAddressType",
  "cardSendAddressId": 0,
  "cardDeliveryBranchCode": 0,
  "enrollMasterpass": true,
  "permissions": {
    "eCommercePermitted": true,
    "mailOrderPermitted": true,
    "internationalPurchasePermitted": true
  },
  "listOfAccount": [
    {
      "accountType": "accountType",
      "accountNumber": 0,
      "accountOrderFlag": true,
      "currencyCode": "currencyCode"
    }
  ],
  "contractType": "contractType",
  "contractVersionNumber": "contractVersionNumber",
  "cardLimitValue": 0,
  "authorizationSmsSendFlag": true,
  "authorizationSmsSendMinimumAmount": 0,
  "applicationChannel": "applicationChannel",
  "applicationId": "applicationId",
  "applicationDate": "2024-08-25T15:00:00Z",
  "applicationContractId": "applicationContractId"
}

json

application/json

Example Responses

{
  "recordId": 0,
  "maskedCardNumber": "maskedCardNumber",
  "shadowCardNumber": "shadowCardNumber",
  "mainShadowCardNumber": "mainShadowCardNumber",
  "cardRefNumber": "cardRefNumber",
  "mainCardRefNumber": "mainCardRefNumber",
  "warnings": {
    "key": "string"
  },
  "sensitiveCardData": {
    "pan": "pan",
    "expiryDateStr": "expiryDateStr",
    "cvv": "cvv"
  }
}

json

application/json

createVirtualCard

POST

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

/IntegrationDigitalChannelCredit/credit/api/createVirtualCard

Creates a virtual credit card for a customer. Supports Masterpass enrollment, end-of-day limit flag, and configurable limits. Returns card reference, shadow card number, masked card number, record ID, warnings, and sensitive card data including PAN, CVV, and expiry date.

Part of:

Journey 01 · Launching a new card product — step 4, Issue the card

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

createVirtualCard › Request Body

CreateVirtualCardRequest

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

shadowCardNumber

string | null

Shadow Card Number - [Optional]

limitType

string | null

Limit Type - [Optional]

endOfDayFlag

boolean | null

End Of Day Flag - [Optional]

limit

number · double

Limit - [Optional]

enrollMasterpass

boolean | null

Enroll Masterpass - [Optional]

createVirtualCard › Responses

Success

CreateVirtualCardResponse

recordId

integer · int64 · required

Record Id

maskedCardNumber

string | null

Masked Card Number - [Optional]

shadowCardNumber

string | null

Shadow Card Number - [Optional]

cardRefNumber

string | null

Card Ref Number - [Optional]

relatedCardRefNumber

string | null

Related Card Ref Number - [Optional]

mainCardRefNumber

string | null

Main Card Ref Number - [Optional]

object | null

Warnings - [Optional]

object

Sensitive Card Data - [Optional]

POST/IntegrationDigitalChannelCredit/credit/api/createVirtualCard

curl https://everest-sandboxapi.dgpays.com/SandBox/IntegrationDigitalChannelCredit/credit/api/createVirtualCard \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'evrst-ptrnid: x_request_id' \
  --data '{
  "channel": "008",
  "shadowCardNumber": "1201262350000646502",
  "limitType": "S",
  "endOfDayFlag": false,
  "limit": 20000,
  "enrollMasterpass": false
}'

Example Request Body

{
  "channel": "008",
  "shadowCardNumber": "1201262350000646502",
  "limitType": "S",
  "endOfDayFlag": false,
  "limit": 20000,
  "enrollMasterpass": false
}

json

application/json

Example Responses

{
  "recordId": 0,
  "maskedCardNumber": "maskedCardNumber",
  "shadowCardNumber": "shadowCardNumber",
  "cardRefNumber": "cardRefNumber",
  "relatedCardRefNumber": "relatedCardRefNumber",
  "mainCardRefNumber": "mainCardRefNumber",
  "warnings": {
    "key": "string"
  },
  "sensitiveCardData": {
    "pan": "pan",
    "expiryDateStr": "expiryDateStr",
    "cvv": "cvv"
  }
}

json

application/json

getApplicableProductsByCustomerNumber

POST

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

/IntegrationDigitalChannelCredit/credit/api/getApplicableProductsByCustomerNumber

Retrieves all credit card products applicable to a customer. Returns both product-level and customer asset-level information, including digital card capabilities, annual fees, and main card details.

Part of:

Journey 01 · Launching a new card product — step 2, Choose the product

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

getApplicableProductsByCustomerNumber › Request Body

GetApplicableProductsByCustomerNumberRequest

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

customerNumber

integer · int64

Customer Number - [Optional]

mainCustomerNumber

integer | null · int64

Main Customer Number - [Optional]

shadowCardNumber

string | null

Shadow Card Number - [Optional]

object

Filter - [Optional]

getApplicableProductsByCustomerNumber › Responses

Success

GetApplicableProductsByCustomerNumberResponse

array | null

List Of Product - [Optional]

array | null

List Of Asset - [Optional]

POST/IntegrationDigitalChannelCredit/credit/api/getApplicableProductsByCustomerNumber

curl https://everest-sandboxapi.dgpays.com/SandBox/IntegrationDigitalChannelCredit/credit/api/getApplicableProductsByCustomerNumber \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'evrst-ptrnid: x_request_id' \
  --data '{
  "channel": "008",
  "customerNumber": 73140
}'

Example Request Body

{
  "channel": "008",
  "customerNumber": 73140
}

json

application/json

Example Responses

{
  "listOfProduct": [
    {
      "productNumber": "productNumber",
      "productName": "productName",
      "productShortName": "productShortName",
      "brand": "brand",
      "digitalAbility": true,
      "tenantId": "tenantId",
      "supplementaryCard": true,
      "mainCardInfo": {
        "currentCard": true,
        "cardRefNumber": "cardRefNumber",
        "cardStatusCode": "cardStatusCode",
        "cardStatusReasonCode": "cardStatusReasonCode",
        "customerNumber": 0,
        "digitalCard": true,
        "mainCardRefNumber": "mainCardRefNumber",
        "mainCustomerNumber": 0,
        "maskedCardNumber": "maskedCardNumber",
        "productNumber": "productNumber",
        "shadowCardNumber": "shadowCardNumber",
        "supplementaryCard": true,
        "statementCurrencyCode": "statementCurrencyCode",
        "statementPeriod": "statementPeriod",
        "statementPeriodDescription": "statementPeriodDescription",
        "nextStatementDate": "nextStatementDate"
      },
      "cardAnnualFeeAmount": 0
    }
  ],
  "listOfAsset": [
    {
      "currentCard": true,
      "cardRefNumber": "cardRefNumber",
      "cardStatusCode": "cardStatusCode",
      "cardStatusReasonCode": "cardStatusReasonCode",
      "customerNumber": 0,
      "digitalCard": true,
      "mainCardRefNumber": "mainCardRefNumber",
      "mainCustomerNumber": 0,
      "maskedCardNumber": "maskedCardNumber",
      "productNumber": "productNumber",
      "shadowCardNumber": "shadowCardNumber",
      "supplementaryCard": true,
      "statementCurrencyCode": "statementCurrencyCode",
      "statementPeriod": "statementPeriod",
      "statementPeriodDescription": "statementPeriodDescription",
      "nextStatementDate": "nextStatementDate"
    }
  ]
}

json

application/json

getApplicableProductsByMainCustomerPreControl

POST

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

/IntegrationDigitalChannelCredit/credit/api/getApplicableProductsByMainCustomerPreControl

Checks applicable credit card products for a main customer before control. Returns a success flag indicating whether the pre-control check passed.

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

getApplicableProductsByMainCustomerPreControl › Request Body

GetApplicableProductsByMainCustomerRequest

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

mainCustomerNumber

integer · int64

Main Customer Number - [Optional]

object

Filter - [Optional]

getApplicableProductsByMainCustomerPreControl › Responses

Success

GetApplicableProductsByMainCustomerResponse

isSuccess

boolean · required

Is Success

createNoNameCard

POST

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

/IntegrationDigitalChannelCredit/credit/api/createNoNameCard

Creates a no-name credit card for a customer. Supports both digital and physical products, with configurable limits, permissions, accounts, and optional Masterpass enrollment. Returns card reference, shadow card number, masked card number, record ID, warnings, and sensitive card data if applicable.

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

createNoNameCard › Request Body

CreateNoNameCardRequest

productNumber

string · required

Product Number

barcode

string | null

Barcode - [Optional]

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

customerNumber

integer · int64

Customer Number - [Optional]

mainCustomerNumber

integer | null · int64

Main Customer Number - [Optional]

mainCardRefNumber

string | null

Main Card Ref Number - [Optional]

branchCode

integer · int32

Branch Code - [Optional]

cardSendAddressType

string | null

Card Send Address Type - [Optional]

enrollMasterpass

boolean | null

Enroll Masterpass - [Optional]

object

Permissions - [Optional]

array | null

List Of Account - [Optional]

contractType

string | null

Contract Type - [Optional]

statementPeriod

string | null

Statement Period - [Optional]

statementCurrencyCode

string | null

Statement Currency Code - [Optional]

cardLimitValue

number · double

Card Limit Value - [Optional]

customerLimitValue

number | null · double

Customer Limit Value - [Optional]

autoLimitIncreaseFlag

boolean

Auto Limit Increase Flag - [Optional]

applicationChannel

string | null

Application Channel - [Optional]

applicationId

string | null

Application Id - [Optional]

applicationDate

string | null · date-time

Application Date - [Optional]

applicationContractId

string | null

Application Contract Id - [Optional]

createNoNameCard › Responses

Success

CreateNoNameCardResponse

recordId

integer · int64 · required

Record Id

maskedCardNumber

string | null

Masked Card Number - [Optional]

shadowCardNumber

string | null

Shadow Card Number - [Optional]

cardRefNumber

string | null

Card Ref Number - [Optional]

mainCardRefNumber

string | null

Main Card Ref Number - [Optional]

object | null

Warnings - [Optional]

object

Sensitive Card Data - [Optional]

POST/IntegrationDigitalChannelCredit/credit/api/createNoNameCard

curl https://everest-sandboxapi.dgpays.com/SandBox/IntegrationDigitalChannelCredit/credit/api/createNoNameCard \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'evrst-ptrnid: x_request_id' \
  --data '{
  "barcode": "barcode",
  "channel": "002",
  "productNumber": "productNumber",
  "customerNumber": 0,
  "mainCustomerNumber": 0,
  "mainCardRefNumber": "mainCardRefNumber",
  "branchCode": 0,
  "cardSendAddressType": "cardSendAddressType",
  "enrollMasterpass": true,
  "permissions": {
    "eCommercePermitted": true,
    "mailorderPermitted": true,
    "internationalPurchasePermitted": true
  },
  "listOfAccount": [
    {
      "accountType": "accountType",
      "accountNumber": 0,
      "accountOrderFlag": true,
      "currencyCode": "currencyCode"
    }
  ],
  "contractType": "contractType",
  "statementPeriod": "statementPeriod",
  "statementCurrencyCode": "statementCurrencyCode",
  "cardLimitValue": 0,
  "customerLimitValue": 0,
  "autoLimitIncreaseFlag": true,
  "applicationChannel": "applicationChannel",
  "applicationId": "applicationId",
  "applicationDate": "2024-08-25T15:00:00Z",
  "applicationContractId": "applicationContractId"
}'

Example Request Body

{
  "barcode": "barcode",
  "channel": "002",
  "productNumber": "productNumber",
  "customerNumber": 0,
  "mainCustomerNumber": 0,
  "mainCardRefNumber": "mainCardRefNumber",
  "branchCode": 0,
  "cardSendAddressType": "cardSendAddressType",
  "enrollMasterpass": true,
  "permissions": {
    "eCommercePermitted": true,
    "mailorderPermitted": true,
    "internationalPurchasePermitted": true
  },
  "listOfAccount": [
    {
      "accountType": "accountType",
      "accountNumber": 0,
      "accountOrderFlag": true,
      "currencyCode": "currencyCode"
    }
  ],
  "contractType": "contractType",
  "statementPeriod": "statementPeriod",
  "statementCurrencyCode": "statementCurrencyCode",
  "cardLimitValue": 0,
  "customerLimitValue": 0,
  "autoLimitIncreaseFlag": true,
  "applicationChannel": "applicationChannel",
  "applicationId": "applicationId",
  "applicationDate": "2024-08-25T15:00:00Z",
  "applicationContractId": "applicationContractId"
}

json

application/json

Example Responses

{
  "recordId": 0,
  "maskedCardNumber": "maskedCardNumber",
  "shadowCardNumber": "shadowCardNumber",
  "cardRefNumber": "cardRefNumber",
  "mainCardRefNumber": "mainCardRefNumber",
  "warnings": {
    "key": "string"
  },
  "sensitiveCardData": {
    "pan": "pan",
    "expiryDateStr": "expiryDateStr",
    "cvv": "cvv"
  }
}

json

application/json

cancelCardEmbossByShadowCardNumber

POST

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

/IntegrationDigitalChannelCredit/credit/api/cancelCardEmbossByShadowCardNumber

Cancels the embossing process of a credit card using the shadow card number. Validates input before calling the issuing service proxy. Logs the operation start, failure, and completion.

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

cancelCardEmbossByShadowCardNumber › Request Body

CancelCardEmbossByShadowCardNumberRequest

shadowCardNumber

string · required

Shadow Card Number

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

cancelCardEmbossByShadowCardNumber › Responses

Success

No data returned

getPendingCardEmbossList

POST

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

/IntegrationDigitalChannelCredit/credit/api/getPendingCardEmbossList

Retrieves the pending card embossing details for a given ShadowCardNumber. Returns information including card sequence number, emboss date, application date, emboss reason codes and descriptions, emboss status, masked card number, product type code and description, and validity flag. Validates the request to ensure ShadowCardNumber is not null or empty. Logs execution status and errors if the emboss retrieval fails.

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

getPendingCardEmbossList › Request Body

GetPendingCardEmbossListRequest

shadowCardNumber

string · required

Shadow Card Number

getPendingCardEmbossList › Responses

Success

GetPendingCardEmbossListResponse

cardSeqNumber

integer | null · int32

Card Seq Number - [Optional]

embossDate

string | null · date-time

Emboss Date - [Optional]

applicationDate

string | null · date-time

Application Date - [Optional]

embossReasonCode

string | null

Emboss Reason Code - [Optional]

embossReasonDescription

string | null

Emboss Reason Description - [Optional]

embossReasonSubCode

string | null

Emboss Reason Sub Code - [Optional]

embossReasonSubDesc

string | null

Emboss Reason Sub Desc - [Optional]

embossStatus

string | null

Emboss Status - [Optional]

maskedCardNumber

string | null

Masked Card Number - [Optional]

productTypeCode

string | null

Product Type Code - [Optional]

productTypeDescription

string | null

Product Type Description - [Optional]

shadowCardNumber

string | null

Shadow Card Number - [Optional]

validFlag

boolean | null

Valid Flag - [Optional]

POST/IntegrationDigitalChannelCredit/credit/api/getPendingCardEmbossList

curl https://everest-sandboxapi.dgpays.com/SandBox/IntegrationDigitalChannelCredit/credit/api/getPendingCardEmbossList \
  --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

{
  "cardSeqNumber": 0,
  "embossDate": "2024-08-25T15:00:00Z",
  "applicationDate": "2024-08-25T15:00:00Z",
  "embossReasonCode": "embossReasonCode",
  "embossReasonDescription": "embossReasonDescription",
  "embossReasonSubCode": "embossReasonSubCode",
  "embossReasonSubDesc": "embossReasonSubDesc",
  "embossStatus": "embossStatus",
  "maskedCardNumber": "maskedCardNumber",
  "productTypeCode": "productTypeCode",
  "productTypeDescription": "productTypeDescription",
  "shadowCardNumber": "shadowCardNumber",
  "validFlag": true
}

json

application/json

Card applications Card lifecycle