Everest Card — API reference
  • Credit
  • Debit
  • Prepaid
  • Common Methods
  • OAuth2
  • Delivery
Information
Cards
    Card applications
      getPrepaidApplicationIdByFromShadowCardNumberpost
    Card issuance and personalisation
      createIndividualCardpostgetApplicableProductsByCustomerNumberpost
    Card lifecycle
      getPrepaidCardInfopostchangeAndReplaceCardpostchangeCardStatuspostreplaceCardpostgetCardListpost
    No-name cards
      createNoNameCardApplicationpostcancelNoNameCardApplicationpostupdateNoNameCardApplicationpostactivateNoNameCardpostcreateCardUsingNoNameApplicationpostreplaceNoNameCardpostreplaceCardUsingNoNameApplicationpostchangeAndReplaceNoNameCardpost
Customers and accounts
    Branch management
      changeCardBranchpostchangeCustomerBranchposttransferBranchCustomerpost
    Customers
      getCustomerAssetpostgetCustomerListOfBranchpost
Transactions
    getAuthorizationListByBegindateEnddatepostgetPddtransactionByCardrefCustomernumpostgetPrepaidTransactionAllpostgetPrepaidTransactionByUtidpostgetDigitalSlipReceiptpost
Limits and controls
    Operation limits
      getCardLimitationParameterDatapostgetCustomerOperationLimitpostgetCardOperationLimitpostsetCustomerOperationLimitpostsetCardOperationLimitpostremoveCustomerOperationLimitpostremoveCardOperationLimitpostgetCustomerLimitationParameterDatapost
    Permissions and restrictions
      getPrepaidCardPermissionpostsavePrepaidCardPermissionpost
Security
    PIN and card security
      changeCardPinpostchangeRsaPinpostgenerateCardVVpostincreasePinTryCountpostresetCvvCounterpostsetCardPinpostverifyTerminalCardPinpostverifyRsaPinpostverifyPartialCardVerificationValuepostverifyCardVerificationValuepostverifyCardPinpostsetRsaPinpostsetCardPinViaSMSpostgetCardPinOperationHistorypost
Platform
    Platform operations
      healthCheckpostrefreshCachepost
    Reference data
      getCardTypeByBinpost
SchemasError codesChannels
powered by Zudoku
Prepaid Digital Channels Integration
Prepaid Digital Channels Integration

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://sandboxpub.cms.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
channel
​string · maxLength: 3 · required

Three-digit code identifying the channel on behalf of which the request is made (e.g. 002 for Internet). Mandatory in every request. Used for entitlement checks, limit enforcement and audit logging. Channel codes are managed through configuration parameters and may change over time. Refer to the Channels page for the current list of valid codes.

productNumber
​string · maxLength: 5 · optional

The product to issue on. Leaving it out does not fail — it chooses. The facade reads the products applicable to the customer and takes the first one in that list, logging what it picked; which product is first is the platform's ordering, not a preference this API exposes. A customer with no applicable product is refused.

Sent, it must be a product the platform defines.

customerNumber
​integer · int64 · optional

Default — Defaults to 0, and 0 issues the card without a customer: the service skips the customer lookup. The customer the card belongs to. It is also what the automatic product choice above is made against.

mainCustomerNumber
​integer · int64 · optional

The main customer of a corporate relationship, as a number. The employees and supplementary holders under it carry their own customerNumber.

mainCardRefNumber
​string · maxLength: 19 · optional

The card reference of the main card. On a supplementary card this is the card it hangs from; on a main card it is the card's own reference.

branchCode
​integer · int32 · optional

Default — Defaults to 0. The branch the card is opened at. It is not checked against the branch list.

cardDeliveryType
​string · enum · maxLength: 1 · optional

Values:

  • P — by post
  • S — to the branch

Not set is "".

cardSendAddressType
​string · enum · maxLength: 2 · optional

Values:

  • RA — home
  • AL — business
  • EA — employer
  • OO — alternative
  • WA — previous
  • SW — SWIFT
  • SS — SWIFT name and address
  • MR — Mernis, registered
  • MS — Mernis, stated

Not set is --.

cardDeliveryBranchCode
​integer · int32 · optional

The branch the card is delivered to.

enrollMasterpass
​boolean · optional

Whether to enrol the new card with Masterpass. Forwarded to the issuing service, which does the enrolment; the card is created either way.

​object · optional

What the card may do: e-commerce, international purchases and mail order. Each is optional, and one left unset takes the platform's own default rather than being refused — for e-commerce that default follows digitalCardFlag.

contractType
​string · maxLength: 20 · optional

Which cardholder contract the customer accepted. The pair with contractVersionNumber records what was agreed to and when.

contractVersionNumber
​string · maxLength: 20 · optional

Which version of that contract the customer accepted.

nameOnCard
​string · maxLength: 26 · optional

The name embossed on the card. The services truncate to 26 characters before writing rather than refusing a longer one, so a name that matters should be checked at 26.

cardSendAddressId
​integer · int64 · optional

A stored address to send the card to. The facade turns it into a single card-address entry of the send type; omitted, no address list is sent at all and the delivery fields alone decide.

applicationDate
​string · optional

A date and time as a string, in RFC 3339 form: 2026-10-16T14:30:00Z, or with an offset, 2026-10-16T17:30:00+03:00.

Example: 2026-10-16T14:30:00Z
applicationContractId
​string · maxLength: 20 · optional

The contract record in the application system that this card comes from.

createIndividualCard › Responses

Issued. The response carries the new card's references — shadowCardNumber, cardRefNumber, mainCardRefNumber, the masked number and the record id — and a warnings list.

Read warnings. It comes from the issuing service and is returned on a successful call, so a card can be created with something worth knowing attached to it. An empty list is the untroubled case.

A prepaid card is issued with no limit: what it can spend is a loaded balance held on a wallet, and loading that balance has no published operation on this portal.

CreateIndividualCardResponse
recordId
​integer · int64 · required

The identifier of the row the operation created or acted on, returned so a later call can name it.

maskedCardNumber
​string · optional

The card number with its middle digits masked, as the platform stores it. It is a display form, not a key.

shadowCardNumber
​string · optional

The platform's own handle for a card, and the identifier most operations take. It is returned by every operation that creates a card and by the card listings; a caller does not compose one.

cardRefNumber
​string · optional

The card reference, which identifies one issued card including its renewals. Returned by the create and listing operations alongside the shadow number.

mainCardRefNumber
​string · optional

The card reference of the main card. On a supplementary card this is the card it hangs from; on a main card it is the card's own reference.

​object · optional

What the operation wants to say about work it did anyway. A warning does not mean the operation failed.

​object · optional

The card number, expiry and verification value, returned only where the operation and the channel are entitled to them.

applicationId
​integer · int64 · optional

The card application this request belongs to. Returned when an application is created, and carried through the card that comes out of it.

POST/IntegrationDigitalChannelPrepaid/prepaid/api/createIndividualCard
curl https://sandboxpub.cms.dgpays.com/SandBox/IntegrationDigitalChannelPrepaid/prepaid/api/createIndividualCard \ --request POST \ --header 'Content-Type: application/json' \ --header 'evrst-ptrnid: x_request_id' \ --header 'Authorization: Bearer <access_token>' \ --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", "nameOnCard": "nameOnCard", "cardSendAddressId": 0, "applicationDate": "2026-10-16T14:30: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", "nameOnCard": "nameOnCard", "cardSendAddressId": 0, "applicationDate": "2026-10-16T14:30: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://sandboxpub.cms.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
channel
​string · maxLength: 3 · required

Three-digit code identifying the channel on behalf of which the request is made (e.g. 002 for Internet). Mandatory in every request. Used for entitlement checks, limit enforcement and audit logging. Channel codes are managed through configuration parameters and may change over time. Refer to the Channels page for the current list of valid codes.

customerNumber
​integer · int64 · required

The customer at the bank's core banking system, as a number. The platform stores it rather than issuing it, so it comes from the core.

mainCustomerNumber
​integer · int64 · optional

The main customer of a corporate relationship, as a number. The employees and supplementary holders under it carry their own customerNumber.

​object · optional

Which rows to return. Left out, the operation returns them all.

getApplicableProductsByCustomerNumber › Responses

Success

GetApplicableProductsByCustomerNumberResponse
​array · optional

The products the search matched.

POST/IntegrationDigitalChannelPrepaid/prepaid/api/getApplicableProductsByCustomerNumber
curl https://sandboxpub.cms.dgpays.com/SandBox/IntegrationDigitalChannelPrepaid/prepaid/api/getApplicableProductsByCustomerNumber \ --request POST \ --header 'Content-Type: application/json' \ --header 'evrst-ptrnid: x_request_id' \ --header 'Authorization: Bearer <access_token>' \ --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 applicationsCard lifecycle