Everest Card — API reference
  • Credit
  • Debit
  • Prepaid
  • Common Methods
  • OAuth2
  • Delivery
Information
Cards
    Card applications
      getCardApplicationListpostgetDebitApplicationIdByFromShadowCardNumberpostsubmitCardApplicationExtStatuspost
    Card issuance and personalisation
      getApplicableProductsByCustomerNumberpostcreateIndividualCardpostcreateIndividualSupplementaryCardpostcreateCorporateCardpostcreateDummyCorporateCardpostcreateVirtualCardpostgetPendingCardEmbossListpostcancelCardEmbossByShadowCardNumberpost
    Card lifecycle
      getCustomerDebitCardListByTenantIdpostgetCustomerDebitShadowCardsByTenantIdpostchangeCardStatuspostgetCardListpostgetCardListNewpostgetCardInfopostreplaceCardpostchangeAndReplaceCardpostisCardFoundInpostaddDebitCardLogpost
    No-name cards
      createNoNameCardApplicationpostcancelNoNameCardApplicationpostupdateNoNameCardApplicationpostactivateNoNameCardpostcreateCardUsingNoNameApplicationpostcreateAndProcessNoNameCardApplicationpostreplaceNoNameCardpostreplaceCardUsingNoNameApplicationpostchangeAndReplaceNoNameCardpost
Customers and accounts
    Branch management
      changeCardBranchpostchangeCustomerBranchposttransferBranchCustomerpostgetDebitCustomerLisfOfBranchpost
    Customers
      getCorporateCustomerInfoByIndividualCustomerpostgetCustomerAssetpostisCustomerConvertToRipperpostgetCustomerAssetsSummaryDebitpost
    Account linking
      attachCardAccountpostdetachCardAccountpostdetachCardAccountByAccountNumberpostmodifyCardAccountpostlistCardAccountByAccountNumberpostlistCardAccountByShadowCardNumberpostrecreateCustomerCardAccountspostsaveCardAccountCurrencyConversionpostgetCardAccountCurrencyConversionpost
Transactions
    getDebitCardTransactionByUtidpostgetDebitCardTransactionByUtidNewpostgetDebitTransactionAllpostupdateTransactionForBNPLpostgetDigitalSlipReceiptpostgetAuthorizationListByBegindateEnddatepostgetDbttransactionByCardrefCustomernumpost
Limits and controls
    Card and customer limits
      getAvailableECommerceLimitpost
    Operation limits
      getCardLimitationParameterDatapostgetCardOperationLimitpostsetCardOperationLimitpostremoveCardOperationLimitpostgetCustomerOperationLimitpostsetCustomerOperationLimitpostremoveCustomerOperationLimitpostgetCustomerLimitationParameterDatapost
    Permissions and restrictions
      getCardPermissionspostsaveCardPermissionspostsaveCardBnplPermissionpostchangeCardMiscOptionpostgetCardMiscOptionpost
Security
    PIN and card security
      setCardPinpostchangeCardPinpostverifyCardPinpostverifyRsaPinpostsetRsaPinpostchangeRsaPinpostincreasePinTryCountpostverifyRsaPinWithStaticSaltpostverifyCVVpostverifyCVVPartialpostgenerateCVVpostgetCardPinOperationHistorypostresetCvvCounterpost
Disputes
    Disputes and chargebacks
      createDisputeCasepostgetDisputeListpostaddDocumentByCaseNumberpostcancelDisputeCasepost
Platform
    Platform operations
      healthCheckpostrefreshCachepost
    Reference data
      getCardTypeByBinpost
SchemasError codesChannels
powered by Zudoku
Debit Digital Channels Integration
Debit 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.


getApplicableProductsByCustomerNumber

POST
https://sandboxpub.cms.dgpays.com/SandBox
/IntegrationDigitalChannelDebit/debit/api/getApplicableProductsByCustomerNumber

Retrieves the list of card products applicable to a specific customer. Filters by main customer number and optional product group. Returns product details including name, number, brand, short name, digital capability, and tenant ID.

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 · min: 1 · required

Customer whose applicable products are read. Three separate refusals — absent, zero and negative each raise their own code.

mainCustomerNumber
​integer · int64 · min: 1 · optional

Main customer to read against. Not required, but when supplied it may be neither zero nor negative.

​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/IntegrationDigitalChannelDebit/debit/api/getApplicableProductsByCustomerNumber
curl https://sandboxpub.cms.dgpays.com/SandBox/IntegrationDigitalChannelDebit/debit/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" } ] }
json
application/json

createIndividualCard

POST
https://sandboxpub.cms.dgpays.com/SandBox
/IntegrationDigitalChannelDebit/debit/api/createIndividualCard

Creates an individual debit card for a customer, handling product selection, accounts, permissions, digital card flags, addresses, and miscellaneous options. Returns card references, masked and shadow card numbers, warnings, application ID if created asynchronously, and attached account list.

Part of:

  • Journey 01 · Launching a new card product — step 2, Issue against accounts

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 · required

The product the card is issued on. Must be a product the platform defines.

customerNumber
​integer · int64 · required

The customer the card is issued to.

branchCode
​integer · int32 · required

The branch the card is issued from. Must be a defined branch.

​CreateIndividualCardAccount[] · required

ListHasNoItem — The accounts the card draws on. Must be sent and must hold at least one entry.

digitalCardFlag
​boolean · optional

Whether to issue the card as a digital one. It also decides the default e-commerce permission where permissions leaves that unset.

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.

cardDeliveryType
​string · enum · maxLength: 1 · optional

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

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

Conditional · NotNull — The branch the card is delivered to. Mandatory when cardDeliveryType is Branch, and it must be a defined branch.

cardSendAddressId
​integer · int64 · optional

Which of the customer's addresses to send the card to. The identifier of an address already held for that customer, not an address.

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

​object · optional

A miscellaneous option to set on the card, as a type-and-value pair. Only one may be sent at creation; changeCardMiscOption sets more.

Leaving it out does not leave the option unset. No row is written, but getCardMiscOption answers for a card that has none by returning the first value configured for that option type — so the card behaves as if it had been given that value. Which value that is comes from the option-type definition rather than from this API.

Replacing a card carries the option across. Where the replaced card had none, the platform writes DS / HardCopy onto the new one.

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.

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.

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.

createIndividualCard › Responses

Success

CreateIndividualResponse
recordId
​integer · int64 · optional

The identifier of the row the operation created or acted on. Returned rather than sent in most operations that carry 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: operations take the shadow number.

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.

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.

​array · optional
POST/IntegrationDigitalChannelDebit/debit/api/createIndividualCard
curl https://sandboxpub.cms.dgpays.com/SandBox/IntegrationDigitalChannelDebit/debit/api/createIndividualCard \ --request POST \ --header 'Content-Type: application/json' \ --header 'evrst-ptrnid: x_request_id' \ --header 'Authorization: Bearer <access_token>' \ --data '{ "channel": "005", "productNumber": "50002", "digitalCardFlag": true, "customerNumber": 73141, "branchCode": 100, "cardDeliveryType": "S", "cardDeliveryBranchCode": 100, "enrollMasterpass": false, "permissions": { "eCommercePermitted": true, "mailOrderPermitted": false }, "listOfAccount": [ { "fecCode": 0, "accountBranchId": 100, "accountType": "A", "accountSuffix": 1, "accountNumber": 589123, "accountAlias": "test", "currencyCode": "949", "iban": "TR330006100519786457841326" } ], "applicationDate": "2026-09-14T12:18:21.444Z", "nameOnCard": "test debit card" }'
Example Request Body
{ "channel": "005", "productNumber": "50002", "digitalCardFlag": true, "customerNumber": 73141, "branchCode": 100, "cardDeliveryType": "S", "cardDeliveryBranchCode": 100, "enrollMasterpass": false, "permissions": { "eCommercePermitted": true, "mailOrderPermitted": false }, "listOfAccount": [ { "fecCode": 0, "accountBranchId": 100, "accountType": "A", "accountSuffix": 1, "accountNumber": 589123, "accountAlias": "test", "currencyCode": "949", "iban": "TR330006100519786457841326" } ], "applicationDate": "2026-09-14T12:18:21.444Z", "nameOnCard": "test debit card" }
json
application/json
Example Responses
{ "recordId": 0, "maskedCardNumber": "maskedCardNumber", "shadowCardNumber": "shadowCardNumber", "cardRefNumber": "cardRefNumber", "mainCardRefNumber": "mainCardRefNumber", "warnings": { "key": "string" }, "applicationId": 0, "attachAccountList": [ { "accountNumber": 0, "accountRecordId": 0 } ] }
json
application/json

createIndividualSupplementaryCard

POST
https://sandboxpub.cms.dgpays.com/SandBox
/IntegrationDigitalChannelDebit/debit/api/createIndividualSupplementaryCard

Create Individual Supplementary Card

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
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 · required

Product the card is issued on. Rejected when absent and when it matches no card product. It must then be on the platform's applicable-product list, and that entry must name the channel this request is made from — the channel is refused against applicableProduct.ListOfApplicableChannel rather than against this field. Its segment must be Individual: a corporate product is refused here.

customerNumber
​integer · int64 · min: 1 · required

Customer the card belongs to. Three separate refusals — absent, zero and negative each raise their own code — and the customer must then exist, be active, and be within the product's age range.

shadowCardNumber
​string · maxLength: 19 · required

The main card's shadow number. Its master must carry a main customer and that customer must be active.

branchCode
​integer · int32 · required

Branch the application is made at. Rejected when absent and again when it matches no branch.

​CreateIndividualCardAccount[] · required

ListHasNoItem — The accounts the card draws on. A debit card is issued against accounts, so an absent or empty list is refused — this is the check credit's equivalent operation does not have.

digitalCardFlag
​boolean · optional

Ask for the card to be issued as digital. Refused when the product has no digital card ability.

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.

cardDeliveryType
​string · enum · maxLength: 1 · optional

Values:

  • P — by post
  • S — to the branch

Not set is "".

cardSendAddressType
​string · enum · maxLength: 2 · optional

Which address the card is sent to. Only checked when supplied, and then it may not resolve to None.

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

Conditional · NotNull — Branch the card is delivered to. Required when cardDeliveryType is the branch delivery type, and ignored otherwise.

cardSendAddressId
​integer · int64 · optional

Which of the customer's addresses to send the card to. The identifier of an address already held for that customer, not an address.

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

​object · optional

A miscellaneous option to set on the card, as a type-and-value pair. Only one may be sent at creation; changeCardMiscOption sets more.

Leaving it out does not leave the option unset. No row is written, but getCardMiscOption answers for a card that has none by returning the first value configured for that option type — so the card behaves as if it had been given that value. Which value that is comes from the option-type definition rather than from this API.

Replacing a card carries the option across. Where the replaced card had none, the platform writes DS / HardCopy onto the new one.

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.

applicationDate
​string · optional

Application Date

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.

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.

createIndividualSupplementaryCard › Responses

Success

CreateIndividualSupplementaryCardResponse
recordId
​integer · int64 · optional

The identifier of the row the operation created or acted on. Returned rather than sent in most operations that carry 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: operations take the shadow number.

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.

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.

​array · optional
POST/IntegrationDigitalChannelDebit/debit/api/createIndividualSupplementaryCard
curl https://sandboxpub.cms.dgpays.com/SandBox/IntegrationDigitalChannelDebit/debit/api/createIndividualSupplementaryCard \ --request POST \ --header 'Content-Type: application/json' \ --header 'evrst-ptrnid: x_request_id' \ --header 'Authorization: Bearer <access_token>' \ --data '{ "channel": "channel", "productNumber": "productNumber", "digitalCardFlag": true, "customerNumber": 0, "shadowCardNumber": "shadowCardNumber", "nameOnCard": "nameOnCard", "branchCode": 0, "cardDeliveryType": "cardDeliveryType", "cardSendAddressType": "cardSendAddressType", "cardDeliveryBranchCode": 0, "cardSendAddressId": 0, "listOfAccount": [ { "accountType": "accountType", "accountNumber": 0, "accountOrderFlag": true, "currencyCode": "currencyCode", "fxAutoConversionFlag": true } ], "permissions": { "eCommercePermitted": true, "mailOrderPermitted": true }, "cardMiscOption": { "optionType": "optionType", "optionValue": "optionValue" }, "enrollMasterpass": true, "applicationDate": "2026-10-16T14:30:00Z", "applicationContractId": "applicationContractId", "contractType": "contractType", "contractVersionNumber": "contractVersionNumber" }'
Example Request Body
{ "channel": "channel", "productNumber": "productNumber", "digitalCardFlag": true, "customerNumber": 0, "shadowCardNumber": "shadowCardNumber", "nameOnCard": "nameOnCard", "branchCode": 0, "cardDeliveryType": "cardDeliveryType", "cardSendAddressType": "cardSendAddressType", "cardDeliveryBranchCode": 0, "cardSendAddressId": 0, "listOfAccount": [ { "accountType": "accountType", "accountNumber": 0, "accountOrderFlag": true, "currencyCode": "currencyCode", "fxAutoConversionFlag": true } ], "permissions": { "eCommercePermitted": true, "mailOrderPermitted": true }, "cardMiscOption": { "optionType": "optionType", "optionValue": "optionValue" }, "enrollMasterpass": true, "applicationDate": "2026-10-16T14:30:00Z", "applicationContractId": "applicationContractId", "contractType": "contractType", "contractVersionNumber": "contractVersionNumber" }
json
application/json
Example Responses
{ "recordId": 0, "maskedCardNumber": "maskedCardNumber", "shadowCardNumber": "shadowCardNumber", "cardRefNumber": "cardRefNumber", "mainCardRefNumber": "mainCardRefNumber", "warnings": { "key": "string" }, "applicationId": 0, "attachAccountList": [ { "accountNumber": 0, "accountRecordId": 0 } ] }
json
application/json

createCorporateCard

POST
https://sandboxpub.cms.dgpays.com/SandBox
/IntegrationDigitalChannelDebit/debit/api/createCorporateCard

Creates a corporate debit card for a customer, handling product selection, accounts, delivery options, permissions, and digital card flags. Returns card references, masked and shadow card numbers, warnings, and application ID if created asynchronously.

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
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 · required

Product the corporate card is issued on. Rejected when absent and when it matches no card product. Its segment must then be Corporate: an individual product is refused here. It must then be on the platform's applicable-product list, and that entry must name the channel this request is made from — the channel is refused against applicableProduct.ListOfApplicableChannel rather than against this field. A product that issues virtual cards is refused outright — this operation does not create them.

customerNumber
​integer · int64 · min: 1 · required

Customer the card belongs to. Three separate refusals — absent, zero and negative each raise their own code — and the customer must then exist, be active, and be within the product's age range.

shadowCardNumber
​string · maxLength: 19 · required

The main card's shadow number.

digitalCardFlag
​boolean · optional

Ask for the card to be issued as digital. Refused when the product has no digital card ability.

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.

secondNameOnCard
​string · maxLength: 26 · optional

The second embossed line, used for the company name on a corporate card.

branchCode
​integer · int32 · optional

Required in practice · NotNull — Branch the application is made at. Unlike the sibling create operations this one does not demand it up front — it is checked by lookup, so an absent value is refused as a branch that was not found.

cardDeliveryType
​string · enum · maxLength: 1 · optional

Values:

  • P — by post
  • S — to the branch

Not set is "".

cardSendAddressType
​string · enum · maxLength: 2 · optional

Which address the card is sent to. Only checked when supplied, and then it may not resolve to None.

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

cardSendAddressId
​integer · int64 · optional

Which of the customer's addresses to send the card to. The identifier of an address already held for that customer, not an address.

cardDeliveryBranchCode
​integer · int32 · optional

Conditional · NotNull — Branch the card is delivered to. Required when cardDeliveryType is the branch delivery type, and ignored otherwise.

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

​array · optional

The accounts to attach to the card as it is created. Each entry carries the account's own identifiers; attaching one later is attachCardAccount.

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.

createCorporateCard › Responses

Success

CreateCorporateCardResponse
recordId
​integer · int64 · optional

The identifier of the row the operation created or acted on. Returned rather than sent in most operations that carry 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: operations take the shadow number.

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.

mainShadowCardNumber
​string · optional
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.

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/IntegrationDigitalChannelDebit/debit/api/createCorporateCard
curl https://sandboxpub.cms.dgpays.com/SandBox/IntegrationDigitalChannelDebit/debit/api/createCorporateCard \ --request POST \ --header 'Content-Type: application/json' \ --header 'evrst-ptrnid: x_request_id' \ --header 'Authorization: Bearer <access_token>' \ --data '{ "channel": "channel", "productNumber": "productNumber", "digitalCardFlag": true, "customerNumber": 0, "shadowCardNumber": "shadowCardNumber", "nameOnCard": "nameOnCard", "secondNameOnCard": "secondNameOnCard", "branchCode": 0, "cardDeliveryType": "cardDeliveryType", "cardSendAddressType": "cardSendAddressType", "cardSendAddressId": 0, "cardDeliveryBranchCode": 0, "permissions": { "eCommercePermitted": true }, "listOfAccount": [ { "accountType": "accountType", "accountNumber": 0, "accountOrderFlag": true, "currencyCode": "currencyCode", "fxAutoConversionFlag": true } ], "applicationDate": "2026-10-16T14:30:00Z", "applicationContractId": "applicationContractId" }'
Example Request Body
{ "channel": "channel", "productNumber": "productNumber", "digitalCardFlag": true, "customerNumber": 0, "shadowCardNumber": "shadowCardNumber", "nameOnCard": "nameOnCard", "secondNameOnCard": "secondNameOnCard", "branchCode": 0, "cardDeliveryType": "cardDeliveryType", "cardSendAddressType": "cardSendAddressType", "cardSendAddressId": 0, "cardDeliveryBranchCode": 0, "permissions": { "eCommercePermitted": true }, "listOfAccount": [ { "accountType": "accountType", "accountNumber": 0, "accountOrderFlag": true, "currencyCode": "currencyCode", "fxAutoConversionFlag": true } ], "applicationDate": "2026-10-16T14:30:00Z", "applicationContractId": "applicationContractId" }
json
application/json
Example Responses
{ "recordId": 0, "maskedCardNumber": "maskedCardNumber", "shadowCardNumber": "shadowCardNumber", "mainShadowCardNumber": "mainShadowCardNumber", "cardRefNumber": "cardRefNumber", "mainCardRefNumber": "mainCardRefNumber", "warnings": { "key": "string" }, "applicationId": 0 }
json
application/json

createDummyCorporateCard

POST
https://sandboxpub.cms.dgpays.com/SandBox
/IntegrationDigitalChannelDebit/debit/api/createDummyCorporateCard

Create Dummy Corporate Card

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
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 · min: 1 · required

Customer the card belongs to. Three separate refusals — absent, zero and negative each raise their own code — and the customer must then exist, be active, and be within the product's age range.

productNumber
​string · maxLength: 5 · required

Product the card is issued on. Rejected when absent and when it matches no card product. It must then be on the platform's applicable-product list, and that entry must name the channel this request is made from — the channel is refused against applicableProduct.ListOfApplicableChannel rather than against this field. Its segment must be Corporate: an individual product is refused here.

branchCode
​integer · int32 · required

Branch the application is made at.

digitalCardFlag
​boolean · optional

Ask for the card to be issued as digital. Refused when the product has no digital card ability.

cardDeliveryType
​string · enum · maxLength: 1 · optional

Values:

  • P — by post
  • S — to the branch

Not set is "".

cardSendAddressType
​string · enum · maxLength: 2 · optional

Which address the card is sent to. Only checked when supplied, and then it may not resolve to None.

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

Conditional · NotNull — Branch the card is delivered to. Required when cardDeliveryType is supplied and is the branch delivery type — this operation checks for an empty delivery type first, which its siblings do not.

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.

applicationDate
​string · optional

Application Date

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

createDummyCorporateCard › Responses

Success

CreateDummyCorporateCardResponse
cardMasterRecordId
​integer · int64 · required
secureCardMasterRecordId
​integer · int64 · required
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.

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.

POST/IntegrationDigitalChannelDebit/debit/api/createDummyCorporateCard
curl https://sandboxpub.cms.dgpays.com/SandBox/IntegrationDigitalChannelDebit/debit/api/createDummyCorporateCard \ --request POST \ --header 'Content-Type: application/json' \ --header 'evrst-ptrnid: x_request_id' \ --header 'Authorization: Bearer <access_token>' \ --data '{ "channel": "channel", "customerNumber": 0, "productNumber": "productNumber", "digitalCardFlag": true, "cardDeliveryType": "cardDeliveryType", "cardSendAddressType": "cardSendAddressType", "cardDeliveryBranchCode": 0, "branchCode": 0, "nameOnCard": "nameOnCard", "applicationDate": "2026-10-16T14:30:00Z" }'
Example Request Body
{ "channel": "channel", "customerNumber": 0, "productNumber": "productNumber", "digitalCardFlag": true, "cardDeliveryType": "cardDeliveryType", "cardSendAddressType": "cardSendAddressType", "cardDeliveryBranchCode": 0, "branchCode": 0, "nameOnCard": "nameOnCard", "applicationDate": "2026-10-16T14:30:00Z" }
json
application/json
Example Responses
{ "cardRefNumber": "cardRefNumber", "mainCardRefNumber": "mainCardRefNumber", "shadowCardNumber": "shadowCardNumber", "cardMasterRecordId": 0, "secureCardMasterRecordId": 0 }
json
application/json

createVirtualCard

POST
https://sandboxpub.cms.dgpays.com/SandBox
/IntegrationDigitalChannelDebit/debit/api/createVirtualCard

Creates a virtual debit card linked to an existing shadow card, handling accounts and Masterpass enrollment. Returns card references, masked and shadow card numbers, attached accounts, warnings, and sensitive card data including PAN, CVV, and expiry date.

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

shadowCardNumber
​string · maxLength: 19 · required

The related card's shadow number — the card the virtual card draws on. Its status must allow one, and the customer may hold only one virtual card per related card.

​CreateIndividualCardAccount[] · required

ListHasNoItem — The accounts the card draws on. A debit card is issued against accounts, so an absent or empty list is refused — this is the check credit's equivalent operation does not have.

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.

createVirtualCard › Responses

Success

CreateVirtualCardResponse
recordId
​integer · int64 · required

The identifier of the row the operation created or acted on. Returned rather than sent in most operations that carry 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: operations take the shadow number.

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.

relatedCardRefNumber
​string · optional

The card this one is related to, where it is.

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

​array · optional
POST/IntegrationDigitalChannelDebit/debit/api/createVirtualCard
curl https://sandboxpub.cms.dgpays.com/SandBox/IntegrationDigitalChannelDebit/debit/api/createVirtualCard \ --request POST \ --header 'Content-Type: application/json' \ --header 'evrst-ptrnid: x_request_id' \ --header 'Authorization: Bearer <access_token>' \ --data '{ "channel": "channel", "shadowCardNumber": "shadowCardNumber", "enrollMasterpass": true, "listOfAccount": [ { "accountType": "accountType", "accountNumber": 0, "accountOrderFlag": true, "currencyCode": "currencyCode", "fxAutoConversionFlag": true } ] }'
Example Request Body
{ "channel": "channel", "shadowCardNumber": "shadowCardNumber", "enrollMasterpass": true, "listOfAccount": [ { "accountType": "accountType", "accountNumber": 0, "accountOrderFlag": true, "currencyCode": "currencyCode", "fxAutoConversionFlag": true } ] }
json
application/json
Example Responses
{ "recordId": 0, "maskedCardNumber": "maskedCardNumber", "shadowCardNumber": "shadowCardNumber", "cardRefNumber": "cardRefNumber", "mainCardRefNumber": "mainCardRefNumber", "relatedCardRefNumber": "relatedCardRefNumber", "warnings": { "key": "string" }, "sensitiveCardData": { "pan": "pan", "expiryDateStr": "expiryDateStr", "cvv": "cvv" }, "attachAccountList": [ { "accountNumber": 0, "accountRecordId": 0 } ] }
json
application/json

getPendingCardEmbossList

POST
https://sandboxpub.cms.dgpays.com/SandBox
/IntegrationDigitalChannelDebit/debit/api/getPendingCardEmbossList

Retrieves pending embossing information for a debit card using its shadow card number. Returns details including card sequence, emboss and application dates, reason codes and descriptions, emboss status, product type, masked card number, shadow card number, and validity flag.

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 · maxLength: 19 · required

The card whose pending emboss records are listed. The only field the request carries, and the only thing checked.

getPendingCardEmbossList › Responses

Success

GetPendingCardEmbossListResponse
cardSeqNumber
​integer · int32 · optional

Which chip on the card was used, where a customer holds more than one card on the same number.

embossDate
​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
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
embossReasonCode
​string · optional

Values:

  • N — new card
  • Y — renewal
embossReasonDescription
​string · optional

The description of embossReasonCode, carried alongside it for display. It is not a key: match on the code.

embossReasonSubCode
​string · optional

Values:

  • BRK — broken card
  • CHF — damaged chip
  • EXP — renewal at maturity
  • FRD — fraud
  • MGF — magnetic stripe error
  • NSU — name update
  • OTH — other
  • EXO — bulk renewal at maturity
  • LST — lost card
  • STL — stolen card

Not set is ---.

embossReasonSubDesc
​string · optional

The description of embossReasonSubCode, carried alongside it for display. It is not a key: match on the code.

embossStatus
​string · enum · optional

Values:

  • W — waiting
  • P — processing
  • C — emboss file created
  • E — embossed
  • T — PIN printed
  • D — delivered
  • R — emboss file removed
  • F — emboss faulty
  • N — emboss not completed
  • X — error

Not set is "".

maskedCardNumber
​string · optional

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

productTypeCode
​string · enum · optional

Values:

  • C — credit
  • D — debit
  • P — prepaid
productTypeDescription
​string · optional

The description of productTypeCode, carried alongside it for display. It is not a key: match on the code.

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.

validFlag
​boolean · optional

Whether the row is live. The platform sets it; a value sent here is replaced.

POST/IntegrationDigitalChannelDebit/debit/api/getPendingCardEmbossList
curl https://sandboxpub.cms.dgpays.com/SandBox/IntegrationDigitalChannelDebit/debit/api/getPendingCardEmbossList \ --request POST \ --header 'Content-Type: application/json' \ --header 'evrst-ptrnid: x_request_id' \ --header 'Authorization: Bearer <access_token>' \ --data '{ "shadowCardNumber": "shadowCardNumber" }'
Example Request Body
{ "shadowCardNumber": "shadowCardNumber" }
json
application/json
Example Responses
{ "cardSeqNumber": 0, "embossDate": "2026-10-16T14:30:00Z", "applicationDate": "2026-10-16T14:30:00Z", "embossReasonCode": "embossReasonCode", "embossReasonDescription": "embossReasonDescription", "embossReasonSubCode": "embossReasonSubCode", "embossReasonSubDesc": "embossReasonSubDesc", "embossStatus": "embossStatus", "maskedCardNumber": "maskedCardNumber", "productTypeCode": "productTypeCode", "productTypeDescription": "productTypeDescription", "shadowCardNumber": "shadowCardNumber", "validFlag": true }
json
application/json

cancelCardEmbossByShadowCardNumber

POST
https://sandboxpub.cms.dgpays.com/SandBox
/IntegrationDigitalChannelDebit/debit/api/cancelCardEmbossByShadowCardNumber

Cancels the embossing of a debit card using the shadow card number and channel. Logs the operation and validates the request before processing.

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

shadowCardNumber
​string · maxLength: 19 · required

Shadow card number of the card whose pending emboss request is cancelled.

cancelCardEmbossByShadowCardNumber › Responses

Success

No data returned
POST/IntegrationDigitalChannelDebit/debit/api/cancelCardEmbossByShadowCardNumber
curl https://sandboxpub.cms.dgpays.com/SandBox/IntegrationDigitalChannelDebit/debit/api/cancelCardEmbossByShadowCardNumber \ --request POST \ --header 'Content-Type: application/json' \ --header 'evrst-ptrnid: x_request_id' \ --header 'Authorization: Bearer <access_token>' \ --data '{ "channel": "channel", "shadowCardNumber": "shadowCardNumber" }'
Example Request Body
{ "channel": "channel", "shadowCardNumber": "shadowCardNumber" }
json
application/json
Example Responses
No example specified for this content type

Card applicationsCard lifecycle