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

/IntegrationDigitalChannelPrepaid/prepaid/api/createIndividualCard

Creates an individual prepaid card for a customer.

Part of:

Journey 01 · Launching a new card product — step 2, Issue from stock

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

customerNumber

integer · int64 · required

Customer Number

branchCode

integer · int32 · required

Branch Code

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.

productNumber

string | null

Product Number - [Optional]

mainCustomerNumber

integer | null · int64

Main Customer Number - [Optional]

mainCardRefNumber

string | null

Main Card Ref Number - [Optional]

cardDeliveryType

string | null

Card Delivery Type - [Optional]

cardSendAddressType

string | null

Card Send Address Type - [Optional]

cardDeliveryBranchCode

integer | null · int32

Card Delivery Branch Code - [Optional]

enrollMasterpass

boolean | null

Enroll Masterpass - [Optional]

object

Permissions - [Optional]

contractType

string | null

Contract Type - [Optional]

contractVersionNumber

string | null

Contract Version Number - [Optional]

virtualCardRelatedCardRefNumber

string | null

Virtual Card Related Card Ref Number - [Optional]

nameOnCard

string | null

Name On Card - [Optional]

cardSendAddressId

integer | null · int64

Card Send Address 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]

applicationId

integer | null · int64

Application Id - [Optional]

POST/IntegrationDigitalChannelPrepaid/prepaid/api/createIndividualCard

curl https://everest-sandboxapi.dgpays.com/SandBox/IntegrationDigitalChannelPrepaid/prepaid/api/createIndividualCard \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'evrst-ptrnid: x_request_id' \
  --data '{
  "channel": "channel",
  "productNumber": "productNumber",
  "customerNumber": 0,
  "mainCustomerNumber": 0,
  "mainCardRefNumber": "mainCardRefNumber",
  "branchCode": 0,
  "cardDeliveryType": "cardDeliveryType",
  "cardSendAddressType": "cardSendAddressType",
  "cardDeliveryBranchCode": 0,
  "enrollMasterpass": true,
  "permissions": {
    "eCommercePermitted": true,
    "mailOrderPermitted": true,
    "internationalPurchasePermitted": true
  },
  "contractType": "contractType",
  "contractVersionNumber": "contractVersionNumber",
  "virtualCardRelatedCardRefNumber": "virtualCardRelatedCardRefNumber",
  "nameOnCard": "nameOnCard",
  "cardSendAddressId": 0,
  "applicationDate": "2024-08-25T15:00:00Z",
  "applicationContractId": "applicationContractId"
}'

Example Request Body

{
  "channel": "channel",
  "productNumber": "productNumber",
  "customerNumber": 0,
  "mainCustomerNumber": 0,
  "mainCardRefNumber": "mainCardRefNumber",
  "branchCode": 0,
  "cardDeliveryType": "cardDeliveryType",
  "cardSendAddressType": "cardSendAddressType",
  "cardDeliveryBranchCode": 0,
  "enrollMasterpass": true,
  "permissions": {
    "eCommercePermitted": true,
    "mailOrderPermitted": true,
    "internationalPurchasePermitted": true
  },
  "contractType": "contractType",
  "contractVersionNumber": "contractVersionNumber",
  "virtualCardRelatedCardRefNumber": "virtualCardRelatedCardRefNumber",
  "nameOnCard": "nameOnCard",
  "cardSendAddressId": 0,
  "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"
  },
  "applicationId": 0
}

json

application/json

getApplicableProductsByCustomerNumber

POST

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

/IntegrationDigitalChannelPrepaid/prepaid/api/getApplicableProductsByCustomerNumber

Gets applicable prepaid products by customer number.

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

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.

mainCustomerNumber

integer | null · int64

Main Customer Number - [Optional]

object

Filter - [Optional]

getApplicableProductsByCustomerNumber › Responses

Success

GetApplicableProductsByCustomerNumberResponse

array | null

List Of Product - [Optional]

POST/IntegrationDigitalChannelPrepaid/prepaid/api/getApplicableProductsByCustomerNumber

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

Example Request Body

{
  "channel": "channel",
  "customerNumber": 0,
  "mainCustomerNumber": 0,
  "filter": {
    "productGroupCode": "productGroupCode"
  }
}

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
    }
  ]
}

json

application/json

Card applications Card lifecycle

createIndividualCard

POST

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

/IntegrationDigitalChannelPrepaid/prepaid/api/createIndividualCard

Creates an individual prepaid card for a customer.

Part of:

Journey 01 · Launching a new card product — step 2, Issue from stock

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

customerNumber

integer · int64 · required

Customer Number

branchCode

integer · int32 · required

Branch Code

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.

productNumber

string | null

Product Number - [Optional]

mainCustomerNumber

integer | null · int64

Main Customer Number - [Optional]

mainCardRefNumber

string | null

Main Card Ref Number - [Optional]

cardDeliveryType

string | null

Card Delivery Type - [Optional]

cardSendAddressType

string | null

Card Send Address Type - [Optional]

cardDeliveryBranchCode

integer | null · int32

Card Delivery Branch Code - [Optional]

enrollMasterpass

boolean | null

Enroll Masterpass - [Optional]

object

Permissions - [Optional]

contractType

string | null

Contract Type - [Optional]

contractVersionNumber

string | null

Contract Version Number - [Optional]

virtualCardRelatedCardRefNumber

string | null

Virtual Card Related Card Ref Number - [Optional]

nameOnCard

string | null

Name On Card - [Optional]

cardSendAddressId

integer | null · int64

Card Send Address 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]

applicationId

integer | null · int64

Application Id - [Optional]

getApplicableProductsByCustomerNumber

POST

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

/IntegrationDigitalChannelPrepaid/prepaid/api/getApplicableProductsByCustomerNumber

Gets applicable prepaid products by customer number.

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

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.

mainCustomerNumber

integer | null · int64

Main Customer Number - [Optional]

object

Filter - [Optional]

getApplicableProductsByCustomerNumber › Responses

Success

GetApplicableProductsByCustomerNumberResponse

array | null

List Of Product - [Optional]