Everest Card — API reference
  • Credit
  • Debit
  • Prepaid
  • Common Methods
  • OAuth2
  • Delivery
Information
Cards
    Card applications
      getCreditApplicationIdByFromShadowCardNumberpostsubmitCardApplicationExtStatuspost
    Card issuance and personalisation
      createIndividualCardpostcreateIndividualSupplementaryCardpostcreateDummyCorporateCardpostcreateCorporateCardpostcreateVirtualCardpostgetApplicableProductsByCustomerNumberpostgetApplicableProductsByMainCustomerPreControlpostcreateNoNameCardpostcancelCardEmbossByShadowCardNumberpostgetPendingCardEmbossListpost
    Card lifecycle
      getCardListpostreplaceCardpostgetCardMemopostchangeCardStatuspostchangeCustomerCreditCardStatuspostchangeAndReplaceCardpostgetRenewCountByShadowCardNumberpostgetCreditCardInfopostgetCustomerCreditCardListByTenantIdpostgetCustomerCreditShadowCardsByTenantIdpostgetCustomerCreditCardListByTenantIdProductNumberpostgetCardListNewpost
    No-name cards
      activateNoNameCardpostreplaceNoNameCardpostreplaceCardUsingNoNameApplicationpostchangeAndReplaceNoNameCardpostcancelNoNameCardApplicationpost
Customers and accounts
    Branch management
      changeCardBranchpostchangeCustomerBranchposttransferBranchCustomerpostgetCreditCustomerListOfBranchpost
    Customers
      getCorporateCustomerInfoByIndividualCustomerpostgetCustomerAssetsSummaryCreditpost
    Account linking
      attachCardAccountpostdetachCardAccountpostdetachCardAccountByAccountNumberpostlistCardAccountByAccountNumberpostlistCardAccountByShadowCardNumberpostrecreateCustomerCardAccountpost
Transactions
    doPaymentTransactionpostreversePaymentTransactionpostdoPaymentFeeInquirypostgetCustomerTransactionDetailpostgetCardIntermTransactionInfopostgetPendingProvisionListpostgetCreditCardTransactionAllpostgetCreditCardCurrentTransactionListpostgetTransactionAllpostgetPendingProvisionListNewpostgetDigitalSlipReceiptpost
    Cash advance
      getCashAdvanceInfopostdoCashAdvancepostreverseCashAdvancepostgetCancelableCashAdvanceListpost
Limits and controls
    Card and customer limits
      changeCardLimitDecreasepostchangeCardLimitIncreasepostchangeCardLimitReversepostresetCardLimitpostchangeCardAutoLimitIncreasepostgetCustomerTotalLimitInfopostgetCreditCardLimitpostgetCardAvailableLimitpostgetCustomerAvailableLimitpostchangeCorporateCardLimitDecreasepostchangeCorporateCardLimitIncreasepostchangeIndividualCardLimitpostdecreaseCustomerLimitpostchangeVirtualCardLimitpost
    Operation limits
      getCardOperationLimitpostsetCardOperationLimitpostremoveCardOperationLimitpostgetCardLimitationParameterDatapostgetCustomerOperationLimitpostsetCustomerOperationLimitpostremoveCustomerOperationLimitpostgetCustomerLimitationParameterDatapost
    Permissions and restrictions
      getCardPermissionspostsaveCardPermissionspostchangeCardMiscOptionpostgetCardMiscOptionpost
Instalments
    getEarlyCloseCandidateListpostdoEarlyClosepostgetInstallmentCountsByUtidpostgetCashInstallmentParameterpostsimulateCashInstallmentForAllpostsimulateCashInstallmentpostdoCashInstallmentpostreverseCashInstallmentpostgetCancelableCashInstallmentListpostgetEarlyReleaseCashInstallmentspostgetEarlyReleaseCashInstallmentpostdoCashInstallmentEarlyReleasePaymentpostcancelCashInstallEarlyReleasePaymentpostgetAllWaitingInstallmentspostgetWaitingInstallmentDetailpostgetWaitingInstallmentSummarypostmanuelInstallmentOrderpostmanuelInstallmentOrderSimulatepostgetInstallmentCountsByUtidNewpostcancelInstallmentEarlyReleasepostgetManuelInstallmentCancelRecordsByCardRefNumberpostgetEarlyReleaseAvailableInstallmentsByCriteriaspostsimulateInstallmentEarlyReleasepostreleasePendingInstallmentpostcancelInstallmentTransactionOrderpost
Billing and statements
    Collections and legal follow-up
      getCardDelinquencyInfoByCustomerNumberpostgetCreditCardCollectionInfoByCardRefNumberpostgetCreditCardCollectionInfoByMainCustomerNumberpostgetCreditCardCollectionTransactionListByDatepostgetCreditCardPortfolioSummarypost
    Debt payment
      checkCreditCardForDebtPaymentpostdoCreditCardDebtPaymentpostcancelCreditCardDebtPaymentpostgetCancelableCreditCardDebtPaymentListpostsaveCreditCardAutoPaymentOrderpostgetCreditCardAutoPaymentOrderpost
    Statements and billing
      getCardStatementSummarypostgetCardStatementDetailpostgetCreditCardStatementSendPreferencepostgetCardStatementListpostgetCreditCardLastStatementpostgetCreditCardLastStatementNewpostgetCardStatementDetailSummarypostgetCardStatementDetailSummaryNewpostchangeCreditCardStatementPeriodpostgetStatementPeriodChangeCountpostgetCalculatedStatementPeriodpostgetStatementPeriodByProductNumberpostchangeCreditCardStatementSendPreferencepostgetCardStatementAddressInformationpostgetCardFinancialInfoByCardRefNumberpostgetStatementPeriodChangeInfopost
Security
    PIN and card security
      setCardPinpostchangeCardPinpostverifyCardPinpostverifyRsaPinpostverifyRsaPinWithStaticSaltpostsetRsaPinpostincreasePinTryCountpostchangeRsaPinpostverifyCardVerificationValuepostgenerateCardVVpostverifyPartialCardVerificationValuepostresetCvvCounterpost
Disputes
    Disputes and chargebacks
      createDisputeCasepostcancelDisputeCasepostaddDocumentByCaseNumberpostgetDisputeListpostgetDisputeReasonDefListpost
Rewards
    Campaigns and rewards
      getCreditCardDateRangeForRewardByCustomerNumberReqSourcepost
Platform
    Platform operations
      healthCheckpostrefreshCachepost
    Reference data
      getAvailableCardStatusListpost
SchemasError codesChannels
powered by Zudoku
Credit Digital Channels Integration
Credit 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
/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 · 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 defined, applicable, and have at least one applicable channel.

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.

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.

secondNameOnCard
​string · maxLength: 26 · optional

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

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.

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.

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

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

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.

statementPeriod
​string · maxLength: 6 · optional

Which statement period the card is billed on. The periods a product allows come from the reference data.

statementCurrencyCode
​string · maxLength: 3 · optional

The currency the statement is produced in.

statementSendingAddressType
​string · maxLength: 2 · optional

Which kind of address that is.

statementPostFlag
​boolean · optional

Whether the statement is posted on paper.

statementSmsSendFlag
​boolean · optional

Whether the statement is announced by SMS.

statementEmailSendFlag
​boolean · optional

Whether the statement is sent by e-mail.

statementSendAddressId
​integer · int64 · optional

Which of the customer's addresses the statement is posted to.

cardLimitValue
​number · double · optional

The spending limit to open the card with.

customerLimitValue
​number · double · optional

The limit for the customer behind the card, which the card's own limit draws against.

authorizationSmsSendFlag
​boolean · optional

Whether an SMS is sent for each authorisation on the card.

authorizationSmsSendMinimumAmount
​number · double · optional

The amount an authorisation has to reach before that SMS is sent.

autoInstallmentCount
​integer · int32 · optional

How many instalments a purchase is split into automatically, where the product allows it.

autoDeferringMonthCount
​integer · int32 · optional

How many months a purchase is deferred automatically, where the product allows it.

autoLimitIncreaseFlag
​boolean · optional

Whether the card takes part in automatic limit increases.

autoPaymentFlag
​boolean · optional

Whether the card's debt is paid automatically. The account it is paid from is autoPaymentAccount, which is only read when this is true.

​object · optional

The account automatic payment draws on. Read only when autoPaymentFlag is true; otherwise no payment order is created.

applicationId
​string · maxLength: 50 · optional

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

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

Success

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

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

POST/IntegrationDigitalChannelCredit/credit/api/createIndividualCard
curl https://sandboxpub.cms.dgpays.com/SandBox/IntegrationDigitalChannelCredit/credit/api/createIndividualCard \ --request POST \ --header 'Content-Type: application/json' \ --header 'evrst-ptrnid: x_request_id' \ --header 'Authorization: Bearer <access_token>' \ --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://sandboxpub.cms.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
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 supplementary 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, that entry must name at least one channel, and it must name the channel this request is made from — the last two are 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 supplementary card belongs to. Rejected when absent and rejected again when it is zero, which is a separate check and a separate code from the null one.

shadowCardNumber
​string · maxLength: 19 · required

The main card's shadow number, not the supplementary card's — the supplementary card does not exist yet. The card it names must be a card master, and that master must carry a main customer, a limit, a product and a financial record; each is a separate refusal.

branchCode
​integer · int32 · required

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

digitalCardFlag
​boolean · optional

Ask for the card to be issued as digital. Refused when the product has no digital card ability. A customer who has already reached the product's digital card allowance for the year is refused separately, as a business failure rather than on this field.

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.

cardDeliveryType
​string · enum · maxLength: 1 · optional

Conditional · NotNull — Where the card is delivered. Required when the product issues a physical card, and then it may not resolve to None. Not read for a card issued as digital only.

Values:

  • P — by post
  • S — to the branch

Not set is "".

cardSendAddressType
​string · enum · maxLength: 2 · optional

Which of the customer's addresses the card is sent to. Only checked when a value is 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 the branch it names must exist. 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.

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

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

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.

cardLimitValue
​number · double · optional

The spending limit to open the card with.

authorizationSmsSendFlag
​boolean · optional

Whether an SMS is sent for each authorisation on the card.

authorizationSmsSendMinimumAmount
​number · double · optional

The amount an authorisation has to reach before that SMS is sent.

autoInstallmentCount
​integer · int32 · optional

How many instalments a purchase is split into automatically, where the product allows it.

autoDeferringMonthCount
​integer · int32 · optional

How many months a purchase is deferred automatically, where the product allows it.

applicationId
​string · maxLength: 50 · optional

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

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.

createIndividualSupplementaryCard › Responses

Success

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

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

POST/IntegrationDigitalChannelCredit/credit/api/createIndividualSupplementaryCard
curl https://sandboxpub.cms.dgpays.com/SandBox/IntegrationDigitalChannelCredit/credit/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", "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, "applicationId": "applicationId", "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", "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, "applicationId": "applicationId", "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" } }
json
application/json

createDummyCorporateCard

POST
https://sandboxpub.cms.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
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 dummy 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 on this field, although the message that comes back reads Product Not Individual, which is the service's own copy of the individual operation's wording. Nothing here consults the applicable-product list.

customerNumber
​integer · int64 · min: 1 · required

Customer the card belongs to. Rejected when absent and again when zero.

branchCode
​integer · int32 · required

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

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.

statementPeriod
​string · maxLength: 6 · optional

Which statement period the card is billed on. The periods a product allows come from the reference data.

statementCurrencyCode
​string · maxLength: 3 · optional

The currency the statement is produced in.

statementPostFlag
​boolean · optional

Whether the statement is posted on paper.

statementSmsSendFlag
​boolean · optional

Whether the statement is announced by SMS.

statementEmailSendFlag
​boolean · optional

Whether the statement is sent by e-mail.

statementSendingAddressType
​string · maxLength: 2 · optional

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

statementSendAddressId
​integer · int64 · optional

Which of the customer's addresses the statement is posted to.

cardLimitValue
​number · double · optional

The spending limit to open the card with.

customerLimitValue
​number · double · optional

The limit for the customer behind the card, which the card's own limit draws against.

autoInstallmentCount
​integer · int32 · optional

How many instalments a purchase is split into automatically, where the product allows it.

autoDeferringMonthCount
​integer · int32 · optional

How many months a purchase is deferred automatically, where the product allows it.

autoLimitIncreaseFlag
​boolean · optional

Whether the card takes part in automatic limit increases.

autoPaymentFlag
​boolean · optional

Whether the card's debt is paid automatically. The account it is paid from is autoPaymentAccount, which is only read when this is true.

​object · optional

The account automatic payment draws on. Read only when autoPaymentFlag is true; otherwise no payment order is created.

applicationId
​string · maxLength: 50 · optional

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

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.

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.

​object · optional

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

POST/IntegrationDigitalChannelCredit/credit/api/createDummyCorporateCard
curl https://sandboxpub.cms.dgpays.com/SandBox/IntegrationDigitalChannelCredit/credit/api/createDummyCorporateCard \ --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, "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": "2026-10-16T14:30:00Z", "applicationContractId": "applicationContractId" }'
Example Request Body
{ "channel": "channel", "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": "2026-10-16T14:30: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://sandboxpub.cms.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
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 on this field, although the message that comes back reads Product Not Individual, which is the service's own copy of the individual operation's wording. A product that issues virtual cards is refused outright — this operation does not create them. Unlike the individual operations, nothing here consults the applicable-product list.

customerNumber
​integer · int64 · min: 1 · required

Customer the card belongs to. Rejected when absent, when zero, and when the number has no personal-information record.

shadowCardNumber
​string · maxLength: 19 · required

The main card's shadow number. Its master must carry a main customer, that customer's firm information, a limit and a financial record; each missing one is its own refusal.

branchCode
​integer · int32 · required

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

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.

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 the branch it names must then exist. Not read otherwise.

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.

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

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.

cardLimitValue
​number · double · optional

The spending limit to open the card with.

authorizationSmsSendFlag
​boolean · optional

Whether an SMS is sent for each authorisation on the card.

authorizationSmsSendMinimumAmount
​number · double · optional

The amount an authorisation has to reach before that SMS is sent.

applicationId
​string · maxLength: 50 · optional

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

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

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.

​object · optional

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

POST/IntegrationDigitalChannelCredit/credit/api/createCorporateCard
curl https://sandboxpub.cms.dgpays.com/SandBox/IntegrationDigitalChannelCredit/credit/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, "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, "applicationId": "applicationId", "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, "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, "applicationId": "applicationId", "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" }, "sensitiveCardData": { "pan": "pan", "expiryDateStr": "expiryDateStr", "cvv": "cvv" } }
json
application/json

createVirtualCard

POST
https://sandboxpub.cms.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 · 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 a virtual card, and it must carry a financial record and an available limit.

limitType
​string · enum · maxLength: 1 · required

How the virtual card's limit behaves. Rejected when blank, and rejected when it resolves to None — that second refusal carries the code InvalidLimitType, which the service builds by hand rather than taking from ValidationErrorCodes.

Values:

  • S — fixed — the limit stays as set
  • H — decreasing — each transaction reduces it

Not set is N.

endOfDayFlag
​boolean · optional

Conditional · NotNull — Whether the limit is released at end of day. Required when limitType is the fixed type, and checked in a second pass after the other fields have passed — so a request missing both this and limitType is refused for limitType first.

limit
​number · double · optional

Default — Defaults to 0. The virtual card's limit. It may not exceed the related card's available limit.

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.

relatedCardRefNumber
​string · optional

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

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.

POST/IntegrationDigitalChannelCredit/credit/api/createVirtualCard
curl https://sandboxpub.cms.dgpays.com/SandBox/IntegrationDigitalChannelCredit/credit/api/createVirtualCard \ --request POST \ --header 'Content-Type: application/json' \ --header 'evrst-ptrnid: x_request_id' \ --header 'Authorization: Bearer <access_token>' \ --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://sandboxpub.cms.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 3, 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 · 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.

shadowCardNumber
​string · maxLength: 19 · 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.

​object · optional

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

getApplicableProductsByCustomerNumber › Responses

Success

GetApplicableProductsByCustomerNumberResponse
​array · optional

The products the search matched.

​array · optional
POST/IntegrationDigitalChannelCredit/credit/api/getApplicableProductsByCustomerNumber
curl https://sandboxpub.cms.dgpays.com/SandBox/IntegrationDigitalChannelCredit/credit/api/getApplicableProductsByCustomerNumber \ --request POST \ --header 'Content-Type: application/json' \ --header 'evrst-ptrnid: x_request_id' \ --header 'Authorization: Bearer <access_token>' \ --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://sandboxpub.cms.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 · 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.

mainCustomerNumber
​integer · int64 · min: 1 · required

The main customer the control is run for. Refused when absent, and when supplied it may be neither zero nor negative. The control is about this customer alone — no card or product is named anywhere in the request.

​object · required

Mandatory here, unlike on getApplicableProductsByCustomerNumber where the same filter may be left out: the service refuses a request whose filter.productGroupCode is absent.

getApplicableProductsByMainCustomerPreControl › Responses

Success

GetApplicableProductsByMainCustomerResponse
isSuccess
​boolean · required

Whether the operation did what it was asked to. A false here arrives with HTTP 200, so it has to be read rather than inferred from the status.

POST/IntegrationDigitalChannelCredit/credit/api/getApplicableProductsByMainCustomerPreControl
curl https://sandboxpub.cms.dgpays.com/SandBox/IntegrationDigitalChannelCredit/credit/api/getApplicableProductsByMainCustomerPreControl \ --request POST \ --header 'Content-Type: application/json' \ --header 'evrst-ptrnid: x_request_id' \ --header 'Authorization: Bearer <access_token>' \ --data '{ "channel": "channel", "mainCustomerNumber": 0, "filter": { "productGroupCode": "productGroupCode" } }'
Example Request Body
{ "channel": "channel", "mainCustomerNumber": 0, "filter": { "productGroupCode": "productGroupCode" } }
json
application/json
Example Responses
{ "isSuccess": true }
json
application/json

createNoNameCard

POST
https://sandboxpub.cms.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
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 card product the card is issued on. Defined in the parameter tables; getCardProductList returns the ones a tenant may use.

barcode
​string · maxLength: 120 · optional

The delivery barcode the consignment is tracked by.

customerNumber
​integer · int64 · optional

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.

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

The branch the card is opened at, as a number. Held as a number rather than text throughout.

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

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.

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

contractType
​string · maxLength: 20 · optional

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

statementPeriod
​string · maxLength: 6 · optional

Which statement period the card is billed on. The periods a product allows come from the reference data.

statementCurrencyCode
​string · maxLength: 3 · optional

The currency the statement is produced in.

cardLimitValue
​number · double · optional

The spending limit to open the card with.

customerLimitValue
​number · double · optional

The limit for the customer behind the card, which the card's own limit draws against.

autoLimitIncreaseFlag
​boolean · optional

Whether the card takes part in automatic limit increases.

applicationId
​string · maxLength: 50 · optional

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

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.

createNoNameCard › Responses

Success

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

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

POST/IntegrationDigitalChannelCredit/credit/api/createNoNameCard
curl https://sandboxpub.cms.dgpays.com/SandBox/IntegrationDigitalChannelCredit/credit/api/createNoNameCard \ --request POST \ --header 'Content-Type: application/json' \ --header 'evrst-ptrnid: x_request_id' \ --header 'Authorization: Bearer <access_token>' \ --data '{ "channel": "channel", "barcode": "barcode", "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, "applicationId": "applicationId", "applicationDate": "2026-10-16T14:30:00Z", "applicationContractId": "applicationContractId" }'
Example Request Body
{ "channel": "channel", "barcode": "barcode", "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, "applicationId": "applicationId", "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" } }
json
application/json

cancelCardEmbossByShadowCardNumber

POST
https://sandboxpub.cms.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
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. Checked by the facade and checked again by the issuing service, with the same rule on both sides.

cancelCardEmbossByShadowCardNumber › Responses

Success

No data returned
POST/IntegrationDigitalChannelCredit/credit/api/cancelCardEmbossByShadowCardNumber
curl https://sandboxpub.cms.dgpays.com/SandBox/IntegrationDigitalChannelCredit/credit/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

getPendingCardEmbossList

POST
https://sandboxpub.cms.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 · 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/IntegrationDigitalChannelCredit/credit/api/getPendingCardEmbossList
curl https://sandboxpub.cms.dgpays.com/SandBox/IntegrationDigitalChannelCredit/credit/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

Card applicationsCard lifecycle