Everest Card — API reference
  • Credit
  • Debit
  • Prepaid
  • Common Methods
  • OAuth2
  • Delivery
Information
Cards
    Card lifecycle
      getBasicCardInformationByPanpostgetDebitCardLogDataListByShadowCardNumberpostgetCreditCardLogDataListByShadowCardNumberpostgetCardByCardNumberpostgetSecureCardByPanpostgetCardByShadowCardNumberpost
Customers and accounts
    Customers
      getAssetByShadowCardNumberpostgetCustomerDetailpostcreateCustomerpostupdateCustomerpost
    Account linking
      accountStatuspost
Transactions
    getCreditTransactionListpostgetPaymentAndCashadvanceInformationByCriteriaspostgetAuthorizationListByBegindateEnddatepostgetDbttransactionByCardrefCustomernumpost
Limits and controls
    Card and customer limits
      changeCustomerLimitDecreasepostchangeCustomerLimitIncreasepost
    Permissions and restrictions
      getCardRestrictionpost
Billing and statements
    Collections and legal follow-up
      createFollowUpByMainCustomerNumberpostaddToLegalFollowUppost
    Debt payment
      getAutoPaymentQueuepost
    Statements and billing
      getDelinquencyInterestAmountpostsetStatementDocumentIdpostsetStatementDocumentOnlypostgetCardStatementCutoffReportpost
Security
    PIN and card security
      isSetCardPinViaSMSControlpostgetClearPanByShadowpostgetCardInfoByClearPanpostgetEncryptDataBlockpostdecryptDataBlockpost
Rewards
    Campaigns and rewards
      executeCampaignTransactionpostgetDebitCardForRewardByBankpost
Platform
    Platform operations
      healthCheckpostrefreshCachepost
    Reference data
      getProductByShadowCardNumberpostgetEmbossReasonSubDefByValidFlagpostgetAvailableEmbossReasonListpostgetMccGroupAllpostgetTrnStatusAllpostgetBinDomesticByBinpostgetApplicableProductspostgetMccDefinitionGroupbyMccMccdescriptionpostgetNetworkTypeDefByValidFlagpostgetResponseCodeDefByValidFlagpostgetResponseReasonCodeDefByValidFlagpostgetTrnCodeDefByValidFlagpostgetTrnCodeMatrixByValidFlagpost
SchemasError codesChannels
powered by Zudoku
Common Methods
Common Methods

Reference data

Look up the reference data a card programme is configured against — products, codes and parameters.


getProductByShadowCardNumber

POST
https://sandboxpub.cms.dgpays.com/SandBox
/Integrationcorebanking/Indoor/api/getProductByShadowCardNumber

Retrieves product information based on a shadow card number. Returns product brand, card type, product number, product name, product short name, and digital card ability.

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

getProductByShadowCardNumber › Request Body

GetProductByShadowCardNumberRequest
shadowCardNumber
​string · maxLength: 19 · required

The card whose product is returned. It is not format-checked; an absent or unknown value is reported as a missing asset.

getProductByShadowCardNumber › Responses

Success.

The card record is read only to obtain its product number. The owner name, status, expiry date, masked card number and customer number that come back with it are discarded, and nothing about the card itself appears in the response.

The product attributes are then taken from the integration layer's in-memory product cache, not from the database, so a product definition changed since the last cache refresh is reported with its cached values.

GetProductByShadowCardNumberResponse
cardType
​integer · enum · int32 · required

0 None, 1 Credit, 2 Debit, 3 Prepaid

Enum values:
0
1
2
3
digitalAbility
​boolean · required

Whether the product can be issued as a digital card.

brand
​string · optional

Which scheme the card is issued on.

productNumber
​string · optional

The card product the card is issued on. Defined in the parameter tables; getCardProductList returns the ones a tenant may use.

productName
​string · optional

The card product's full name.

productShortname
​string · optional
POST/Integrationcorebanking/Indoor/api/getProductByShadowCardNumber
curl https://sandboxpub.cms.dgpays.com/SandBox/Integrationcorebanking/Indoor/api/getProductByShadowCardNumber \ --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
{ "cardType": 0, "brand": "brand", "productNumber": "productNumber", "productName": "productName", "productShortname": "productShortname", "digitalAbility": true }
json
application/json

getEmbossReasonSubDefByValidFlag

POST
https://sandboxpub.cms.dgpays.com/SandBox
/Integrationcorebanking/Indoor/api/getEmbossReasonSubDefByValidFlag

Retrieves emboss reason sub definitions with their valid and use flags. Calls _pmServiceProxy.GetEmbossReasonSubDefByValidFlag() and maps results to GetEmbossReasonSubDefByValidFlagResponse containing EmbossReasonSubDefList with properties ValidFlag, EmbossReasonSubCode, EmbossReasonSubDesc, and UseFlag.

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

getEmbossReasonSubDefByValidFlag › Responses

Success.

The operation takes no request body, and the parameter service call behind it takes no arguments either. Every caller gets the same list; the valid-flag filter named in the operation is applied inside the parameter service and cannot be influenced from here.

If the parameter service returns nothing, a null list or an empty list, embossReasonSubDefList is never assigned and the response comes back with no list at all rather than with an empty one, and never as a refusal.

Each definition is re-projected onto exactly four fields: validFlag, embossReasonSubCode, embossReasonSubDesc and useFlag.

GetEmbossReasonSubDefByValidFlagResponse
​array · optional
POST/Integrationcorebanking/Indoor/api/getEmbossReasonSubDefByValidFlag
curl https://sandboxpub.cms.dgpays.com/SandBox/Integrationcorebanking/Indoor/api/getEmbossReasonSubDefByValidFlag \ --request POST \ --header 'evrst-ptrnid: x_request_id' \ --header 'Authorization: Bearer <access_token>'
Example Responses
{ "embossReasonSubDefList": [ { "validFlag": true, "embossReasonSubCode": "embossReasonSubCode", "embossReasonSubDesc": "embossReasonSubDesc", "useFlag": true } ] }
json
application/json

getAvailableEmbossReasonList

POST
https://sandboxpub.cms.dgpays.com/SandBox
/Integrationcorebanking/Indoor/api/getAvailableEmbossReasonList

Retrieves a list of available emboss reasons for a given card identified by ShadowCardNumber. The method accepts GetAvailableEmbossReasonListRequest containing ShadowCardNumber. The response returns GetAvailableEmbossReasonListResponse with a list of GetAvailableEmbossReasonByCardStatusResult, each containing EmbossReasonSubCode, EmbossReasonSubDesc, StatusCode, StatusReasonCode, and ProductNumber.

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

getAvailableEmbossReasonList › Request Body

GetAvailableEmbossReasonListRequest
shadowCardNumber
​string · maxLength: 19 · optional

Shadow card number whose permitted emboss reasons are listed. The facade does not validate it and passes it straight to the CIS online service.

getAvailableEmbossReasonList › Responses

Success.

The facade adds nothing: it forwards the shadow card number to the CIS online service and re-projects the result. This operation has no validation block, so a blank shadow card number reaches the downstream service unchecked.

The mapping is null-tolerant at every level. If the CIS online service returns no response, or a response with no result list, getAvailableEmbossReasonByCardStatusResult is absent from the reply. A shadow card number that matches nothing therefore comes back as a 200 with no list rather than as a refusal.

Each entry is re-projected onto exactly five fields: embossReasonSubCode, embossReasonSubDesc, productNumber, statusCode and statusReasonCode.

GetAvailableEmbossReasonListResponse
​array · optional
POST/Integrationcorebanking/Indoor/api/getAvailableEmbossReasonList
curl https://sandboxpub.cms.dgpays.com/SandBox/Integrationcorebanking/Indoor/api/getAvailableEmbossReasonList \ --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
{ "getAvailableEmbossReasonByCardStatusResult": [ { "embossReasonSubCode": "embossReasonSubCode", "embossReasonSubDesc": "embossReasonSubDesc", "statusCode": "statusCode", "statusReasonCode": "statusReasonCode" } ] }
json
application/json

getMccGroupAll

POST
https://sandboxpub.cms.dgpays.com/SandBox
/Integrationcorebanking/Indoor/api/getMccGroupAll

Retrieves all MCC groups from cache using _cache.GetMccGroupAll() and maps them to a list of MccGroup objects containing InstitutionCode, Kk100hOrderNumber, MccGroupCode, MccGroupDescription, QualificationIndicatorCode, UseInApplicationFlag, and ValidFlag.

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

getMccGroupAll › Responses

Success.

The list is served from the in-process cache, not from the database. It is whatever the parameter service returned at start-up, and refreshCache is what reloads it. No filter is applied here, so invalid groups are included and validFlag has to be read by the caller. If the cache slot was never filled, listOfMccGroup comes back as null rather than as an empty array.

GetMccGroupAllResponse
​array · optional
POST/Integrationcorebanking/Indoor/api/getMccGroupAll
curl https://sandboxpub.cms.dgpays.com/SandBox/Integrationcorebanking/Indoor/api/getMccGroupAll \ --request POST \ --header 'evrst-ptrnid: x_request_id' \ --header 'Authorization: Bearer <access_token>'
Example Responses
{ "listOfMccGroup": [ { "validFlag": true, "institutionCode": "institutionCode", "mccGroupCode": "mccGroupCode", "mccGroupDescription": "mccGroupDescription", "useInApplicationFlag": true, "qualificationIndicatorCode": "qualificationIndicatorCode", "kk100hOrderNumber": 0 } ] }
json
application/json

getTrnStatusAll

POST
https://sandboxpub.cms.dgpays.com/SandBox
/Integrationcorebanking/Indoor/api/getTrnStatusAll

Retrieves all transaction statuses along with their codes, descriptions, and validity flags for core banking integration.

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

getTrnStatusAll › Responses

Success.

The list is served from the in-process cache, not from the database. It is whatever the parameter service returned at start-up, and refreshCache is what reloads it. Despite the operation name no valid-flag filter is applied, so invalid statuses are included and validFlag has to be read by the caller. If the cache slot was never filled, listOfTrnStatus comes back as null rather than as an empty array.

GetTrnStatusAllResponse
​array · optional
POST/Integrationcorebanking/Indoor/api/getTrnStatusAll
curl https://sandboxpub.cms.dgpays.com/SandBox/Integrationcorebanking/Indoor/api/getTrnStatusAll \ --request POST \ --header 'evrst-ptrnid: x_request_id' \ --header 'Authorization: Bearer <access_token>'
Example Responses
{ "listOfTrnStatus": [ { "validFlag": true, "trnStatusCode": "trnStatusCode", "trnStatusDescription": "trnStatusDescription" } ] }
json
application/json

getBinDomesticByBin

POST
https://sandboxpub.cms.dgpays.com/SandBox
/Integrationcorebanking/Indoor/api/getBinDomesticByBin

Service that lists local card information based on the provided BIN.

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

getBinDomesticByBin › Request Body

GetBinDomesticByBinRequest
bin
​string · maxLength: 8 · required

Card BIN. It is right-padded with zeros to twelve digits and then matched numerically against the minimum and maximum of each domestic BIN range, so a shorter prefix is accepted. The value must be numeric.

getBinDomesticByBin › Responses

Success.

The BIN ranges are not read from the database on each call. They are served from the in-process cache, which is filled at start-up from the parameter service, so a range added or changed afterwards is not seen until refreshCache has run. The first range whose minimum and maximum bracket the padded BIN wins; the operation does not look for a closest or longest match. issuerBankCode is returned with its trailing spaces removed.

GetBinDomesticByBinResponse
validFlag
​boolean · required

Whether the row is live. The platform sets it.

acqFlag
​boolean · required
bonusFlag
​boolean · required
businessFlag
​boolean · required
preAuthDebitFlag
​boolean · required
binMinValue
​string · optional
binMaxValue
​string · optional
binDescription
​string · optional
processorBin
​string · optional
issuerBankCode
​string · optional
cardType
​string · enum · optional

Values:

  • C — credit
  • D — debit
  • P — prepaid
cardBrand
​string · optional

Which scheme the card is issued on.

panLength
​integer · int32 · optional
rewardType
​string · optional

Which kind of reward was earned.

authenticationType
​string · optional
loyaltyProgram
​string · optional
binLength
​string · optional
POST/Integrationcorebanking/Indoor/api/getBinDomesticByBin
curl https://sandboxpub.cms.dgpays.com/SandBox/Integrationcorebanking/Indoor/api/getBinDomesticByBin \ --request POST \ --header 'Content-Type: application/json' \ --header 'evrst-ptrnid: x_request_id' \ --header 'Authorization: Bearer <access_token>' \ --data '{ "bin": "bin" }'
Example Request Body
{ "bin": "bin" }
json
application/json
Example Responses
{ "validFlag": true, "binMinValue": "binMinValue", "binMaxValue": "binMaxValue", "binDescription": "binDescription", "processorBin": "processorBin", "issuerBankCode": "issuerBankCode", "cardType": "cardType", "cardBrand": "cardBrand", "panLength": 0, "acqFlag": true, "rewardType": "rewardType", "bonusFlag": true, "businessFlag": true, "preAuthDebitFlag": true, "authenticationType": "authenticationType", "loyaltyProgram": "loyaltyProgram", "binLength": "binLength" }
json
application/json

getApplicableProducts

POST
https://sandboxpub.cms.dgpays.com/SandBox
/Integrationcorebanking/Indoor/api/getApplicableProducts

Retrieves all applicable card products from cache. Maps each cached product to GetApplicableProductsResponseItem including Bin, Brand, ClassCode, ContactlessAbility, DigitalAbility, EmvAbility, GroupCode, IsNoName, ListOfApplicableChannel, ProductName, ProductNumber, ProductShortName, SegmentCode, TenantId, TypeCode, TypeCodeDetail, and VirtualAbility. Returns the list as GetApplicableProductsResponse.

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

getApplicableProducts › Request Body

GetApplicableProductsRequest
queryDate
​string · optional

Ignored — The operation never reads it. The result is the same whatever date is sent, and whether or not the property is present.

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

getApplicableProducts › Responses

Success.

The whole applicable-product catalogue is served from the service's in-memory cache. Nothing is read from the database on the call, no customer is involved, and no date filtering is applied.

The list reflects the cache as it was last refreshed. A product definition added since then is missing until the cache is refreshed, and if the cache entry has not been loaded at all the response carries no product list rather than an error.

GetApplicableProductsResponse
​array · optional

The products the search matched.

POST/Integrationcorebanking/Indoor/api/getApplicableProducts
curl https://sandboxpub.cms.dgpays.com/SandBox/Integrationcorebanking/Indoor/api/getApplicableProducts \ --request POST \ --header 'Content-Type: application/json' \ --header 'evrst-ptrnid: x_request_id' \ --header 'Authorization: Bearer <access_token>' \ --data '{ "queryDate": "2026-10-16T14:30:00Z" }'
Example Request Body
{ "queryDate": "2026-10-16T14:30:00Z" }
json
application/json
Example Responses
{ "listOfProduct": [ { "productNumber": "productNumber", "productName": "productName", "productShortName": "productShortName", "brand": "brand", "virtualAbility": true, "digitalAbility": true, "typeCode": "typeCode", "segmentCode": "segmentCode", "bin": "bin", "contactlessAbility": true, "emvAbility": true, "groupCode": "groupCode", "classCode": "classCode", "isNoName": true, "typeCodeDetail": "typeCodeDetail", "tenantId": "tenantId", "listOfApplicableChannel": [ "string" ] } ] }
json
application/json

getMccDefinitionGroupbyMccMccdescription

POST
https://sandboxpub.cms.dgpays.com/SandBox
/Integrationcorebanking/Indoor/api/getMccDefinitionGroupbyMccMccdescription

Retrieves MCC definition groups by MCC and MCC description from the internal repository using _intRepository.GetMccDefinitionGroupbyMccMccdescription().

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

getMccDefinitionGroupbyMccMccdescription › Responses

Success.

The response carries no body. The repository method runs the grouping query with ExecuteNonQuery and returns only an affected-row count, and the facade discards even that, so no MCC row ever reaches the caller. A 200 means the query ran, nothing more.

No data returned
POST/Integrationcorebanking/Indoor/api/getMccDefinitionGroupbyMccMccdescription
curl https://sandboxpub.cms.dgpays.com/SandBox/Integrationcorebanking/Indoor/api/getMccDefinitionGroupbyMccMccdescription \ --request POST \ --header 'evrst-ptrnid: x_request_id' \ --header 'Authorization: Bearer <access_token>'
Example Responses
No example specified for this content type

getNetworkTypeDefByValidFlag

POST
https://sandboxpub.cms.dgpays.com/SandBox
/Integrationcorebanking/Indoor/api/getNetworkTypeDefByValidFlag

Retrieves all network type definitions with valid flag. Returns a list of objects containing insert and update metadata, valid flag, network type code, and network type description.

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

getNetworkTypeDefByValidFlag › Responses

Success.

The list is read live from the parameter database on every call, not from the cache, so refreshCache has no effect on it. Only rows whose valid flag is set are returned, and when none are valid NetworkTypeDefList comes back as an empty list rather than as an error. The rows are unordered.

GetNetworkTypeDefByValidFlagResponse
​array · optional
POST/Integrationcorebanking/Indoor/api/getNetworkTypeDefByValidFlag
curl https://sandboxpub.cms.dgpays.com/SandBox/Integrationcorebanking/Indoor/api/getNetworkTypeDefByValidFlag \ --request POST \ --header 'evrst-ptrnid: x_request_id' \ --header 'Authorization: Bearer <access_token>'
Example Responses
{ "NetworkTypeDefList": [ { "insertDate": "2026-10-16T14:30:00Z", "insertUserId": "insertUserId", "insertTokenId": "insertTokenId", "updateDate": "2026-10-16T14:30:00Z", "updateUserId": "updateUserId", "updateTokenId": "updateTokenId", "validFlag": true, "networkType": "networkType", "networkTypeDescription": "networkTypeDescription" } ] }
json
application/json

getResponseCodeDefByValidFlag

POST
https://sandboxpub.cms.dgpays.com/SandBox
/Integrationcorebanking/Indoor/api/getResponseCodeDefByValidFlag

Retrieves a list of response codes filtered by valid flag. Each item includes transaction domain, response code, description, success flag, and metadata such as insert/update dates and user IDs.

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

getResponseCodeDefByValidFlag › Responses

Success.

The list is read live from the parameter database on every call, not from the cache, so refreshCache has no effect on it. Only rows whose valid flag is set are returned, and when none are valid ResponseCodeDefList comes back as an empty list rather than as an error. The rows are unordered.

GetResponseCodeDefByValidFlagResponse
​array · optional
POST/Integrationcorebanking/Indoor/api/getResponseCodeDefByValidFlag
curl https://sandboxpub.cms.dgpays.com/SandBox/Integrationcorebanking/Indoor/api/getResponseCodeDefByValidFlag \ --request POST \ --header 'evrst-ptrnid: x_request_id' \ --header 'Authorization: Bearer <access_token>'
Example Responses
{ "ResponseCodeDefList": [ { "insertDate": "2026-10-16T14:30:00Z", "insertUserId": "insertUserId", "insertTokenId": "insertTokenId", "updateDate": "2026-10-16T14:30:00Z", "updateUserId": "updateUserId", "updateTokenId": "updateTokenId", "validFlag": true, "transactionDomain": "transactionDomain", "responseCode": "responseCode", "responseCodeDescription": "responseCodeDescription", "successFlag": true } ] }
json
application/json

getResponseReasonCodeDefByValidFlag

POST
https://sandboxpub.cms.dgpays.com/SandBox
/Integrationcorebanking/Indoor/api/getResponseReasonCodeDefByValidFlag

Retrieves a list of response reason codes filtered by valid flag. Each item includes the reason code, description, local description, validity flag, and metadata such as insert/update dates and user IDs.

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

getResponseReasonCodeDefByValidFlag › Responses

Success.

The list is read live from the parameter database on every call, not from the cache, so refreshCache has no effect on it. Only rows whose valid flag is set are returned, and when none are valid ResponseReasonCodeDefList comes back as an empty list rather than as an error. The rows are unordered.

GetResponseReasonCodeDefByValidFlagResponse
​array · optional
POST/Integrationcorebanking/Indoor/api/getResponseReasonCodeDefByValidFlag
curl https://sandboxpub.cms.dgpays.com/SandBox/Integrationcorebanking/Indoor/api/getResponseReasonCodeDefByValidFlag \ --request POST \ --header 'evrst-ptrnid: x_request_id' \ --header 'Authorization: Bearer <access_token>'
Example Responses
{ "ResponseReasonCodeDefList": [ { "insertDate": "2026-10-16T14:30:00Z", "insertUserId": "insertUserId", "insertTokenId": "insertTokenId", "updateDate": "2026-10-16T14:30:00Z", "updateUserId": "updateUserId", "updateTokenId": "updateTokenId", "validFlag": true, "responseReasonCode": "responseReasonCode", "responseReasonDescription": "responseReasonDescription", "descriptionLocal": "descriptionLocal" } ] }
json
application/json

getTrnCodeDefByValidFlag

POST
https://sandboxpub.cms.dgpays.com/SandBox
/Integrationcorebanking/Indoor/api/getTrnCodeDefByValidFlag

Retrieves all valid transaction codes along with their descriptions, insert/update metadata, and validity flags. This is used to get the list of transaction code definitions for core banking integration.

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

getTrnCodeDefByValidFlag › Responses

Success.

The list is read live from the parameter database on every call, not from the cache, so refreshCache has no effect on it. Only rows whose valid flag is set are returned, and when none are valid TrnCodeDefList comes back as an empty list rather than as an error. The rows are unordered.

GetTrnCodeDefByValidFlagResponse
​array · optional
POST/Integrationcorebanking/Indoor/api/getTrnCodeDefByValidFlag
curl https://sandboxpub.cms.dgpays.com/SandBox/Integrationcorebanking/Indoor/api/getTrnCodeDefByValidFlag \ --request POST \ --header 'evrst-ptrnid: x_request_id' \ --header 'Authorization: Bearer <access_token>'
Example Responses
{ "TrnCodeDefList": [ { "validFlag": true, "insertDate": "2026-10-16T14:30:00Z", "insertUserId": "insertUserId", "insertTokenId": "insertTokenId", "updateDate": "2026-10-16T14:30:00Z", "updateUserId": "updateUserId", "updateTokenId": "updateTokenId", "trnCode": "trnCode", "trnCodeDescription": "trnCodeDescription" } ] }
json
application/json

getTrnCodeMatrixByValidFlag

POST
https://sandboxpub.cms.dgpays.com/SandBox
/Integrationcorebanking/Indoor/api/getTrnCodeMatrixByValidFlag

Retrieves all valid transaction code matrices along with their details, flags, and associated metadata. This is used to get the list of transaction code matrices for core banking integration.

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

getTrnCodeMatrixByValidFlag › Responses

Success.

The list is read live from the parameter database on every call, not from the cache, so refreshCache has no effect on it. Only rows whose valid flag is set are returned, and when none are valid TrnCodeMatrixList comes back as an empty list rather than as an error. The whole matrix is returned; there is no way to ask for one transaction code. The rows are unordered.

GetTrnCodeMatrixByValidFlagResponse
​array · optional
POST/Integrationcorebanking/Indoor/api/getTrnCodeMatrixByValidFlag
curl https://sandboxpub.cms.dgpays.com/SandBox/Integrationcorebanking/Indoor/api/getTrnCodeMatrixByValidFlag \ --request POST \ --header 'evrst-ptrnid: x_request_id' \ --header 'Authorization: Bearer <access_token>'
Example Responses
{ "TrnCodeMatrixList": [ { "insertDate": "2026-10-16T14:30:00Z", "insertUserId": "insertUserId", "insertTokenId": "insertTokenId", "updateDate": "2026-10-16T14:30:00Z", "updateUserId": "updateUserId", "updateTokenId": "updateTokenId", "validFlag": true, "trnCodeMatrixId": "trnCodeMatrixId", "trnCode": "trnCode", "trnCodeDetail": "trnCodeDetail", "trnCodeSpecial": "trnCodeSpecial", "trnInstallmentType": "trnInstallmentType", "trnDescription": "trnDescription", "onlineMessageType": "onlineMessageType", "trnEffect": "trnEffect", "trnEffectType": "trnEffectType", "financialTrnFlag": true, "adjustmentTrnFlag": true, "trnEffectedLimit": "trnEffectedLimit", "trnRewardAbility": "trnRewardAbility", "reversalFlag": true, "refundFlag": true, "voidFlag": true, "adviceFlag": true, "offlineFlag": true, "recurringFlag": true, "preauthorizationStatus": "preauthorizationStatus", "processType": "processType", "autoBsmvFlag": true, "autoKkdfFlag": true, "rewardEffectedSegment": "rewardEffectedSegment", "closingTrnCode": "closingTrnCode", "closingTrnCodeDetail": "closingTrnCodeDetail", "trnGroupCode": "trnGroupCode", "trnCodeBucketGroupCode": "trnCodeBucketGroupCode", "cutOffCardPostingFlag": true, "addValueDay": 0, "trnRewardGroupCode": "trnRewardGroupCode", "acqCommissionTrnGroupCode": "acqCommissionTrnGroupCode", "acqLoyaltyTrnGroupCode": "acqLoyaltyTrnGroupCode", "acqAccTrnGroupCode": "acqAccTrnGroupCode", "acqRiskyTrnFlag": true, "trnPermGroupCode": "trnPermGroupCode", "cashFeeChargeFlag": true, "prepaidFlag": true, "discountFlag": true, "trnFeeGroupCode": "trnFeeGroupCode", "trnLimitationGroupCode": "trnLimitationGroupCode", "accountingGroupCode": "accountingGroupCode", "closingMatrixId": "closingMatrixId", "rewardEffectedSegmentGroup": "rewardEffectedSegmentGroup", "installingMatrixId": "installingMatrixId", "inflationFlag": true, "manualClosingMatrixId": "manualClosingMatrixId", "deferringFlag": true, "taxIncludeFlag": true } ] }
json
application/json

Platform operationsError codes