Reference data
Look up the reference data a card programme is configured against — products, codes and parameters.
getCardTypeByBin
Determines the card type (Credit, Debit, Prepaid, or None) for a given BIN (Bank Identification Number). Accepts GetCardTypeByBinRequest with the BIN string. Returns GetCardTypeByBinResponse containing CardType as CardDomainType enum. Uses _cache.GetBinOnusAll() to look up BIN definitions and resolves CardType using TryGetCardDomainType.
Headers
evrst-ptrnidCorrelation id for this request. Echo it in your own logs to trace the call through the platform.
getCardTypeByBin › Responses
Success
cardTypeCard Type — 0 None, 1 Credit, 2 Debit, 3 Prepaid
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.
Headers
evrst-ptrnidCorrelation id for this request. Echo it in your own logs to trace the call through the platform.
getProductByShadowCardNumber › Request Body
shadowCardNumberShadow Card Number - [Optional]
getProductByShadowCardNumber › Responses
Success
cardTypeCard Type — 0 None, 1 Credit, 2 Debit, 3 Prepaid
digitalAbilityDigital Ability
brandBrand - [Optional]
productNumberProduct Number - [Optional]
productNameProduct Name - [Optional]
productShortnameProduct Shortname - [Optional]
getAvailableCardStatusList
Retrieves a list of available card statuses for a given card identified by ShadowCardNumber. The method accepts GetAvailableCardStatusListRequest containing ShadowCardNumber and Channel. The response returns GetAvailableCardStatusListResponse with a list of GetAvailableCardStatusListResponseItem, each containing StatusCode, StatusDescription, ReasonCode, and ReasonDescription.
Headers
evrst-ptrnidCorrelation id for this request. Echo it in your own logs to trace the call through the platform.
getAvailableCardStatusList › Request Body
shadowCardNumberShadow Card Number - [Optional]
channelThree-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.
getAvailableCardStatusList › Responses
Success
List Of Status - [Optional]
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.
Headers
evrst-ptrnidCorrelation id for this request. Echo it in your own logs to trace the call through the platform.
getEmbossReasonSubDefByValidFlag › Responses
Success
Emboss Reason Sub Def List - [Optional]
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.
Headers
evrst-ptrnidCorrelation id for this request. Echo it in your own logs to trace the call through the platform.
getAvailableEmbossReasonList › Request Body
shadowCardNumberShadow Card Number - [Optional]
getAvailableEmbossReasonList › Responses
Success
Get Available Emboss Reason By Card Status Result - [Optional]
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.
Headers
evrst-ptrnidCorrelation id for this request. Echo it in your own logs to trace the call through the platform.
getMccGroupAll › Responses
Success
List Of Mcc Group - [Optional]
getTrnStatusAll
Retrieves all transaction statuses along with their codes, descriptions, and validity flags for core banking integration.
Headers
evrst-ptrnidCorrelation id for this request. Echo it in your own logs to trace the call through the platform.
getTrnStatusAll › Responses
Success
List Of Trn Status - [Optional]
getBinDomesticByBin
Service that lists local card information based on the provided BIN.
Headers
evrst-ptrnidCorrelation id for this request. Echo it in your own logs to trace the call through the platform.
getBinDomesticByBin › Responses
Success
validFlagValid Flag
acqFlagAcq Flag
bonusFlagBonus Flag
businessFlagBusiness Flag
preAuthDebitFlagPre Auth Debit Flag
binMinValueBin Min Value - [Optional]
binMaxValueBin Max Value - [Optional]
binDescriptionBin Description - [Optional]
processorBinProcessor Bin - [Optional]
issuerBankCodeIssuer Bank Code - [Optional]
cardTypeCard Type - [Optional]
cardBrandCard Brand - [Optional]
panLengthPan Length - [Optional]
rewardTypeReward Type - [Optional]
authenticationTypeAuthentication Type - [Optional]
loyaltyProgramLoyalty Program - [Optional]
binLengthBin Length - [Optional]
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.
Headers
evrst-ptrnidCorrelation id for this request. Echo it in your own logs to trace the call through the platform.
getApplicableProducts › Responses
Success
List Of Product - [Optional]
getMccDefinitionGroupbyMccMccdescription
Retrieves MCC definition groups by MCC and MCC description from the internal repository using _intRepository.GetMccDefinitionGroupbyMccMccdescription().
Headers
evrst-ptrnidCorrelation id for this request. Echo it in your own logs to trace the call through the platform.
getMccDefinitionGroupbyMccMccdescription › Responses
Success
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.
Headers
evrst-ptrnidCorrelation id for this request. Echo it in your own logs to trace the call through the platform.
getNetworkTypeDefByValidFlag › Responses
Success
Network Type Def List - [Optional]
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.
Headers
evrst-ptrnidCorrelation id for this request. Echo it in your own logs to trace the call through the platform.
getResponseCodeDefByValidFlag › Responses
Success
Response Code Def List - [Optional]
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.
Headers
evrst-ptrnidCorrelation id for this request. Echo it in your own logs to trace the call through the platform.
getResponseReasonCodeDefByValidFlag › Responses
Success
Response Reason Code Def List - [Optional]
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.
Headers
evrst-ptrnidCorrelation id for this request. Echo it in your own logs to trace the call through the platform.
getTrnCodeDefByValidFlag › Responses
Success
Trn Code Def List - [Optional]
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.
Headers
evrst-ptrnidCorrelation id for this request. Echo it in your own logs to trace the call through the platform.
getTrnCodeMatrixByValidFlag › Responses
Success
Trn Code Matrix List - [Optional]