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

No-name cards

Issue and activate pre-produced cards that carry no embossed name, then bind one to a customer at the point of sale.


createNoNameCardApplication

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

Creates a no-name debit card application, auto-selecting product and branch if not provided, handling accounts, permissions, and digital card flags. Returns the application ID.

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

createNoNameCardApplication › Request Body

CreateNoNameCardApplicationRequest
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

The customer the application is for. Omitted it arrives as 0, which the service refuses, as it does a negative number.

productNumber
​string · maxLength: 5 · optional

When absent the facade picks a no-name product for the channel, digital or physical as digitalCard asks. Sent, it must be a defined product.

digitalCard
​boolean · optional

Default — Defaults to false. Read only when productNumber is absent, to pick a digital or a physical no-name product; once the product is known the facade overwrites it from the product's card form.

branchCode
​integer · int32 · optional

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

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

correlationId
​string · maxLength: 30 · optional

The caller's own identifier for this request, stored against the application so the two can be reconciled later. The platform does not interpret it.

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.

applicationContractId
​string · maxLength: 20 · optional

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

createNoNameCardApplication › Responses

Success

CreateNoNameCardApplicationResponse
applicationId
​integer · int64 · required

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/createNoNameCardApplication
curl https://sandboxpub.cms.dgpays.com/SandBox/IntegrationDigitalChannelDebit/debit/api/createNoNameCardApplication \ --request POST \ --header 'Content-Type: application/json' \ --header 'evrst-ptrnid: x_request_id' \ --header 'Authorization: Bearer <access_token>' \ --data '{ "channel": "channel", "productNumber": "productNumber", "digitalCard": true, "customerNumber": 0, "branchCode": 0, "permissions": { "eCommercePermitted": true }, "listOfAccount": [ { "accountType": "accountType", "accountNumber": 0, "accountOrderFlag": true, "currencyCode": "currencyCode", "fxAutoConversionFlag": true } ], "correlationId": "correlationId", "enrollMasterpass": true, "applicationContractId": "applicationContractId" }'
Example Request Body
{ "channel": "channel", "productNumber": "productNumber", "digitalCard": true, "customerNumber": 0, "branchCode": 0, "permissions": { "eCommercePermitted": true }, "listOfAccount": [ { "accountType": "accountType", "accountNumber": 0, "accountOrderFlag": true, "currencyCode": "currencyCode", "fxAutoConversionFlag": true } ], "correlationId": "correlationId", "enrollMasterpass": true, "applicationContractId": "applicationContractId" }
json
application/json
Example Responses
{ "applicationId": 0 }
json
application/json

cancelNoNameCardApplication

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

Cancels a no-name debit card application using channel, application ID, correlation ID, and reason for cancellation.

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

cancelNoNameCardApplication › Request Body

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

correlationId
​string · maxLength: 30 · optional

The caller's own identifier for this request, stored against the application so the two can be reconciled later. The platform does not interpret it.

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.

cancelReasonCode
​string · maxLength: 3 · optional

Why the application is being cancelled.

cancelReasonText
​string · maxLength: 1024 · optional

Free text alongside the cancellation reason.

cancelNoNameCardApplication › Responses

Success

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

updateNoNameCardApplication

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

Updates a no-name card application. Allows modification of pending applications without customer name.

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

updateNoNameCardApplication › Request Body

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

correlationId
​string · maxLength: 30 · optional

The caller's own identifier for this request, stored against the application so the two can be reconciled later. The platform does not interpret it.

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

updateNoNameCardApplication › Responses

Success

No data returned
POST/IntegrationDigitalChannelDebit/debit/api/updateNoNameCardApplication
curl https://sandboxpub.cms.dgpays.com/SandBox/IntegrationDigitalChannelDebit/debit/api/updateNoNameCardApplication \ --request POST \ --header 'Content-Type: application/json' \ --header 'evrst-ptrnid: x_request_id' \ --header 'Authorization: Bearer <access_token>' \ --data '{ "channel": "channel", "correlationId": "correlationId", "permissions": { "eCommercePermitted": true }, "listOfAccount": [ { "accountType": "accountType", "accountNumber": 0, "accountOrderFlag": true, "currencyCode": "currencyCode", "fxAutoConversionFlag": true } ] }'
Example Request Body
{ "channel": "channel", "correlationId": "correlationId", "permissions": { "eCommercePermitted": true }, "listOfAccount": [ { "accountType": "accountType", "accountNumber": 0, "accountOrderFlag": true, "currencyCode": "currencyCode", "fxAutoConversionFlag": true } ] }
json
application/json
Example Responses
No example specified for this content type

activateNoNameCard

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

Activates a no-name debit card for a customer based on channel, last four digits, and barcode. Returns a shadow card number for tracking.

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

activateNoNameCard › Request Body

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

lastFourDigit
​string · maxLength: 19 · optional

The last four digits of the card, which pick which of the customer's cards is activated. Matched against the end of the masked card number rather than a stored field of its own, and no length is checked: a shorter value matches more than one card and the operation refuses rather than choosing, while anything longer than the masked number matches nothing.

barcode
​string · optional

The delivery barcode the consignment is tracked by.

Not read by the service. activateNoNameCard matches the card on customerNumber and lastFourDigit alone — the facade forwards this field and ActivateNoNameCard does not mention it, on credit, debit or prepaid. It is accepted and ignored.

activateNoNameCard › Responses

Success

ActivateNoNameCardResponse
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/activateNoNameCard
curl https://sandboxpub.cms.dgpays.com/SandBox/IntegrationDigitalChannelDebit/debit/api/activateNoNameCard \ --request POST \ --header 'Content-Type: application/json' \ --header 'evrst-ptrnid: x_request_id' \ --header 'Authorization: Bearer <access_token>' \ --data '{ "channel": "channel", "customerNumber": 0, "lastFourDigit": "lastFourDigit", "barcode": "barcode" }'
Example Request Body
{ "channel": "channel", "customerNumber": 0, "lastFourDigit": "lastFourDigit", "barcode": "barcode" }
json
application/json
Example Responses
{ "shadowCardNumber": "shadowCardNumber" }
json
application/json

createCardUsingNoNameApplication

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

Creates a debit card based on a no-name card application, handling accounts and permissions. Returns card references, masked and shadow card numbers, warnings, and sensitive card data if available.

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

createCardUsingNoNameApplication › Request Body

CreateCardUsingNoNameApplicationRequest
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

The customer the card is for. Omitted it arrives as 0, which the service refuses, as it does a negative number.

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.

correlationId
​string · maxLength: 30 · optional

The caller's own identifier for this request, stored against the application so the two can be reconciled later. The platform does not interpret it.

barcode
​string · maxLength: 120 · optional

The delivery barcode the consignment is tracked by.

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

createCardUsingNoNameApplication › Responses

Success

CreateCardUsingNoNameApplicationResponse
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/IntegrationDigitalChannelDebit/debit/api/createCardUsingNoNameApplication
curl https://sandboxpub.cms.dgpays.com/SandBox/IntegrationDigitalChannelDebit/debit/api/createCardUsingNoNameApplication \ --request POST \ --header 'Content-Type: application/json' \ --header 'evrst-ptrnid: x_request_id' \ --header 'Authorization: Bearer <access_token>' \ --data '{ "channel": "channel", "applicationId": 0, "correlationId": "correlationId", "customerNumber": 0, "barcode": "barcode", "permissions": { "eCommercePermitted": true }, "listOfAccount": [ { "accountType": "accountType", "accountNumber": 0, "accountOrderFlag": true, "currencyCode": "currencyCode", "fxAutoConversionFlag": true } ] }'
Example Request Body
{ "channel": "channel", "applicationId": 0, "correlationId": "correlationId", "customerNumber": 0, "barcode": "barcode", "permissions": { "eCommercePermitted": true }, "listOfAccount": [ { "accountType": "accountType", "accountNumber": 0, "accountOrderFlag": true, "currencyCode": "currencyCode", "fxAutoConversionFlag": true } ] }
json
application/json
Example Responses
{ "maskedCardNumber": "maskedCardNumber", "shadowCardNumber": "shadowCardNumber", "cardRefNumber": "cardRefNumber", "mainCardRefNumber": "mainCardRefNumber", "warnings": { "key": "string" }, "sensitiveCardData": { "pan": "pan", "expiryDateStr": "expiryDateStr", "cvv": "cvv" } }
json
application/json

createAndProcessNoNameCardApplication

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

Creates and processes a no-name debit card application, handling accounts, permissions, and digital card flags. Returns application ID, card references, masked and shadow card numbers, and sensitive card data if applicable.

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

createAndProcessNoNameCardApplication › Request Body

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

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.

branchCode
​integer · int32 · optional

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

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

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.

applicationContractId
​string · maxLength: 20 · optional

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

createAndProcessNoNameCardApplication › Responses

Success

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

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/createAndProcessNoNameCardApplication
curl https://sandboxpub.cms.dgpays.com/SandBox/IntegrationDigitalChannelDebit/debit/api/createAndProcessNoNameCardApplication \ --request POST \ --header 'Content-Type: application/json' \ --header 'evrst-ptrnid: x_request_id' \ --header 'Authorization: Bearer <access_token>' \ --data '{ "channel": "channel", "productNumber": "productNumber", "customerNumber": 0, "branchCode": 0, "permissions": { "eCommercePermitted": true }, "listOfAccount": [ { "accountType": "accountType", "accountNumber": 0, "accountOrderFlag": true, "currencyCode": "currencyCode", "fxAutoConversionFlag": true } ], "enrollMasterpass": true, "applicationContractId": "applicationContractId" }'
Example Request Body
{ "channel": "channel", "productNumber": "productNumber", "customerNumber": 0, "branchCode": 0, "permissions": { "eCommercePermitted": true }, "listOfAccount": [ { "accountType": "accountType", "accountNumber": 0, "accountOrderFlag": true, "currencyCode": "currencyCode", "fxAutoConversionFlag": true } ], "enrollMasterpass": true, "applicationContractId": "applicationContractId" }
json
application/json
Example Responses
{ "maskedCardNumber": "maskedCardNumber", "shadowCardNumber": "shadowCardNumber", "cardRefNumber": "cardRefNumber", "mainCardRefNumber": "mainCardRefNumber", "warnings": { "key": "string" }, "sensitiveCardData": { "pan": "pan", "expiryDateStr": "expiryDateStr", "cvv": "cvv" }, "applicationId": 0 }
json
application/json

replaceNoNameCard

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

Replaces a no-name card. Determines if the card is digital; if so, calls ReplaceCard, otherwise initiates a ReplaceNoNameCardApplication. Returns application ID, card reference numbers, masked card number, new card generation status, product change status, and shadow card number.

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

replaceNoNameCard › Request Body

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

replaceReasonCode
​string · maxLength: 3 · optional

Why the card is being replaced. It decides what the replacement inherits and whether the card number changes.

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.

replaceNoNameCard › Responses

Success

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

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.

newCardGenerated
​boolean · optional

Whether the change produced a new card.

productChanged
​boolean · optional

Whether the change moved the card to another product.

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.

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.

POST/IntegrationDigitalChannelDebit/debit/api/replaceNoNameCard
curl https://sandboxpub.cms.dgpays.com/SandBox/IntegrationDigitalChannelDebit/debit/api/replaceNoNameCard \ --request POST \ --header 'Content-Type: application/json' \ --header 'evrst-ptrnid: x_request_id' \ --header 'Authorization: Bearer <access_token>' \ --data '{ "channel": "channel", "shadowCardNumber": "shadowCardNumber", "replaceReasonCode": "replaceReasonCode", "enrollMasterpass": true, "permissions": { "eCommercePermitted": true } }'
Example Request Body
{ "channel": "channel", "shadowCardNumber": "shadowCardNumber", "replaceReasonCode": "replaceReasonCode", "enrollMasterpass": true, "permissions": { "eCommercePermitted": true } }
json
application/json
Example Responses
{ "applicationId": 0, "shadowCardNumber": "shadowCardNumber", "newCardGenerated": true, "productChanged": true, "maskedCardNumber": "maskedCardNumber", "cardRefNumber": "cardRefNumber" }
json
application/json

replaceCardUsingNoNameApplication

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

Replaces a card using a no-name application. Accepts channel, application ID, barcode, and customer number. Returns the new card details including card reference numbers, masked card number, shadow card number, record ID, warnings, and sensitive card data if available.

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

replaceCardUsingNoNameApplication › Request Body

ReplaceCardUsingNoNameApplicationRequest
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

The customer the card is for. Omitted it arrives as 0, which the service refuses, as it does a negative number.

applicationId
​integer · int64 · required

The replace application to issue the card from. Omitted it arrives as 0, which matches no application and is refused.

barcode
​string · maxLength: 120 · optional

The delivery barcode the consignment is tracked by.

replaceCardUsingNoNameApplication › Responses

Success

ReplaceCardUsingNoNameApplicationResponse
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/IntegrationDigitalChannelDebit/debit/api/replaceCardUsingNoNameApplication
curl https://sandboxpub.cms.dgpays.com/SandBox/IntegrationDigitalChannelDebit/debit/api/replaceCardUsingNoNameApplication \ --request POST \ --header 'Content-Type: application/json' \ --header 'evrst-ptrnid: x_request_id' \ --header 'Authorization: Bearer <access_token>' \ --data '{ "channel": "channel", "barcode": "barcode", "customerNumber": 0, "applicationId": 0 }'
Example Request Body
{ "channel": "channel", "barcode": "barcode", "customerNumber": 0, "applicationId": 0 }
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

changeAndReplaceNoNameCard

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

Changes the status of a no-name debit card and optionally replaces it or its application, handling digital and non-digital card scenarios. Returns updated status, new card details, and application ID if applicable.

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

changeAndReplaceNoNameCard › Request Body

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

cardStatusCode
​string · maxLength: 2 · required

Values:

  • A — valid
  • B — pending
  • C — stolen
  • D — cancelled by the bank
  • F — fraud
  • G — temporarily blocked
  • I — cancelled
  • L — lost
  • M — cancelled by the customer
  • T — corporate dummy
cardStatusReasonCode
​string · maxLength: 2 · required

Why the status is being set. The valid reasons depend on the status: getAvailableCardStatusList returns the pairs a card may move to.

​object · required

What the replacement card should carry — delivery, address and emboss details. Left out, the replacement inherits the card's own.

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

changeAndReplaceNoNameCard › Responses

Success

ChangeAndReplaceNoNameCardResponse
toStatusActive
​boolean · required

Whether the card ends this operation in an active status.

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.

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.

newCardGenerated
​boolean · optional

Whether the change produced a new card.

productChanged
​boolean · optional

Whether the change moved the card to another product.

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.

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.

POST/IntegrationDigitalChannelDebit/debit/api/changeAndReplaceNoNameCard
curl https://sandboxpub.cms.dgpays.com/SandBox/IntegrationDigitalChannelDebit/debit/api/changeAndReplaceNoNameCard \ --request POST \ --header 'Content-Type: application/json' \ --header 'evrst-ptrnid: x_request_id' \ --header 'Authorization: Bearer <access_token>' \ --data '{ "channel": "channel", "shadowCardNumber": "shadowCardNumber", "cardStatusCode": "cardStatusCode", "cardStatusReasonCode": "cardStatusReasonCode", "closeRequestDate": "2026-10-16T14:30:00Z", "replaceInfo": { "replaceReasonCode": "replaceReasonCode", "enrollMasterpass": true, "permissions": { "eCommercePermitted": true } } }'
Example Request Body
{ "channel": "channel", "shadowCardNumber": "shadowCardNumber", "cardStatusCode": "cardStatusCode", "cardStatusReasonCode": "cardStatusReasonCode", "closeRequestDate": "2026-10-16T14:30:00Z", "replaceInfo": { "replaceReasonCode": "replaceReasonCode", "enrollMasterpass": true, "permissions": { "eCommercePermitted": true } } }
json
application/json
Example Responses
{ "toStatusActive": true, "applicationId": 0, "shadowCardNumber": "shadowCardNumber", "newCardGenerated": true, "productChanged": true, "maskedCardNumber": "maskedCardNumber", "cardRefNumber": "cardRefNumber" }
json
application/json

Card lifecycleBranch management