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

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://everest-sandboxapi.dgpays.com/SandBox
/IntegrationDigitalChannelPrepaid/prepaid/api/createNoNameCardApplication

Creates a new no-name prepaid card application.

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
digitalCard
โ€‹booleanย ยทย required

Digital Card

customerNumber
โ€‹integerย ยทย int64ย ยทย required

Customer Number

enrollMasterpass
โ€‹booleanย ยทย required

Enroll Masterpass

channel
โ€‹string | null

Three-digit channel code. Used for entitlement, limits and the audit trail. See the Channels page (sidebar, or from Get started) for the full code list.

productNumber
โ€‹string | null

Product Number - [Optional]

branchCode
โ€‹integer | nullย ยทย int32

Branch Code - [Optional]

โ€‹object

Permissions - [Optional]

correlationId
โ€‹string | null

Correlation Id - [Optional]

applicationContractId
โ€‹string | null

Application Contract Id - [Optional]

createNoNameCardApplication โ€บ Responses

Success

CreateNoNameCardApplicationResponse
applicationId
โ€‹integerย ยทย int64ย ยทย required

Application Id

POST/IntegrationDigitalChannelPrepaid/prepaid/api/createNoNameCardApplication
curl https://everest-sandboxapi.dgpays.com/SandBox/IntegrationDigitalChannelPrepaid/prepaid/api/createNoNameCardApplication \ --request POST \ --header 'Content-Type: application/json' \ --header 'evrst-ptrnid: x_request_id' \ --data '{ "channel": "channel", "productNumber": "productNumber", "digitalCard": true, "customerNumber": 0, "branchCode": 0, "permissions": { "eCommercePermitted": true }, "correlationId": "correlationId", "enrollMasterpass": true, "applicationContractId": "applicationContractId" }'
Example Request Body
{ "channel": "channel", "productNumber": "productNumber", "digitalCard": true, "customerNumber": 0, "branchCode": 0, "permissions": { "eCommercePermitted": true }, "correlationId": "correlationId", "enrollMasterpass": true, "applicationContractId": "applicationContractId" }
json
application/json
Example Responses
{ "applicationId": 0 }
json
application/json

cancelNoNameCardApplication

POST
https://everest-sandboxapi.dgpays.com/SandBox
/IntegrationDigitalChannelPrepaid/prepaid/api/cancelNoNameCardApplication

Cancels a pending no-name prepaid card application.

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

Three-digit channel code. Used for entitlement, limits and the audit trail. See the Channels page (sidebar, or from Get started) for the full code list.

correlationId
โ€‹string | null

Correlation Id - [Optional]

applicationId
โ€‹integer | nullย ยทย int64

Application Id - [Optional]

cancelReasonCode
โ€‹string | null

Cancel Reason Code - [Optional]

cancelReasonText
โ€‹string | null

Cancel Reason Text - [Optional]

cancelNoNameCardApplication โ€บ Responses

Success

No data returned
POST/IntegrationDigitalChannelPrepaid/prepaid/api/cancelNoNameCardApplication
curl https://everest-sandboxapi.dgpays.com/SandBox/IntegrationDigitalChannelPrepaid/prepaid/api/cancelNoNameCardApplication \ --request POST \ --header 'Content-Type: application/json' \ --header 'evrst-ptrnid: x_request_id' \ --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://everest-sandboxapi.dgpays.com/SandBox
/IntegrationDigitalChannelPrepaid/prepaid/api/updateNoNameCardApplication

Updates a no-name prepaid card application.

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

Three-digit channel code. Used for entitlement, limits and the audit trail. See the Channels page (sidebar, or from Get started) for the full code list.

correlationId
โ€‹string | null

Correlation Id - [Optional]

applicationId
โ€‹integer | nullย ยทย int64

Application Id - [Optional]

โ€‹object

Permissions - [Optional]

updateNoNameCardApplication โ€บ Responses

Success

No data returned
POST/IntegrationDigitalChannelPrepaid/prepaid/api/updateNoNameCardApplication
curl https://everest-sandboxapi.dgpays.com/SandBox/IntegrationDigitalChannelPrepaid/prepaid/api/updateNoNameCardApplication \ --request POST \ --header 'Content-Type: application/json' \ --header 'evrst-ptrnid: x_request_id' \ --data '{ "channel": "channel", "correlationId": "correlationId", "applicationId": 0, "permissions": { "eCommercePermitted": true } }'
Example Request Body
{ "channel": "channel", "correlationId": "correlationId", "applicationId": 0, "permissions": { "eCommercePermitted": true } }
json
application/json
Example Responses
No example specified for this content type

activateNoNameCard

POST
https://everest-sandboxapi.dgpays.com/SandBox
/IntegrationDigitalChannelPrepaid/prepaid/api/activateNoNameCard

Activates a no-name prepaid card for use.

Part of:

  • Journey 01 ยท Launching a new card product โ€” step 4, Register after KYC

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
customerNumber
โ€‹integerย ยทย int64ย ยทย required

Customer Number

channel
โ€‹string | null

Three-digit channel code. Used for entitlement, limits and the audit trail. See the Channels page (sidebar, or from Get started) for the full code list.

lastFourDigit
โ€‹string | null

Last Four Digit - [Optional]

barcode
โ€‹string | null

Barcode - [Optional]

activateNoNameCard โ€บ Responses

Success

ActivateNoNameCardResponse
shadowCardNumber
โ€‹string | null

Shadow Card Number - [Optional]

POST/IntegrationDigitalChannelPrepaid/prepaid/api/activateNoNameCard
curl https://everest-sandboxapi.dgpays.com/SandBox/IntegrationDigitalChannelPrepaid/prepaid/api/activateNoNameCard \ --request POST \ --header 'Content-Type: application/json' \ --header 'evrst-ptrnid: x_request_id' \ --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://everest-sandboxapi.dgpays.com/SandBox
/IntegrationDigitalChannelPrepaid/prepaid/api/createCardUsingNoNameApplication

Creates a prepaid card using a no-name application.

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
customerNumber
โ€‹integerย ยทย int64ย ยทย required

Customer Number

channel
โ€‹string | null

Three-digit channel code. Used for entitlement, limits and the audit trail. See the Channels page (sidebar, or from Get started) for the full code list.

applicationId
โ€‹integer | nullย ยทย int64

Application Id - [Optional]

correlationId
โ€‹string | null

Correlation Id - [Optional]

barcode
โ€‹string | null

Barcode - [Optional]

โ€‹object

Permissions - [Optional]

createCardUsingNoNameApplication โ€บ Responses

Success

CreateCardUsingNoNameApplicationResponse
maskedCardNumber
โ€‹string | null

Masked Card Number - [Optional]

shadowCardNumber
โ€‹string | null

Shadow Card Number - [Optional]

cardRefNumber
โ€‹string | null

Card Ref Number - [Optional]

mainCardRefNumber
โ€‹string | null

Main Card Ref Number - [Optional]

โ€‹object | null

Warnings - [Optional]

โ€‹object

Sensitive Card Data - [Optional]

POST/IntegrationDigitalChannelPrepaid/prepaid/api/createCardUsingNoNameApplication
curl https://everest-sandboxapi.dgpays.com/SandBox/IntegrationDigitalChannelPrepaid/prepaid/api/createCardUsingNoNameApplication \ --request POST \ --header 'Content-Type: application/json' \ --header 'evrst-ptrnid: x_request_id' \ --data '{ "channel": "channel", "applicationId": 0, "correlationId": "correlationId", "customerNumber": 0, "barcode": "barcode", "permissions": { "eCommercePermitted": true } }'
Example Request Body
{ "channel": "channel", "applicationId": 0, "correlationId": "correlationId", "customerNumber": 0, "barcode": "barcode", "permissions": { "eCommercePermitted": 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

replaceNoNameCard

POST
https://everest-sandboxapi.dgpays.com/SandBox
/IntegrationDigitalChannelPrepaid/prepaid/api/replaceNoNameCard

Replaces a no-name prepaid card.

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

Three-digit channel code. Used for entitlement, limits and the audit trail. See the Channels page (sidebar, or from Get started) for the full code list.

shadowCardNumber
โ€‹string | null

Shadow Card Number - [Optional]

replaceReasonCode
โ€‹string | null

Replace Reason Code - [Optional]

โ€‹object

Permissions - [Optional]

replaceNoNameCard โ€บ Responses

Success

ReplaceNoNameCardResponse
applicationId
โ€‹integer | nullย ยทย int64

Application Id - [Optional]

shadowCardNumber
โ€‹string | null

Shadow Card Number - [Optional]

newCardGenerated
โ€‹boolean | null

New Card Generated - [Optional]

productChanged
โ€‹boolean | null

Product Changed - [Optional]

maskedCardNumber
โ€‹string | null

Masked Card Number - [Optional]

cardRefNumber
โ€‹string | null

Card Ref Number - [Optional]

POST/IntegrationDigitalChannelPrepaid/prepaid/api/replaceNoNameCard
curl https://everest-sandboxapi.dgpays.com/SandBox/IntegrationDigitalChannelPrepaid/prepaid/api/replaceNoNameCard \ --request POST \ --header 'Content-Type: application/json' \ --header 'evrst-ptrnid: x_request_id' \ --data '{ "channel": "channel", "shadowCardNumber": "shadowCardNumber", "replaceReasonCode": "replaceReasonCode", "permissions": { "eCommercePermitted": true } }'
Example Request Body
{ "channel": "channel", "shadowCardNumber": "shadowCardNumber", "replaceReasonCode": "replaceReasonCode", "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://everest-sandboxapi.dgpays.com/SandBox
/IntegrationDigitalChannelPrepaid/prepaid/api/replaceCardUsingNoNameApplication

Replaces a prepaid card using a no-name application.

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
customerNumber
โ€‹integerย ยทย int64ย ยทย required

Customer Number

applicationId
โ€‹integerย ยทย int64ย ยทย required

Application Id

barcode
โ€‹string | null

Barcode - [Optional]

channel
โ€‹string | null

Three-digit channel code. Used for entitlement, limits and the audit trail. See the Channels page (sidebar, or from Get started) for the full code list.

replaceCardUsingNoNameApplication โ€บ Responses

Success

ReplaceCardUsingNoNameApplicationResponse
recordId
โ€‹integerย ยทย int64ย ยทย required

Record Id

maskedCardNumber
โ€‹string | null

Masked Card Number - [Optional]

shadowCardNumber
โ€‹string | null

Shadow Card Number - [Optional]

cardRefNumber
โ€‹string | null

Card Ref Number - [Optional]

mainCardRefNumber
โ€‹string | null

Main Card Ref Number - [Optional]

โ€‹object | null

Warnings - [Optional]

โ€‹object

Sensitive Card Data - [Optional]

POST/IntegrationDigitalChannelPrepaid/prepaid/api/replaceCardUsingNoNameApplication
curl https://everest-sandboxapi.dgpays.com/SandBox/IntegrationDigitalChannelPrepaid/prepaid/api/replaceCardUsingNoNameApplication \ --request POST \ --header 'Content-Type: application/json' \ --header 'evrst-ptrnid: x_request_id' \ --data '{ "barcode": "barcode", "customerNumber": 0, "applicationId": 0, "channel": "channel" }'
Example Request Body
{ "barcode": "barcode", "customerNumber": 0, "applicationId": 0, "channel": "channel" }
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://everest-sandboxapi.dgpays.com/SandBox
/IntegrationDigitalChannelPrepaid/prepaid/api/changeAndReplaceNoNameCard

Changes and replaces a no-name prepaid card application.

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

Three-digit channel code. Used for entitlement, limits and the audit trail. See the Channels page (sidebar, or from Get started) for the full code list.

shadowCardNumber
โ€‹string | null

Shadow Card Number - [Optional]

cardStatusCode
โ€‹string | null

Card Status Code - [Optional]

cardStatusReasonCode
โ€‹string | null

Card Status Reason Code - [Optional]

closeRequestDate
โ€‹string | nullย ยทย date-time

Close Request Date - [Optional]

โ€‹object

Replace Info - [Optional]

changeAndReplaceNoNameCard โ€บ Responses

Success

ChangeAndReplaceNoNameCardResponse
toStatusActive
โ€‹booleanย ยทย required

To Status Active

applicationId
โ€‹integer | nullย ยทย int64

Application Id - [Optional]

shadowCardNumber
โ€‹string | null

Shadow Card Number - [Optional]

newCardGenerated
โ€‹boolean | null

New Card Generated - [Optional]

productChanged
โ€‹boolean | null

Product Changed - [Optional]

maskedCardNumber
โ€‹string | null

Masked Card Number - [Optional]

cardRefNumber
โ€‹string | null

Card Ref Number - [Optional]

POST/IntegrationDigitalChannelPrepaid/prepaid/api/changeAndReplaceNoNameCard
curl https://everest-sandboxapi.dgpays.com/SandBox/IntegrationDigitalChannelPrepaid/prepaid/api/changeAndReplaceNoNameCard \ --request POST \ --header 'Content-Type: application/json' \ --header 'evrst-ptrnid: x_request_id' \ --data '{ "channel": "channel", "shadowCardNumber": "shadowCardNumber", "cardStatusCode": "cardStatusCode", "cardStatusReasonCode": "cardStatusReasonCode", "closeRequestDate": "2024-08-25T15:00:00Z", "replaceInfo": { "replaceReasonCode": "replaceReasonCode", "permissions": { "eCommercePermitted": true } } }'
Example Request Body
{ "channel": "channel", "shadowCardNumber": "shadowCardNumber", "cardStatusCode": "cardStatusCode", "cardStatusReasonCode": "cardStatusReasonCode", "closeRequestDate": "2024-08-25T15:00:00Z", "replaceInfo": { "replaceReasonCode": "replaceReasonCode", "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