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

Customers

Read the customer behind the cards — portfolio summary, corporate relationships and total assets.


getCustomerAsset

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

Retrieves the asset information of a prepaid customer.

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

getCustomerAsset › Request Body

GetCustomerAssetRequest
customerNumber
​integer · int64 · required

Customer Number

purpose
​string | null

Purpose - [Optional]

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

getCustomerAsset › Responses

Success

GetCustomerAssetResponse
​array | null

List Of Card - [Optional]

POST/IntegrationDigitalChannelPrepaid/prepaid/api/getCustomerAsset
curl https://everest-sandboxapi.dgpays.com/SandBox/IntegrationDigitalChannelPrepaid/prepaid/api/getCustomerAsset \ --request POST \ --header 'Content-Type: application/json' \ --header 'evrst-ptrnid: x_request_id' \ --data '{ "customerNumber": 0, "purpose": "purpose", "channelCode": "channelCode" }'
Example Request Body
{ "customerNumber": 0, "purpose": "purpose", "channelCode": "channelCode" }
json
application/json
Example Responses
{ "listOfCard": [ { "shadowCardNumber": "shadowCardNumber", "maskedCardNumber": "maskedCardNumber", "cardRefNumber": "cardRefNumber", "mainCardRefNumber": "mainCardRefNumber", "customerNumber": 0, "mainCustomerNumber": 0, "relatedCardRefNumber": "relatedCardRefNumber", "supplementaryCardFlag": true, "cardRefCurrentCardFlag": true, "branchCode": 0, "branchName": "branchName", "ownerName": "ownerName", "ownerSecondName": "ownerSecondName", "ownerSurname": "ownerSurname", "embossName": "embossName", "productNumber": "productNumber", "productSegmentCode": "productSegmentCode", "cardStatusCode": "cardStatusCode", "cardStatusDscr": "cardStatusDscr", "cardStatusReasonCode": "cardStatusReasonCode", "cardStatusReasonDscr": "cardStatusReasonDscr", "virtualFlag": true, "productName": "productName", "productShortName": "productShortName", "tenantId": "tenantId", "emvFlag": true, "magneticStripeFlag": true, "contactlessFlag": true, "rewardEarningFlag": true, "cardBrand": "cardBrand", "cardBrandDescription": "cardBrandDescription", "cardDeliveryType": "cardDeliveryType", "expiryDateStr": "expiryDateStr", "provisionStatusFlag": true, "digitalCardFlag": true, "insertDate": "2024-08-25T15:00:00Z", "cvv2RetryCount": 0, "pinRetryCount": 0, "barcode": "barcode", "fromShadowCardNumber": "fromShadowCardNumber", "toShadowCardNumber": "toShadowCardNumber", "requestDate": "2024-08-25T15:00:00Z", "requestChannel": "requestChannel", "embossReasonCode": "embossReasonCode", "embossReasonDescription": "embossReasonDescription", "embossReasonSubCode": "embossReasonSubCode", "embossReasonSubDesc": "embossReasonSubDesc", "cardStatusChangeDate": "2024-08-25T15:00:00Z", "firstTrnDate": "2024-08-25T15:00:00Z", "lastTrnDate": "2024-08-25T15:00:00Z", "firstPinSetDate": "2024-08-25T15:00:00Z", "lastPinSetDate": "2024-08-25T15:00:00Z", "lastPinChangeDate": "2024-08-25T15:00:00Z", "deliveryAddress": "deliveryAddress", "isFirstPinSet": "isFirstPinSet", "sendingBranchCode": "sendingBranchCode", "sendingAddressType": "sendingAddressType", "productGroupCode": "productGroupCode", "productGroupDescription": "productGroupDescription", "fromMaskedCardNumber": "fromMaskedCardNumber", "toMaskedCardNumber": "toMaskedCardNumber", "disabledFlag": true, "sensitiveData": { "pan": "pan", "cvv2": "cvv2" }, "pendingReplaceApplicationExists": true, "pinStatus": "pinStatus", "cardStatusChangeChannel": "cardStatusChangeChannel", "securityFlag": true, "citizenshipNumber": "citizenshipNumber", "taxNumber": "taxNumber", "customerNameSurname": "customerNameSurname", "cardSeqNumber": 0, "isDelivered": true } ] }
json
application/json

getCustomerListOfBranch

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

Retrieves a list of customers for a specific branch.

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

getCustomerListOfBranch › Request Body

GetPpdCustomerLisfOfBranchRequest
branchCode
​string | null

Branch Code - [Optional]

getCustomerListOfBranch › Responses

Success

GetPpdCustomerListOfBranchResponse
customerOid
​array | null

Customer Oid - [Optional]

POST/IntegrationDigitalChannelPrepaid/prepaid/api/getCustomerListOfBranch
curl https://everest-sandboxapi.dgpays.com/SandBox/IntegrationDigitalChannelPrepaid/prepaid/api/getCustomerListOfBranch \ --request POST \ --header 'Content-Type: application/json' \ --header 'evrst-ptrnid: x_request_id' \ --data '{ "branchCode": "branchCode" }'
Example Request Body
{ "branchCode": "branchCode" }
json
application/json
Example Responses
{ "customerOid": [ 0 ] }
json
application/json

Branch managementTransactions