Everest Card — API reference
  • Credit
  • Debit
  • Prepaid
  • Common Methods
  • 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

Branch management

Move a customer or a card between branches, and read the cards a branch holds.


changeCardBranch

POST
https://sandboxpub.cms.dgpays.com/SandBox
/IntegrationDigitalChannelPrepaid/prepaid/api/changeCardBranch

Changes the branch assigned to a prepaid card.

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

changeCardBranch › Request Body

ChangePpdCardBranchRequest
branchCode
​integer · int32 · required

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

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.

requestChannel
​string · optional

Not the channel every request carries: one of the differently-named channel fields the platform uses for other purposes.

Not the channel every request carries: this is one of nineteen differently-named channel fields the platform uses for other purposes, and no column behind this API stores it.

changeCardBranch › Responses

Success

ChangePpdCardBranchResponse
recordId
​integer · int64 · required

The identifier of the row the operation created or acted on, returned so a later call can name it.

POST/IntegrationDigitalChannelPrepaid/prepaid/api/changeCardBranch
curl https://sandboxpub.cms.dgpays.com/SandBox/IntegrationDigitalChannelPrepaid/prepaid/api/changeCardBranch \ --request POST \ --header 'Content-Type: application/json' \ --header 'evrst-ptrnid: x_request_id' \ --header 'Authorization: Bearer <access_token>' \ --data '{ "shadowCardNumber": "shadowCardNumber", "branchCode": 0, "requestChannel": "requestChannel" }'
Example Request Body
{ "shadowCardNumber": "shadowCardNumber", "branchCode": 0, "requestChannel": "requestChannel" }
json
application/json
Example Responses
{ "recordId": 0 }
json
application/json

changeCustomerBranch

POST
https://sandboxpub.cms.dgpays.com/SandBox
/IntegrationDigitalChannelPrepaid/prepaid/api/changeCustomerBranch

Changes the branch assigned to a prepaid customer.

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

changeCustomerBranch › Request Body

ChangePpdCustomerBranchRequest
customerNumber
​integer · int64 · required

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

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

requestChannel
​string · optional

Not the channel every request carries: one of the differently-named channel fields the platform uses for other purposes.

Not the channel every request carries: this is one of nineteen differently-named channel fields the platform uses for other purposes, and no column behind this API stores it.

changeCustomerBranch › Responses

Success

ChangePpdCustomerBranchResponse
recordId
​integer · int64 · required

The identifier of the row the operation created or acted on, returned so a later call can name it.

POST/IntegrationDigitalChannelPrepaid/prepaid/api/changeCustomerBranch
curl https://sandboxpub.cms.dgpays.com/SandBox/IntegrationDigitalChannelPrepaid/prepaid/api/changeCustomerBranch \ --request POST \ --header 'Content-Type: application/json' \ --header 'evrst-ptrnid: x_request_id' \ --header 'Authorization: Bearer <access_token>' \ --data '{ "customerNumber": 0, "branchCode": 0, "requestChannel": "requestChannel" }'
Example Request Body
{ "customerNumber": 0, "branchCode": 0, "requestChannel": "requestChannel" }
json
application/json
Example Responses
{ "recordId": 0 }
json
application/json

transferBranchCustomer

POST
https://sandboxpub.cms.dgpays.com/SandBox
/IntegrationDigitalChannelPrepaid/prepaid/api/transferBranchCustomer

Transfers a prepaid customer to a different branch.

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

transferBranchCustomer › Request Body

TransferPpdBranchCustomer
resourceBranchCode
​string · optional

Held as a number rather than text in the records behind this operation.

targetBranchCode
​string · optional

Held as a number rather than text in the records behind this operation.

requestChannel
​string · optional

Not the channel every request carries: one of the differently-named channel fields the platform uses for other purposes.

Not the channel every request carries: this is one of nineteen differently-named channel fields the platform uses for other purposes, and no column behind this API stores it.

customerOid
​array · optional

The customers to act on, by their object identifiers.

transferBranchCustomer › Responses

Success

TransferPpdBranchCustomerResponse
recordId
​integer · int64 · required

The identifier of the row the operation created or acted on, returned so a later call can name it.

POST/IntegrationDigitalChannelPrepaid/prepaid/api/transferBranchCustomer
curl https://sandboxpub.cms.dgpays.com/SandBox/IntegrationDigitalChannelPrepaid/prepaid/api/transferBranchCustomer \ --request POST \ --header 'Content-Type: application/json' \ --header 'evrst-ptrnid: x_request_id' \ --header 'Authorization: Bearer <access_token>' \ --data '{ "resourceBranchCode": "resourceBranchCode", "targetBranchCode": "targetBranchCode", "requestChannel": "requestChannel", "customerOid": [ 0 ] }'
Example Request Body
{ "resourceBranchCode": "resourceBranchCode", "targetBranchCode": "targetBranchCode", "requestChannel": "requestChannel", "customerOid": [ 0 ] }
json
application/json
Example Responses
{ "recordId": 0 }
json
application/json

No-name cardsCustomers