Schemas
AccountStatusReq
timeStampRequest timestamp as a 64-bit integer. It is a non-nullable value on the contract, which is why the schema marks it required; an omitted value is carried downstream as zero rather than as absent. The facade does not check it.
transactionIDPart of an external account-status contract that this platform passes through; none of its fields is stored here.
dsTransIDPart of an external account-status contract that this platform passes through; none of its fields is stored here.
sourceSystemPart of an external account-status contract that this platform passes through; none of its fields is stored here.
versionPart of an external account-status contract that this platform passes through; none of its fields is stored here.
The cardholder the authentication is being run for.
The transaction being authenticated.
The device the transaction is being made from.
The merchant the transaction is being made at.
AccountStatusRes
timeStamptransactionIDmemberRefIDstatuschallengeTypelanguageriskValueversionThe outcome, as the downstream system words it.
AddToLegalFollowUpRequest
MainCustomerNumberMain customer number to place in legal follow-up. Must not be zero.
FollowupReasonReason for placing the customer in legal follow-up. Sent downstream unchanged; the facade does not check it.
BusinessKeyDefault — Business key stored against the legal follow-up record. Null or omitted is sent downstream as 0.
AddToLegalFollowUpResponse
isSuccessWhether the operation did what it was asked to. A false here arrives with HTTP 200, so it has to be read rather than inferred from the status.
responseTimeA 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.
errorCodeThe platform's own code for the error, and what to match on.
messageThe error in words. errorCode is the part to match on.
CardHolderData
cardExpiryDatecardHolderNameaddrMatchbillAddrCitybillAddrCountrybillAddrLine1billAddrLine2billAddrLine3billAddrPostCodeemailshipAddrCityshipAddrCountryshipAddrLine1shipAddrLine2shipAddrLine3shipAddrPostCodeCardLogData
cardRefNumberThe card reference, which identifies one issued card including its renewals. Returned by the create and listing operations alongside the shadow number.
shadowCardNumberThe 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.
maskedCardNumberThe card number with its middle digits masked, as the platform stores it. It is a display form, not a key: operations take the shadow number.
customerNumberThe 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.
logCodeWhat kind of log entry this is.
logCodeDescriptionThe description of logCode, carried alongside it for display. It is not a key: match on the code.
oldValueThe value before the change, as the log recorded it.
newValueThe value after the change, as the log recorded it.
cardLogDetailinsertChannelIdWhich channel created the row.
insertChannelDescriptionThe description of insertChannelId, carried alongside it for display. It is not a key: match on the code.
insertUserIdWho created the row, as the platform recorded it.
insertDateWhen the row was created.
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.
CardRestriction
restrictionCodeValues:
SA— purchaseNA— cashDN— domestic cashYD— international saleYN— international cashAT— ATMMO— mail orderEC— e-commerce, fully secureEN— e-commerce, half secureEX— e-commerce, not secureCLS— contactlessTA— instalmentPTH— pre-authorisationQC— quasi cashCB— POS cashbackCSB— cashbackTCS— POS cash advanceFA— bill paymentVG— tax paymentCEK— chequeFF— FastFundPPP— project sharing programme
restrictionCodeDescriptionThe description of restrictionCode, carried alongside it for display. It is not a key: match on the code.
restrictionPermissionIndicatorWhether the entry grants the capability or withholds it.
restrictionPermissionIndicatorDescriptionThe description of restrictionPermissionIndicator, carried alongside it for display. It is not a key: match on the code.
CardholderAccount
chAccAgeIndchAccDatechAccChangeIndchAccChangechAccPwChangeIndchAccPwChangeshipAddressUsageIndshipAddressUsagetxnActivityDaytxnActivityYearprovisionAttemptsDaynbPurchaseAccountsuspiciousAccActivityshipNameIndicatorpaymentAccIndpaymentAccAgeChangeCustomerLimitRequest
customerNumberThe customer whose limit changes.
newCustomerLimitThe limit to set. An absolute figure, not a delta — and it is what decides the direction, because this operation does not read one from the path.
cardProfileSetCodeRead-only — Declared on the request and not passed on.
CreateCustomerAddressData
addressTypeMust be a defined address type.
Values:
RA— homeAL— businessEA— employerOO— alternativeWA— previousSW— SWIFTSS— SWIFT name and addressMR— Mernis, registeredMS— Mernis, stated
Not set is --.
addressTextFull address text.
isDefaultExactly one address in the list must carry it.
isCardAddressAt most one address in the list may carry it.
isConfirmedMarks the address as approved.
customerNumberIgnored — Overwritten with the customer number the service allocates.
addressIdIgnored — The stored address identifier is the record identifier the service allocates.
countryIdNotNull — When supplied it must be a defined country. It is mandatory whenever cityId is supplied.
industrialZoneIdIndustrial Zone Identifier
industrialZoneNamecityIdDependent · NotNull — Requires countryId, and the city must be defined for that country.
cityNameDependent — When cityId and countryId are both supplied it must equal the defined name of that city.
countyIdCounty Identifier, see County_Def table
countyNameCounty Name, see County_Def table
townIdTown Identifier, see Town_Def table
townNameTown Name, see Town_Def table
villageIdVillage Identifier, see Village_Def table
villageNameVillage Name, see Village_Def table
districtIdDistrict Identifier, see District_Def table
districtNameDistrict Name, see District_Def table
streetIdStreet Identifier, see Street_Def table
streetNameStreet Name, see Street_Def table
siteNameAddress Site Name
buildingIdBuilding Identifier
buildingNamebuildingNumberbuildingEntranceBuilding Entrance Number
flatNumberapartmentNumberstateIdState Identifier
stateNameThe state or province of the address.
zipCodeThe post code of the address.
poBoxNumberPost Box Number
CreateCustomerData
Core identity and type of the customer.
Conditional · NotNull — Mandatory when customerType is the retail, employee or lite-default type. For every other customer type it is not read.
Conditional · NotNull — Mandatory when customerType is not the retail, employee or lite-default type. For those types it is not read.
Segment codes copied onto the customer master.
When the block is absent every preference takes its own default.
Ignored — The integration layer does not forward this block, so the credit and cash limits are always created as zero.
CreateCustomerEmailData
eMailAddressNotNull · InvalidEmailAddress — Mandatory although the schema marks it optional, and it must parse as an e-mail address.
isConfirmedMarks the address as approved.
customerNumberIgnored — Overwritten with the customer number the service allocates.
CreateCustomerFirmData
firmNameRegistered name of the firm.
authorityCustomerNumberCustomer number of the employee responsible for the firm. It is not checked against an existing customer.
firmCustomerTypeMandatory although the schema marks it optional. It is not checked against a definition table.
firmNumberStored on the customer master as well as the firm record.
taxNumberStored on the customer master.
taxOfficeStored on the customer master.
embossFirmNameFirm Name On Card
tradeRegistrationNumberTrading Registration Number
tradeRegistrationDateTrading Registration Date
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.
tradeRegistrationOfficeTrading Registration Office
foundationDateCorporate Foundation Date
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.
authorityNameCorporate Responsable Employee Full Name
authorityGsmNumberCorporate Responsable Employee Mobile Number
authorityMailAddressCorporate Responsable Employee E-Mail Address
CreateCustomerGsmData
gsmCountryIdCountry code. It must not be negative and must not exceed four digits.
gsmAreaCodeArea code. It must not be negative and must not exceed four digits.
gsmNumberAt most fifteen characters, and it must contain at least one digit.
phoneNumberTextMandatory although the schema marks it optional. At most two hundred and fifty characters, and it must contain at least one digit.
isConfirmedMarks the mobile number as approved.
isContactNumberExactly one mobile number in the list must carry it.
customerNumberIgnored — Overwritten with the customer number the service allocates.
confirmDateGsm Approve Date
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.
CreateCustomerLimitData
limitOptional · Ignored — Not forwarded by the integration layer. The customer is always created with a zero credit limit.
cashLimitOptional · Ignored — Not forwarded by the integration layer. The customer is always created with a zero cash advance limit.
CreateCustomerMainData
firmCustomerFlagStored as given. It does not choose between the persona and corporate branches; customerType does.
customerTypeMust be a defined customer type. It decides whether persona or corporate is required. Overwritten with the lite default when isLite is true.
Values:
1— corporate2— individual3— employee4— sole proprietorship
Not set is N.
customerNumberWhen absent the service allocates the next number from its customer sequence.
personIdDefaults to the resulting customer number.
externalCustomerNumberDefaults to the resulting customer number.
accountingCustomerTypeNotNull — When supplied it must be a defined accounting customer type.
Values:
1— corporate2— individual3— employee
creditCustomerTypeNotNull — When supplied it must be a defined credit customer type.
Values:
S— standardV— VIPP— VIP platinum
branchCodeDefaults to zero.
isLiteDefault — Defaults to false. True requires tenantId and puts the request through the lite acceptance rules.
tenantIdConditional · NotNullOrWhiteSpace — Required when isLite is true, and must match a defined tenant.
CreateCustomerPersonalData
nameGiven name.
surnameFamily name.
birthDateDate of birth.
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.
citizenshipNumberLengthNotEquals — When supplied it must be exactly eleven characters, and it must not already belong to a valid customer.
residenceTypeNotNull — When supplied it must be a defined residence type. Defaults to domestic residence.
Values:
I— resident in TurkeyD— resident abroad
disabledFlagDefault — Defaults to false when the persona block is absent.
middleNameCustomer Middle Name
birthPlaceCustomer Place Of Birth
fatherNameCustomer Father's Name
motherNameCustomer Mother's Name
maritalStatusCustomer Marital Status Code
Values:
1— singleEV— married3— divorced4— widowed2— other0— unknown
educationStatusEducational Status Code
Values:
1— literate2— primary4— secondary5— two-year college6— university7— master's8— doctorate
nationalityNationality Code, see Nationality_Def Table
identityTypeIdentity Type Code, see Identity_Type_Def table
Values:
1— identity cardPT— identity card2— driver's licenceEH— driver's permit3— passportPS— passportKK— TRNC identity cardMK— blue cardIT— residence permitAA— an identity document listed in the annex to the European AgreementDG— another type of identity0— unknown
identityNumbertitleCustomer Title
genderGender Type, E=Male, K=Female, X=Unknown
Values:
E— maleK— femaleX— unknown
occupationOccupation Type, see Occupation_Def table
workplaceNameCustomer Workplace Name
businessTitleCustomer Business Title
CreateCustomerPhoneData
phoneTypeMust be a defined phone type of at most two characters.
Values:
1— telephone2— fax0— unknown
phoneCountryIdMandatory although the schema marks it optional. It must be a defined country and must not exceed four digits.
phoneAreaCodeMandatory although the schema marks it optional. At most ten characters, and it must contain at least one digit.
phoneNumberMandatory although the schema marks it optional. At most twenty characters, and it must contain at least one digit.
phoneNumberTextMandatory although the schema marks it optional. At most fifty characters, and it must contain at least one digit.
isContactNumberExactly one phone number in the list must carry it.
customerNumberIgnored — Overwritten with the customer number the service allocates.
CreateCustomerPreferenceData
sendWarningLetterFlagDefault — Defaults to false.
communicationTypeNotNull — When supplied it must be a defined communication language. Defaults to Turkish.
Values:
1— dial-up2— ADSL3— GSM4— GPRS
autoLimitIncreaseFlagDefault — Defaults to false.
statementPostingFlagDefault — Defaults to false.
statementSmsSendFlagDefault — Defaults to false.
statementEMailSendFlagDefault — Defaults to false.
earnRewardFlagDefault — Defaults to true, unlike the other preference flags.
sensitiveDataPermissionFlagDefault — Defaults to false.
customLimitationFlagDefault — Defaults to false.
CreateCustomerRequest
channelThree-digit code identifying the channel on behalf of which the request is made (e.g. 002 for Internet). Mandatory in every request. Used for entitlement checks, limit enforcement and audit logging. Channel codes are managed through configuration parameters and may change over time. Refer to the Channels page for the current list of valid codes.
Customer data. The main block inside it is mandatory as well.
Address, GSM, e-mail and phone records created alongside the customer. Each list is validated up front and written after the customer master row.
CreateCustomerResponse
customerNumberThe 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.
personIdThe person behind the customer record.
CreateCustomerSegmentData
behavioralSegmentCodeNotNull — When supplied it must be a defined behavioural segment.
valueSegmentCodeNotNull — When supplied it must be a defined value segment. Overwritten with the lite default when isLite is true.
Values:
02— standard03— private10— prestige07— prestige+09— FES99— Islamic
Not set is N.
valueSubSegmentCodeNotNull — When supplied it must be a defined value sub-segment. Cleared when isLite is true.
Values:
10— private20— private plus30— investor40— other
CreateFollowUpByMainCustomerNumberRequest
channelThree-digit code identifying the channel on behalf of which the request is made (e.g. 002 for Internet). Mandatory in every request. Used for entitlement checks, limit enforcement and audit logging. Channel codes are managed through configuration parameters and may change over time. Refer to the Channels page for the current list of valid codes.
mainCustomerNumberMain customer number whose credit cards are closed and which is queued for legal follow-up. The null check cannot fail on this non-nullable integer, so 0 passes it and fails the customer lookup instead.
CreditCardLogData
cardRefNumberThe card reference, which identifies one issued card including its renewals. Returned by the create and listing operations alongside the shadow number.
shadowCardNumberThe 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.
maskedCardNumberThe card number with its middle digits masked, as the platform stores it. It is a display form, not a key: operations take the shadow number.
customerNumberThe 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.
logCodeWhat kind of log entry this is.
logCodeDescriptionThe description of logCode, carried alongside it for display. It is not a key: match on the code.
oldValueThe value before the change, as the log recorded it.
newValueThe value after the change, as the log recorded it.
cardLogDetailinsertChannelIdWhich channel created the row.
insertChannelDescriptionThe description of insertChannelId, carried alongside it for display. It is not a key: match on the code.
insertUserIdWho created the row, as the platform recorded it.
insertDateWhen the row was created.
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.
CreditCardStatementCutoffItem
customerNumberThe 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.
statementDateA 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.
capitalAmountpurchaseInterestAmountcashInterestAmountpurchaseDueInterestAmountcashDueInterestAmountotherFeeAmountcashFeeAmountcardFeeAmountinterestKkdfAmountinterestBsmvAmountfeeBsmvAmountcashInstallmentProfitAmountcardRefNumberThe card reference, which identifies one issued card including its renewals. Returned by the create and listing operations alongside the shadow number.
shadowCardNumberThe 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.
CreditTransactionList
acqRefNumberauthorizationMatchStatusWhether the clearing record was matched to an authorisation.
authorizationNumberThe authorisation code the issuer returned when the transaction was approved. Six characters, from the scheme.
billingAmountbillingCurrencybkmUniqueMerchantIdThe merchant's identifier at BKM, the domestic switch.
campaignCodeAcqcampaignCodeIsschannelTypeDescriptionclearingChannelclearingDateA 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.
clearingNumbercustomerNumberListdisplayAtChannelsearnedRewardBankearnedRewardCampaignAcqearnedRewardCampaignIssearnedRewardMerchantembossNameThe name embossed on the card.
eodDateA 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.
invoiceNumberinstallmentAmountWhat each instalment comes to.
installmentCountHow many instalments the plan has.
installmentNumberWhich instalment this is.
isChipFlagWhether the card's chip was used rather than the stripe.
localAmountThe amount converted into the bank's own currency.
localCurrencymainCardRefNumberThe card reference of the main card. On a supplementary card this is the card it hangs from; on a main card it is the card's own reference.
mainCustomerNumberThe main customer of a corporate relationship, as a number. The employees and supplementary holders under it carry their own customerNumber.
maskedCardNumberThe card number with its middle digits masked, as the platform stores it. It is a display form, not a key: operations take the shadow number.
matchStatusDescriptionmccDescriptionmerchantAmexIdmerchantCitymerchantCountryCodeWhere the merchant is, as a country code.
merchantNameThe merchant's name as it reached the platform from the scheme.
networkDescriptionThe network's name, for display.
offlineFlagWhether the terminal approved the transaction without asking the issuer.
panEntryModeHow the card was read at the terminal — chip, stripe, contactless, keyed, or stored on file. The scheme's own code.
pinEntryModepinUsageWhether the transaction was authorised with a PIN.
responseCodeDescriptionresponseReasonCodeDescriptionproductrefUtidThe transaction this one refers to — the original, for a reversal or a correction.
requestDateA 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.
rewardTypeDescriptionrrnThe retrieval reference number — the card scheme's handle for the transaction, and what a bank quotes when asking the scheme about it.
settlementAmountThe amount as it settles between the scheme and the bank.
settlementCurrencyterminalTypeWhat kind of terminal that was — POS, ATM, or another.
terminalDescriptionThe description of terminalType, carried alongside it for display. It is not a key: match on the code.
terminalNumberThe terminal the transaction was made at.
trnAmountThe amount of the transaction, in its own currency.
trnCodeMatrixDesctrnCodeWhat kind of transaction this is, as the platform's own code.
trnCodeDescriptionThe description of trnCode, carried alongside it for display. It is not a key: match on the code.
trnCurrencytrnDateA 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.
trnDescriptionThe description of trnCode, carried alongside it for display. It is not a key: match on the code.
trnOriginutidCustomerAddress
validFlagWhether the row is live. The platform sets it.
recordIdThe identifier of the row the operation created or acted on, returned so a later call can name it.
personIdThe person behind the customer record.
customerNumberThe 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.
addressTypeValues:
RA— homeAL— businessEA— employerOO— alternativeWA— previousSW— SWIFTSS— SWIFT name and addressMR— Mernis, registeredMS— Mernis, stated
Not set is --.
addressIdcountryIdindustrialZoneIdindustrialZoneNamecityIdcityNamecountyIdcountyNametownshipIdtownshipNamevillageIdvillageNamedistrictIddistrictNamestreetIdstreetNamesiteNamebuildingIdbuildingNamebuildingNumberbuildingEntranceflatNoapartmentNumberstateIdstateNameThe state or province of the address.
zipCodeThe post code of the address.
poBoxNoaddressTextisDefaultisCardAddressisConfirmedWhether the record has been confirmed.
channelCodeWhich channel, as its code.
companyCodeWhich communication company the record belongs to.
enteringChannelCodeWhich channel the record was entered through.
CustomerCommunicationData
ListHasNoItem — When the property is present it must hold at least one address.
ListHasNoItem — When the property is present it must hold at least one mobile number.
ListHasNoItem — When the property is present it must hold at least one e-mail address.
ListHasNoItem — When the property is present it must hold at least one phone number.
CustomerEMail
validFlagWhether the row is live. The platform sets it.
recordIdThe identifier of the row the operation created or acted on, returned so a later call can name it.
personIdThe person behind the customer record.
customerNumberThe 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.
eMailIdeMailAddressisConfirmedWhether the record has been confirmed.
confirmDateA 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.
channelCodeWhich channel, as its code.
companyCodeWhich communication company the record belongs to.
enteringChannelCodeWhich channel the record was entered through.
CustomerFirmInfo
validFlagWhether the row is live. The platform sets it.
customerNumberThe 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.
authorityCustomerNumberfirmNameembossFirmNamefirmCustomerTypetradeRegistrationNumbertradeRegistrationDateA 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.
foundationDateA 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.
tradeRegistrationOfficeauthorityNameauthorityGsmNumberauthorityMailAddressCustomerGsm
validFlagWhether the row is live. The platform sets it.
recordIdThe identifier of the row the operation created or acted on, returned so a later call can name it.
personIdThe person behind the customer record.
gsmCountryIdgsmAreaCodecustomerNumberThe 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.
gsmIdgsmNumberphoneNumberTextisConfirmedWhether the record has been confirmed.
confirmDateA 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.
confirmTyperejectDateA 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.
isContactNumberchannelCodeWhich channel, as its code.
companyCodeWhich communication company the record belongs to.
enteringChannelCodeWhich channel the record was entered through.
CustomerMaster
insertDateWhen the row was created.
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.
validFlagWhether the row is live. The platform sets it.
customerNumberThe 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.
personIdThe person behind the customer record.
externalCustomerNumberfirmCustomerFlagbranchCodelimitcashLimitsendWarningLetterFlagactivityCountoverlimitFlagoverlimitCounterdeficientPaymentCounterautoLimitIncreaseFlagblockedAccountFlagdisabledFlagstatementPostingFlagWhether the statement is posted on paper.
statementSmsSendFlagstatementeMailSendFlagearnRewardFlagsensitiveDataPermissionFlagcustomLimitationFlaginsertUserIdWho created the row, as the platform recorded it.
insertTokenIdThe session the row was created under.
updateDateWhen the row was last changed.
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.
updateUserIdWho last changed the row.
updateTokenIdThe session that last changed it.
firmNumbertaxNumberThe customer's tax number, as the customer record holds it.
taxOfficecitizenshipNumberoldLimitlastLimitUpdateDateA 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.
proceedingStatusCodeValues:
N— normalI— administrative follow-upK— legal follow-upZ— loss recognised
proceedingStatusUpdateDateA 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.
prevProceedingStatusCodeValues:
N— normalI— administrative follow-upK— legal follow-upZ— loss recognised
delinquencyStatusValues:
N— normalD— delinquent for the periodG— delinquent
delinquencyPeriodHow many periods the account has been in arrears.
delinquencyStartDateA 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.
delinquencyChangeDateA 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.
activityStatusValues:
A— activeI— inactiveN— never activated
annualDeficientPaymentCountercustomerTypeValues:
1— corporate2— individual3— employee4— sole proprietorship
Not set is N.
accountingCustomerTypeValues:
1— corporate2— individual3— employee
creditCustomerTypeValues:
S— standardV— VIPP— VIP platinum
behavioralSegmentCodevalueSubSegmentCodeValues:
10— private20— private plus30— investor40— other
valueSegmentCodeValues:
02— standard03— private10— prestige07— prestige+09— FES99— Islamic
Not set is N.
residenceTypeValues:
I— resident in TurkeyD— resident abroad
communicationTypeValues:
1— dial-up2— ADSL3— GSM4— GPRS
statusCodeValues:
A— validB— pendingC— stolenD— cancelled by the bankF— fraudG— temporarily blockedI— cancelledL— lostM— cancelled by the customerT— corporate dummy
statusUpdateDateA 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.
prevStatusCodeprevStatusUpdateDateA 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.
limitAllocationIncomefirstTransactionDateA 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.
firstCardIssueDateA 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.
kkbStatusCodekkbStatusUpdateDateA 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.
limitStatuslimitStatusUpdateDateA 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.
CustomerPersonalInfo
validFlagWhether the row is live. The platform sets it.
personIdThe person behind the customer record.
customerNumberThe 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.
birthDateA 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.
namemiddleNamesurnamebirthPlacefatherNamemotherNamemaritalStatusValues:
1— singleEV— married3— divorced4— widowed2— other0— unknown
educationStatusValues:
1— literate2— primary4— secondary5— two-year college6— university7— master's8— doctorate
nationalityidentityTypeValues:
1— identity cardPT— identity card2— driver's licenceEH— driver's permit3— passportPS— passportKK— TRNC identity cardMK— blue cardIT— residence permitAA— an identity document listed in the annex to the European AgreementDG— another type of identity0— unknown
identityNumbertitlegenderValues:
E— maleK— femaleX— unknown
occupationworkplaceNamebusinessTitleCustomerPhone
validFlagWhether the row is live. The platform sets it.
recordIdThe identifier of the row the operation created or acted on, returned so a later call can name it.
personIdThe person behind the customer record.
customerNumberThe 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.
phoneTypeValues:
1— telephone2— fax0— unknown
phoneIdaddressIdphoneCountryIdphoneAreaCodephoneNumberphoneNumberTextaddressTypeValues:
RA— homeAL— businessEA— employerOO— alternativeWA— previousSW— SWIFTSS— SWIFT name and addressMR— Mernis, registeredMS— Mernis, stated
Not set is --.
isContactNumberchannelCodeWhich channel, as its code.
companyCodeWhich communication company the record belongs to.
enteringChannelCodeWhich channel the record was entered through.
DecryptDataBlockRequest
encryptDataBlockEncrypted data block to decrypt, as returned by the encrypt operation in its encryptedDataBlock field. Rejected when null, empty or whitespace. The facade applies no length or format check and forwards the value as given.
A cipher block rather than stored data; no column behind it.
EmbossReasonSubDef
validFlagWhether the row is live. The platform sets it.
useFlagembossReasonSubCodeValues:
BRK— broken cardCHF— damaged chipEXP— renewal at maturityFRD— fraudMGF— magnetic stripe errorNSU— name updateOTH— otherEXO— bulk renewal at maturityLST— lost cardSTL— stolen card
Not set is ---.
embossReasonSubDescThe description of embossReasonSubCode, carried alongside it for display. It is not a key: match on the code.
EncryptedAccountNumber
cryptoAlgorithmkeyIDencDataError
transactionIdThe platform's identifier for this call, for tracing it in the logs.
errorCodeThe platform's own code for the error, and what to match on.
descriptionThe error in words. errorCode is the part to match on; this is for a log or a screen.
messageThe error in words. errorCode is the part to match on.
messageFormatThe message before its arguments were substituted in, which is what groups two errors that differ only by their values.
argumentsThe values substituted into messageFormat.
propertyNameWhich field of the request the error is about.
detailMore about the error than message carries, where there is more.
The individual problems, where one error stands for several.
isTechnicalErrorWhether the failure is the platform's rather than the request's. A technical error is worth retrying; a business one is not.
exceptionTypeThe platform's internal exception class. Useful in a support conversation and not something to match on.
ExecuteCampaignTransactionRequest
shadowCardNumberThe card the campaign transaction is posted to.
trnCodeMatrixIdThe transaction code matrix entry to post under. Must be one of the entries listed in the platform's campaign transaction code parameters; any other value is refused, whatever the transaction code matrix itself allows.
amountThe amount, in minor units. The facade divides it by 100 before doing anything else, so it must be sent as a whole number of the currency's smallest unit. It is then checked against the campaign minimum and maximum held in the platform's parameters: it must be strictly greater than the minimum and no greater than the maximum.
requestChannelThe channel the transaction is posted from. Must be a channel the platform defines; an unrecognised value resolves to the undefined channel and is refused.
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.
currencyDefault — The transaction currency. Left out or blank, the facade forces the local currency code 949.
No column of this name exists behind this API. currencyCode, which does, is three characters.
descriptionDefault — The transaction description. Left out or blank, the facade fills it from the campaign parameter that matches trnCodeMatrixId.
ExecuteCampaignTransactionResponse
trnIdThe platform's identifier for the transaction row.
utidGetApplicableProductsRequest
queryDateIgnored — 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.
GetApplicableProductsResponseItem
virtualAbilitydigitalAbilityWhether the product can be issued as a digital card.
contactlessAbilityemvAbilityisNoNameproductNumberThe card product the card is issued on. Defined in the parameter tables; getCardProductList returns the ones a tenant may use.
productNameThe card product's full name.
productShortNameThe card product's short name, for a list or a statement line.
brandWhich scheme the card is issued on.
typeCodesegmentCodebinThe bank identification number — the leading digits of the card number that name the issuer and the product range.
groupCodeclassCodetypeCodeDetailtenantIdlistOfApplicableChannelGetAssetByShadowCardNumberRequest
shadowCardNumberThe card whose asset record is read.
GetAssetByShadowCardNumberResponse
customerNumberThe 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.
supplementaryCardWhether this is a supplementary card rather than a main one.
mainCustomerNumberThe main customer of a corporate relationship, as a number. The employees and supplementary holders under it carry their own customerNumber.
insertDateWhen the row was created.
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.
serviceDomainIdValues:
01— credit02— debit03— prepaid
ownerNameThe cardholder's first name, as the customer record holds it.
maskedCardNumberThe card number with its middle digits masked, as the platform stores it. It is a display form, not a key: operations take the shadow number.
ownerSecondNameThe cardholder's middle name, where there is one.
ownerSurnameThe cardholder's surname, as the customer record holds it.
psnbinThe bank identification number — the leading digits of the card number that name the issuer and the product range.
cardStatusCodeValues:
A— validB— pendingC— stolenD— cancelled by the bankF— fraudG— temporarily blockedI— cancelledL— lostM— cancelled by the customerT— corporate dummy
cardStatusReasonCodeproductNumberThe card product the card is issued on. Defined in the parameter tables; getCardProductList returns the ones a tenant may use.
cardRefNumberThe card reference, which identifies one issued card including its renewals. Returned by the create and listing operations alongside the shadow number.
maskedPanAlternativeA second masked form of the card number, masked differently for a channel that needs other digits.
mainCardRefNumberThe card reference of the main card. On a supplementary card this is the card it hangs from; on a main card it is the card's own reference.
ownerSearchNameThe cardholder's name normalised for searching — accents and case removed. It is not the name on the card.
insertUserIdWho created the row, as the platform recorded it.
GetAuthorizationListByBegindateEnddateParam
AuthStatusOnly 1 returns rows. The query compares this value against a fixed constant rather than against a column, so any other value returns an empty list while leaving it out returns everything.
BeginDateRequired — Start of the transaction date range. Inclusive. Nothing validates it, but omitting it returns nothing, because the query compares against it directly rather than treating it as absent.
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.
EndDateRequired — End of the transaction date range. Inclusive. Omitting it returns nothing, for the same reason as BeginDate.
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.
MaxAmountUpper bound on the local amount.
MinAmountLower bound on the local amount.
NetworkTypeNarrows the list to one source network.
ResponseCodeNarrows the list to one response code. It is applied to the authorisation and non-financial sources only; on the daily pool source it is compared against a fixed approved constant instead, so any other value drops that source entirely.
ResponseReasonCodeNarrows the list to one response reason code, with the same exception on the daily pool source as ResponseCode.
ShadowCardNumberRequired — The card whose authorisations are listed. The document leaves this optional and nothing validates it, but all three queries behind the view match it exactly, so omitting it returns nothing.
TrnCodeMatrixIdNarrows the list to one transaction code matrix entry.
GetAuthorizationListByBegindateEnddateRequest
The search criteria. The repository throws when this is missing, so it must be sent.
GetAuthorizationListByBegindateEnddateResult
AuthorizationMatchStatusWhether the clearing record was matched to an authorisation.
AuthorizationNumberThe authorisation code the issuer returned when the transaction was approved. Six characters, from the scheme.
BkmUniqueMerchantIdThe merchant's identifier at BKM, the domestic switch.
CardRefNumberThe card reference, which identifies one issued card including its renewals. Returned by the create and listing operations alongside the shadow number.
CardSeqNumberWhich chip on the card was used, where a customer holds more than one card on the same number.
ChannelTypeDescriptionCustomerCustomerNumberThe 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.
IsChipFlagWhether the card's chip was used rather than the stripe.
LocalAmountThe amount converted into the bank's own currency.
LocalCurrencyDescriptionMainCustomerNumberThe main customer of a corporate relationship, as a number. The employees and supplementary holders under it carry their own customerNumber.
MaskedCardNumberThe card number with its middle digits masked, as the platform stores it. It is a display form, not a key.
MatchStatusDescriptionThat matching state in words.
MccDescriptionMerchantCountryCodeWhere the merchant is, as a country code.
MerchantNameThe merchant's name as it reached the platform from the scheme.
NetworkTypeDescriptionOfflineFlagWhether the terminal approved the transaction without asking the issuer.
OpenReceiptFormIsEnabledPanEntryModeHow the card was read at the terminal — chip, stripe, contactless, keyed, or stored on file. The scheme's own code.
PinUsageWhether the transaction was authorised with a PIN.
PreAuthorizationStatusProductNameThe card product's full name.
ResponseCodeDescriptionResponseReasonCodeDescriptionRrnThe retrieval reference number — the card scheme's handle for the transaction, and what a bank quotes when asking the scheme about it.
SettlementAmountThe amount as it settles between the scheme and the bank.
SettlementCurrencyDescriptionSuccessCodeTerminalNumberThe terminal the transaction was made at.
TerminalTypeWhat kind of terminal that was — POS, ATM, or another.
TransactionDateA 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.
TransactionDescriptionThe transaction in words, as it reached the platform.
TransactionTimeTrnAmountThe amount of the transaction, in its own currency.
TrnCodeMatrixDescriptionTrnCurrencyDescriptionTrnStatusDescriptionThe transaction's state in words.
UtidThe unique transaction identifier the platform gives a transaction, and the handle every later operation on it takes. Returned by the transaction listings.
GetAutoPaymentQueueParam
dueDateThe due date to queue for. Matched as a whole day, so any time component is ignored, and matched exactly — this is a single day, not the start of a range.
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.
endRowNoLast row of the window. Inclusive. Nothing caps the width of the window, and the response carries no total, so there is no way to tell from one call whether more rows remain.
startRowNoFirst row of the window, counting from one. Inclusive. Nothing validates it against endRowNo; a start beyond the end simply returns nothing.
GetAutoPaymentQueueRequest
The due date and the row window. The operation dereferences this without a null check, so it must be sent.
GetAutoPaymentQueueResult
customerNumberThe 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.
dailyPaymentAmountdueDateA 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.
dueOptionDateA 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.
mainCardRefNumberThe card reference of the main card. On a supplementary card this is the card it hangs from; on a main card it is the card's own reference.
maskedCardNumberThe card number with its middle digits masked, as the platform stores it. It is a display form, not a key: operations take the shadow number.
paymentAccountBranchCodepaymentAccountNumberpaymentAccountOwnerNamepaymentAccountSuffixpaymentTotalCurrentpaymentTypeWhat kind of payment this is.
remainingMinimumPaymentAmountremainingAmountshadowCardNumberThe 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.
statementCurrencyCodestatementDateA 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.
statementMinAmountThe least that may be paid against the statement.
statementTotalAmountWhat the statement comes to.
GetAvailableEmbossReasonByCardStatusResult
embossReasonSubCodeValues:
BRK— broken cardCHF— damaged chipEXP— renewal at maturityFRD— fraudMGF— magnetic stripe errorNSU— name updateOTH— otherEXO— bulk renewal at maturityLST— lost cardSTL— stolen card
Not set is ---.
embossReasonSubDescThe description of embossReasonSubCode, carried alongside it for display. It is not a key: match on the code.
statusCodeValues:
A— validB— pendingC— stolenD— cancelled by the bankF— fraudG— temporarily blockedI— cancelledL— lostM— cancelled by the customerT— corporate dummy
statusReasonCodeWhy the status is what it is.
GetAvailableEmbossReasonListRequest
shadowCardNumberShadow card number whose permitted emboss reasons are listed. The facade does not validate it and passes it straight to the CIS online service.
GetBasicCardInformationByPanRequest
panThe card's PAN, in the clear.
A card number is not stored by these services; the platform keeps a shadow card number instead.
GetBasicCardInformationByPanResponse
customerNumberThe 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.
binThe bank identification number — the leading digits of the card number that name the issuer and the product range.
psncardTypeValues:
C— creditD— debitP— prepaid
encryptedCardNumberThe card number encrypted under the platform's key, which is how it travels between services.
maskedCardNumberThe card number with its middle digits masked, as the platform stores it. It is a display form, not a key: operations take the shadow number.
hashCardNumberA one-way hash of the card number, for matching two records without carrying the number.
shadowCardNumberThe 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.
GetBinDomesticByBinRequest
binCard 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.
GetBinDomesticByBinResponse
validFlagWhether the row is live. The platform sets it.
acqFlagbonusFlagbusinessFlagpreAuthDebitFlagbinMinValuebinMaxValuebinDescriptionprocessorBinissuerBankCodecardTypeValues:
C— creditD— debitP— prepaid
cardBrandWhich scheme the card is issued on.
panLengthrewardTypeWhich kind of reward was earned.
authenticationTypeloyaltyProgrambinLengthGetCardByCardNumberRequest
cardNumberThe card's PAN, in the clear.
panSequenceNumberThe PAN sequence number, where one card number carries more than one card.
Passed to the service that resolves the card; no column behind this API holds it.
GetCardByCardNumberResponse
customerNumberThe 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.
expiryDateA 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.
mainCustomerNumberThe main customer of a corporate relationship, as a number. The employees and supplementary holders under it carry their own customerNumber.
hashCardNumberA one-way hash of the card number, for matching two records without carrying the number.
encryptedCardNumberThe card number encrypted under the platform's key, which is how it travels between services.
maskedCardNumberThe card number with its middle digits masked, as the platform stores it. It is a display form, not a key: operations take the shadow number.
binThe bank identification number — the leading digits of the card number that name the issuer and the product range.
shadowCardNumberThe 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.
cardSeqNumberWhich chip on the card was used, where a customer holds more than one card on the same number.
statusCodeValues:
A— validB— pendingC— stolenD— cancelled by the bankF— fraudG— temporarily blockedI— cancelledL— lostM— cancelled by the customerT— corporate dummy
statusReasonCodeWhy the status is what it is.
cardNumbercardTypeValues:
C— creditD— debitP— prepaid
productNumberThe card product the card is issued on. Defined in the parameter tables; getCardProductList returns the ones a tenant may use.
cardRefNumberThe card reference, which identifies one issued card including its renewals. Returned by the create and listing operations alongside the shadow number.
maskedPanAlternativeA second masked form of the card number, masked differently for a channel that needs other digits.
mainCardRefNumberThe card reference of the main card. On a supplementary card this is the card it hangs from; on a main card it is the card's own reference.
ownerSearchNameThe cardholder's name normalised for searching — accents and case removed. It is not the name on the card.
GetCardByShadowCardNumberRequest
channelThree-digit code identifying the channel on behalf of which the request is made (e.g. 002 for Internet). Mandatory in every request. Used for entitlement checks, limit enforcement and audit logging. Channel codes are managed through configuration parameters and may change over time. Refer to the Channels page for the current list of valid codes.
shadowCardNumberThe card to read.
GetCardByShadowCardNumberResponse
customerNumberThe 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.
expiryDateA 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.
mainCustomerNumberThe main customer of a corporate relationship, as a number. The employees and supplementary holders under it carry their own customerNumber.
hashCardNumberA one-way hash of the card number, for matching two records without carrying the number.
encryptedCardNumberThe card number encrypted under the platform's key, which is how it travels between services.
maskedCardNumberThe card number with its middle digits masked, as the platform stores it. It is a display form, not a key: operations take the shadow number.
binThe bank identification number — the leading digits of the card number that name the issuer and the product range.
shadowCardNumberThe 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.
cardSeqNumberWhich chip on the card was used, where a customer holds more than one card on the same number.
statusCodeValues:
A— validB— pendingC— stolenD— cancelled by the bankF— fraudG— temporarily blockedI— cancelledL— lostM— cancelled by the customerT— corporate dummy
statusReasonCodeWhy the status is what it is.
cardNumbercardTypeValues:
C— creditD— debitP— prepaid
productNumberThe card product the card is issued on. Defined in the parameter tables; getCardProductList returns the ones a tenant may use.
cardRefNumberThe card reference, which identifies one issued card including its renewals. Returned by the create and listing operations alongside the shadow number.
maskedPanAlternativeA second masked form of the card number, masked differently for a channel that needs other digits.
mainCardRefNumberThe card reference of the main card. On a supplementary card this is the card it hangs from; on a main card it is the card's own reference.
ownerSearchNameThe cardholder's name normalised for searching — accents and case removed. It is not the name on the card.
maskedPanSmartGetCardInfoByClearPanRequest
clearPanThe card's PAN, in the clear.
A card number is not stored by these services; the platform keeps a shadow card number instead.
GetCardInfoByClearPanResponse
customerNumberThe 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.
expiryDateA 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.
mainCustomerNumberThe main customer of a corporate relationship, as a number. The employees and supplementary holders under it carry their own customerNumber.
hashCardNumberA one-way hash of the card number, for matching two records without carrying the number.
encryptedCardNumberThe card number encrypted under the platform's key, which is how it travels between services.
maskedCardNumberThe card number with its middle digits masked, as the platform stores it. It is a display form, not a key: operations take the shadow number.
binThe bank identification number — the leading digits of the card number that name the issuer and the product range.
shadowCardNumberThe 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.
cardSeqNumberWhich chip on the card was used, where a customer holds more than one card on the same number.
statusCodeValues:
A— validB— pendingC— stolenD— cancelled by the bankF— fraudG— temporarily blockedI— cancelledL— lostM— cancelled by the customerT— corporate dummy
statusReasonCodeWhy the status is what it is.
clearPancardTypeValues:
C— creditD— debitP— prepaid
productNumberThe card product the card is issued on. Defined in the parameter tables; getCardProductList returns the ones a tenant may use.
cardRefNumberThe card reference, which identifies one issued card including its renewals. Returned by the create and listing operations alongside the shadow number.
maskedPanAlternativeA second masked form of the card number, masked differently for a channel that needs other digits.
mainCardRefNumberThe card reference of the main card. On a supplementary card this is the card it hangs from; on a main card it is the card's own reference.
ownerSearchNameThe cardholder's name normalised for searching — accents and case removed. It is not the name on the card.
GetCardStatementCutoffRequest
insertDateThe statement date to report on. Compared as a date, so any time component is ignored. Nothing validates it; a date with no cut-off statement returns an empty list.
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.
shadowCardNumberNarrows the report to one card. Matched exactly.
mainCardRefNumberNarrows the report to one main card reference. Matched exactly.
customerNumberNarrows the report to one customer.
GetClearPanByShadowRequest
shadowCardNumberThe card whose PAN is read.
GetCreditCardLogDataListByShadowCardNumberRequest
startDateCanNotBeNullOrLessThanSqlMinValue — Start of the window matched against each log row's insert date. The window is inclusive at both ends and is compared as a full timestamp, not as a date.
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.
endDateCanNotBeNullOrLessThanSqlMinValue — End of the window matched against each log row's insert date. The window is inclusive at both ends and is compared as a full timestamp, not as a date.
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.
shadowCardNumberOne-of · NotNullOrWhiteSpace — Shadow card number to filter the log on. Either this or customerNumber must be supplied; when both are absent the failure is reported against both fields. An absent or empty value switches this filter off.
logCodeCard log code to filter on. An absent or empty value switches the filter off and returns every log code.
customerNumberOne-of · NotNull — Customer number to filter the log on. Either this or shadowCardNumber must be supplied. Zero counts as absent, both for the check and for the query, where it switches this filter off.
GetCreditTransactionListRequest
shadowCardNumberThe card whose transactions are listed. The document leaves this optional; the facade does not, and refuses a request without it.
transactiondatebeginStart of the transaction date range.
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.
transactiondateendEnd of the transaction date range.
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.
embossNameNarrows the list to transactions on a card carrying this emboss name.
Declared at 26 on the card master and 30 on the customer asset, so no single width is published. nameOnCard, which the services truncate to 26 before writing, is the field to send a name on.
maxAmountUpper bound on the transaction amount.
minAmountLower bound on the transaction amount.
sourceNetworkNarrows the list to one acquiring network.
trnCodeMatrixIdNarrows the list to one transaction code matrix entry.
trnCodeNarrows the list to one transaction code.
GetCustomerDetailRequest
channelThree-digit code identifying the channel on behalf of which the request is made (e.g. 002 for Internet). Mandatory in every request. Used for entitlement checks, limit enforcement and audit logging. Channel codes are managed through configuration parameters and may change over time. Refer to the Channels page for the current list of valid codes.
customerNumberCustomer to read. It is not checked for zero or a negative value.
getEmailDetailFalse leaves the e-mail list out of the response altogether.
getAddressDetailFalse leaves the address list out of the response altogether.
getPhoneDetailFalse leaves the phone list out of the response altogether.
getGsmDetailFalse leaves the mobile number list out of the response altogether.
commCompanyCodeRestricts the address, e-mail, mobile and phone lists to records carrying this company code. When absent the code mapped to channel is used, falling back to the platform default.
GetCustomerInfo
GetDbttransactionByCardrefCustomernumParam
AuthStatusOnly 0 returns rows. The query compares this value against a fixed constant rather than against a column, so any other value returns an empty list while leaving it out returns everything.
CardRefNumberNarrows the list to one card reference. Matched exactly. An empty string is treated as not sent.
CustomerNumberNarrows the list to one customer.
EmbossNameNarrows the list to cards carrying this emboss name. Matched exactly, not as a prefix or a pattern.
MaxAmountUpper bound on the billing amount.
MinAmountLower bound on the billing amount.
ShadowCardNumberNarrows the list to one card. Matched exactly. An empty string is treated as not sent.
SourceNetworkNarrows the list to one acquiring network.
TransactiondatebeginStart of the transaction date range. Inclusive.
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.
TransactiondateendEnd of the transaction date range. Inclusive.
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.
TrnCodeMatrixIdNarrows the list to one transaction code matrix entry. An empty string is treated as not sent.
GetDbttransactionByCardrefCustomernumRequest
The search criteria. The operation dereferences this without a null check, so it must be sent.
GetDbttransactionByCardrefCustomernumResult
IsChipFlagWhether the card's chip was used rather than the stripe.
AcqRefNumberAuthorizationMatchStatusWhether the clearing record was matched to an authorisation.
AuthorizationNumberThe authorisation code the issuer returned when the transaction was approved. Six characters, from the scheme.
BillingAmountBillingCurrencyBkmUniqueMerchantIdThe merchant's identifier at BKM, the domestic switch.
CampaignCodeAcqCampaignCodeIssCardSeqNumberWhich chip on the card was used, where a customer holds more than one card on the same number.
ChannelTypeDescriptionClearingChannelClearingDateA 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.
ClearingNumberCurrencyCodeDescriptionCustomerNumberThe 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.
DisplayAtChannelsEarnedRewardBankEarnedRewardCampaignAcqEarnedRewardCampaignIssEarnedRewardMerchantEmbossNameThe name embossed on the card.
EodDateA 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.
InvoiceNumberLocalAmountThe amount converted into the bank's own currency.
LocalCurrencyMainCardRefNumberThe card reference of the main card. On a supplementary card this is the card it hangs from; on a main card it is the card's own reference.
MainCustomerNumberThe main customer of a corporate relationship, as a number. The employees and supplementary holders under it carry their own customerNumber.
MaskedCardNumberThe card number with its middle digits masked, as the platform stores it. It is a display form, not a key.
MatchStatusDescriptionThat matching state in words.
MccDescriptionMerchantAmexIdMerchantCityMerchantCountryCodeWhere the merchant is, as a country code.
MerchantNameThe merchant's name as it reached the platform from the scheme.
NetworkDescriptionThe network's name, for display.
OfflineFlagWhether the terminal approved the transaction without asking the issuer.
PanEntryModeHow the card was read at the terminal — chip, stripe, contactless, keyed, or stored on file. The scheme's own code.
PinUsageWhether the transaction was authorised with a PIN.
ProductRefUtidThe transaction this one refers to — the original, for a reversal or a correction.
RequestDateA 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.
RewardTypeDescriptionRrnThe retrieval reference number — the card scheme's handle for the transaction, and what a bank quotes when asking the scheme about it.
SettlementAmountThe amount as it settles between the scheme and the bank.
SettlementCurrencyTerminalNumberThe terminal the transaction was made at.
TerminalTypeWhat kind of terminal that was — POS, ATM, or another.
TrnAmountThe amount of the transaction, in its own currency.
TrnCodeMatrixDescTrnCurrencyTrnDateA 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.
TrnDescriptionThe transaction in words, as it reached the platform.
TrnOriginTrnStatusDescriptionThe transaction's state in words.
UtidThe unique transaction identifier the platform gives a transaction, and the handle every later operation on it takes. Returned by the transaction listings.
GetDebitCardForRewardByBankRequest
customerNumberCustomer whose reward card is selected.
channelThree-digit code identifying the channel on behalf of which the request is made (e.g. 002 for Internet). Mandatory in every request. Used for entitlement checks, limit enforcement and audit logging. Channel codes are managed through configuration parameters and may change over time. Refer to the Channels page for the current list of valid codes.
GetDebitCardForRewardByBankResponse
accountNumberThe account at the bank's core banking system that the card draws on. It must already exist, belong to the card's customer, and be neither shared nor a foreign-currency account.
maskedCardNumberThe card number with its middle digits masked, as the platform stores it. It is a display form, not a key: operations take the shadow number.
shadowCardNumberThe 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.
GetDebitCardLogDataListByShadowCardNumberRequest
shadowCardNumberShadow card number to filter the log on. Unlike the credit equivalent, it is always required here; customerNumber does not stand in for it.
startDateCanNotBeNullOrLessThanSqlMinValue — Start of the window matched against each log row's insert date. The window is inclusive at both ends and is compared as a full timestamp, not as a date.
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.
endDateCanNotBeNullOrLessThanSqlMinValue — End of the window matched against each log row's insert date. The window is inclusive at both ends and is compared as a full timestamp, not as a date.
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.
logCodeCard log code to filter on. An absent or empty value switches the filter off and returns every log code.
customerNumberFurther narrows the log to one customer. It is not checked; zero switches this filter off.
GetDebitCardRestrictionRequest
shadowCardNumberThe card whose restrictions are read.
GetDelinquencyInterestAmount
ratedelayAmountWithTaxcurrencyCodemainCardRefNumberThe card reference of the main card. On a supplementary card this is the card it hangs from; on a main card it is the card's own reference.
delayTypeGetDelinquencyInterestAmountRequest
shadowCardNumberShadow card number of the card. No check is applied to it; the value is passed straight to the query, where it is matched against valid card master rows.
GetEncryptDataBlockRequest
dataBlockClear data block to encrypt. Rejected when null, empty or whitespace. The facade applies no length, format or character check and forwards the value as given.
A cipher block rather than stored data; no column behind it.
GetPaymentAndCashadvanceInformationByCriterias
channelTypeWhich channel the row applies to.
channelTypeDescriptionThe description of channelType, carried alongside it for display. It is not a key: match on the code.
maskedCardNumberThe card number with its middle digits masked, as the platform stores it. It is a display form, not a key: operations take the shadow number.
paymentDateA 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.
productTransactionRefNoprovisionNoshadowCardNumberThe 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.
statusCodeValues:
A— validB— pendingC— stolenD— cancelled by the bankF— fraudG— temporarily blockedI— cancelledL— lostM— cancelled by the customerT— corporate dummy
statusCodeDescriptionThe description of statusCode, carried alongside it for display. It is not a key: match on the code.
trnAmountThe amount of the transaction, in its own currency.
trnCodeWhat kind of transaction this is, as the platform's own code.
trnCodeMatrixIdWhich row of the transaction-code matrix this transaction was classified by.
trnCurrencyCodeThe currency the transaction was made in.
trnDescriptionThe description of trnCode, carried alongside it for display. It is not a key: match on the code.
GetPaymentAndCashadvanceInformationByCriteriasRequest
channelTypeNarrows the list to one channel.
customerNumberNarrows the list to one customer.
beginDateStart of the payment date range.
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.
endDateEnd of the payment date range.
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.
shadowCardNumberNarrows the list to one card.
trnCodeMatrixApplied by the facade after the service has answered, not by the service. Only 06, 08 and CASHADVANCE select anything; leaving it out returns every row. Any other value returns an empty list.
The matrix itself rather than the identifier of a row in it; no column behind it.
branchNoNarrows the list to one branch.
GetProductByShadowCardNumberRequest
shadowCardNumberThe card whose product is returned. It is not format-checked; an absent or unknown value is reported as a missing asset.
GetProductByShadowCardNumberResponse
cardType0 None, 1 Credit, 2 Debit, 3 Prepaid
digitalAbilityWhether the product can be issued as a digital card.
brandWhich scheme the card is issued on.
productNumberThe card product the card is issued on. Defined in the parameter tables; getCardProductList returns the ones a tenant may use.
productNameThe card product's full name.
productShortnameGetSecureCardByPanRequest
channelThree-digit code identifying the channel on behalf of which the request is made (e.g. 002 for Internet). Mandatory in every request. Used for entitlement checks, limit enforcement and audit logging. Channel codes are managed through configuration parameters and may change over time. Refer to the Channels page for the current list of valid codes.
panThe card's PAN, in the clear.
A card number is not stored by these services; the platform keeps a shadow card number instead.
GetSecureCardByPanResponse
encryptedCardNumberThe card number encrypted under the platform's key, which is how it travels between services.
hashCardNumberA one-way hash of the card number, for matching two records without carrying the number.
firstEightfirstSixlastFourrecordIdThe identifier of the row the operation created or acted on, returned so a later call can name it.
HealthCheckResponse
dateA 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.
resultThe outcome, as the downstream system words it.
HomePhone
ccThe copy recipients of the message.
subscriberThe subscriber the record belongs to.
IsSetCardPinViaSMSControlRequest
mobilePhoneNumberFormat — The cardholder's mobile number. Ten digits are accepted: the facade prefixes 90 before it searches, so 5xxxxxxxxx and 905xxxxxxxxx find the same cardholder.
Handed to the SMS service rather than stored here. The platform prefixes 90 when it is given ten digits, which is the shape to send; it is not a maximum.
cardNumberLastFourDigitsLength 4 — The last four digits of the card number.
The last four digits of a card number, which is not itself stored by these services.
IsSetCardPinViaSMSControlResponse
isHaveAnyCardcustomerNumberThe 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.
shadowCardNumberThe 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.
MccGroup
validFlagWhether the row is live. The platform sets it.
useInApplicationFlaginstitutionCodemccGroupCodeWhich group of merchant categories the merchant falls in.
mccGroupDescriptionThe description of mccGroupCode, carried alongside it for display. It is not a key: match on the code.
qualificationIndicatorCodekk100hOrderNumberMerchantData
acquirerMerchantIDmerchantCountryCodeWhere the merchant is, as a country code.
merchantNameThe merchant's name as it reached the platform from the scheme.
mccThe merchant category code — the four-digit code the scheme classifies the merchant's trade with.
MerchantRiskIndicator
shipIndicatordeliveryTimeframedeliveryEmailAddressreorderItemsIndpreOrderPurchaseIndpreOrderDategiftCardAmountgiftCardCurrgiftCardCountMobileNo
ccThe copy recipients of the message.
subscriberThe subscriber the record belongs to.
MobilePhone
ccThe copy recipients of the message.
subscriberThe subscriber the record belongs to.
NetworkTypeDef
insertDateWhen the row was created.
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.
validFlagWhether the row is live. The platform sets it.
insertUserIdWho created the row, as the platform recorded it.
insertTokenIdThe session the row was created under.
updateDateWhen the row was last changed.
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.
updateUserIdWho last changed the row.
updateTokenIdThe session that last changed it.
networkTypeValues:
O— on-usD— domestic, through BKMM— MastercardV— Visa
networkTypeDescriptionThe description of networkType, carried alongside it for display. It is not a key: match on the code.
ResponseCodeDef
insertDateWhen the row was created.
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.
validFlagWhether the row is live. The platform sets it.
successFlaginsertUserIdWho created the row, as the platform recorded it.
insertTokenIdThe session the row was created under.
updateDateWhen the row was last changed.
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.
updateUserIdWho last changed the row.
updateTokenIdThe session that last changed it.
transactionDomainresponseCodeThe downstream system's own result code, passed through. 00 and 0 are success; anything else is its refusal, and responseReasonCode or the description says which.
responseCodeDescriptionThe description of responseCode, carried alongside it for display. It is not a key: match on the code.
ResponseReasonCodeDef
insertDateWhen the row was created.
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.
validFlagWhether the row is live. The platform sets it.
insertUserIdWho created the row, as the platform recorded it.
insertTokenIdThe session the row was created under.
updateDateWhen the row was last changed.
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.
updateUserIdWho last changed the row.
updateTokenIdThe session that last changed it.
responseReasonCodeWhy the downstream system answered as it did, where it narrows the response code.
responseReasonDescriptionThe description of responseReasonCode, carried alongside it for display. It is not a key: match on the code.
descriptionLocalSetStatementDocumentIdRequest
ListHasNoItem — The statements to attach document ids to. Must be sent and must hold at least one entry.
SetStatementDocumentOnlyResponse
totalRowCountinsertedRowCountupdatedRowCountnoActionRowCountStatementDocumentItem
maskedCardNumberThe card the statement belongs to. The document leaves this optional, but the lookup matches it exactly, so an entry without it matches no statement. What each operation then does with that entry is on its own 200.
customerNumberThe customer the card belongs to. Matched exactly alongside the masked card number.
statementCurrencyCodeThe statement's currency. The document leaves this optional, but the lookup matches it exactly, so an entry without it matches no statement. What each operation then does with that entry is on its own 200.
statementDateThe statement date. Compared as a date, so any time component is ignored. Matched against both the live and the historical statement headers.
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.
documentIdThe document to attach. Nothing checks that it names a document that exists.
ThreeDSRequestorAuthenticationInfo
threeDSReqAuthMethodthreeDSReqAuthTimestampthreeDSReqAuthDataThreeDSRequestorPriorAuthenticationInfo
threeDSReqPriorAuthMethodthreeDSReqPriorAuthTimestampthreeDSReqPriorAuthDatathreeDSReqPriorRefTransactionData
messageCategorythreeDSRequestorAuthenticationIndthreeDSRequestorChallengeIndpurchaseAmountpurchaseCurrencypurchaseExponentpurchaseInstallDatapurchaseDatetransTyperecurringExpiryTrnCodeDef
validFlagWhether the row is live. The platform sets it.
insertDateWhen the row was created.
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.
insertUserIdWho created the row, as the platform recorded it.
insertTokenIdThe session the row was created under.
updateDateWhen the row was last changed.
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.
updateUserIdWho last changed the row.
updateTokenIdThe session that last changed it.
trnCodeWhat kind of transaction this is, as the platform's own code.
trnCodeDescriptionThe description of trnCode, carried alongside it for display. It is not a key: match on the code.
TrnCodeMatrix
insertDateWhen the row was created.
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.
validFlagWhether the row is live. The platform sets it.
financialTrnFlagadjustmentTrnFlagreversalFlagrefundFlagvoidFlagadviceFlagofflineFlagWhether the terminal approved the transaction without asking the issuer.
recurringFlagautoBsmvFlagautoKkdfFlagcutOffCardPostingFlagacqRiskyTrnFlagcashFeeChargeFlagprepaidFlagdiscountFlaginflationFlagdeferringFlagtaxIncludeFlaginsertUserIdWho created the row, as the platform recorded it.
insertTokenIdThe session the row was created under.
updateDateWhen the row was last changed.
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.
updateUserIdWho last changed the row.
updateTokenIdThe session that last changed it.
trnCodeMatrixIdWhich row of the transaction-code matrix this transaction was classified by.
trnCodeWhat kind of transaction this is, as the platform's own code.
trnCodeDetailtrnCodeSpecialtrnInstallmentTypetrnDescriptionThe description of trnCode, carried alongside it for display. It is not a key: match on the code.
onlineMessageTypetrnEffectWhether the transaction adds to the balance or takes from it.
trnEffectTypetrnEffectedLimittrnRewardAbilityWhether the transaction can earn a reward.
preauthorizationStatusprocessTyperewardEffectedSegmentclosingTrnCodeclosingTrnCodeDetailtrnGroupCodetrnCodeBucketGroupCodeaddValueDaytrnRewardGroupCodeacqCommissionTrnGroupCodeacqLoyaltyTrnGroupCodeacqAccTrnGroupCodetrnPermGroupCodetrnFeeGroupCodetrnLimitationGroupCodeValues:
SA— purchaseNA— cash advanceST— purchase, main card
accountingGroupCodeclosingMatrixIdrewardEffectedSegmentGroupinstallingMatrixIdmanualClosingMatrixIdTrnStatus
validFlagWhether the row is live. The platform sets it.
trnStatusCodeWhere the transaction has got to, as a code.
trnStatusDescriptionThe description of trnStatusCode, carried alongside it for display. It is not a key: match on the code.
UpdateCustomerAddressData
addressTypeMust be a defined address type.
Values:
RA— homeAL— businessEA— employerOO— alternativeWA— previousSW— SWIFTSS— SWIFT name and addressMR— Mernis, registeredMS— Mernis, stated
Not set is --.
addressTextFull address text.
isDefaultCounted against the addresses already stored for the customer; exactly one address in total must carry it.
isCardAddressCounted against the addresses already stored for the customer; at most one in total may carry it.
isConfirmedMandatory although the schema marks it optional.
updateAllDataIgnored — The integration layer does not forward it.
customerNumberIgnored — Overwritten with the customer number being updated.
recordIdRequired · Ignored — The integration layer does not forward it, so it never selects an existing address.
validFlagIgnored — The integration layer does not forward it.
addressIdExternal System Relational Identifier, Correlation Identifier
countryIdNotNull — When supplied it must be a defined country. It is mandatory whenever cityId is supplied.
industrialZoneIdIndustrial Zone Identifier
industrialZoneNamecityIdDependent · NotNull — Requires countryId, and the city must be defined for that country.
cityNameDependent — When cityId and countryId are both supplied it must equal the defined name of that city.
countyIdCounty Identifier, see County_Def table
countyNameCounty Name, see County_Def table
townIdTown Identifier, see Town_Def table
townNameTown Name, see Town_Def table
villageIdVillage Identifier, see Village_Def table
villageNameVillage Name, see Village_Def table
districtIdDistrict Identifier, see District_Def table
districtNameDistrict Name, see District_Def table
streetIdStreet Identifier, see Street_Def table
streetNameStreet Name, see Street_Def table
siteNameAddress Site Name
buildingIdBuilding Identifier
buildingNamebuildingNumberbuildingEntranceBuilding Entrance Number
flatNumberapartmentNumberstateIdState Identifier
stateNameThe state or province of the address.
zipCodeThe post code of the address.
poBoxNumberPost Box Number
UpdateCustomerCommunicationData
ListHasNoItem — When the property is present it must hold at least one address.
ListHasNoItem — When the property is present it must hold at least one mobile number.
ListHasNoItem — When the property is present it must hold at least one e-mail address.
ListHasNoItem — When the property is present it must hold at least one phone number.
UpdateCustomerData
Identifies the customer and carries the fields written onto the customer master.
Conditional · NotNull — Mandatory when customerType is the retail, employee or lite-default type. It is written only if the customer already has a personal information record.
Conditional · NotNull — Mandatory when customerType is not the retail, employee or lite-default type. Most of it is written only if the customer already has a firm information record.
Omitting the whole block still clears valueSubSegmentCode.
Each flag left null keeps its stored value, except customLimitationFlag.
UpdateCustomerEmailData
eMailAddressNotNull · InvalidEmailAddress — Mandatory in practice, and it must parse as an e-mail address.
isConfirmedMandatory in practice, because the entry is written as a new record.
updateAllDataIgnored — The integration layer does not forward it.
customerNumberIgnored — Overwritten with the customer number being updated.
recordIdRequired · Ignored — The integration layer does not forward it, so it never selects an existing address.
validFlagIgnored — The integration layer does not forward it.
UpdateCustomerFirmData
firmNameRegistered name of the firm. A blank value keeps the stored name.
authorityCustomerNumberIgnored — Mandatory, but the service does not write it.
firmCustomerTypeMandatory although the schema marks it optional. Blank keeps the stored value.
firmNumberWritten onto the customer master. Null keeps the stored value.
taxNumberWritten onto the customer master. Blank keeps the stored value.
taxOfficeWritten onto the customer master. Blank keeps the stored value.
embossFirmNameFirm Name On Card
tradeRegistrationNumberTrading Registration Number
tradeRegistrationDateTrading Registration Date
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.
tradeRegistrationOfficeTrading Registration Office
foundationDateCorporate Foundation Date
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.
authorityNameCorporate Responsable Employee Full Name
authorityGsmNumberCorporate Responsable Employee Mobile Number
authorityMailAddressCorporate Responsable Employee E-Mail Address
UpdateCustomerGsmData
gsmCountryIdCountry code. It must not be negative and must not exceed four digits.
gsmAreaCodeArea code. It must not be negative and must not exceed four digits.
gsmNumberAt most fifteen characters, and it must contain at least one digit.
phoneNumberTextMandatory in practice. At most two hundred and fifty characters, and it must contain at least one digit.
isConfirmedMandatory in practice, because the entry is written as a new record.
isContactNumberCounted against the mobile numbers already stored for the customer; exactly one in total must carry it.
updateAllDataIgnored — The integration layer does not forward it.
customerNumberIgnored — Overwritten with the customer number being updated.
recordIdRequired · Ignored — The integration layer does not forward it, so it never selects an existing mobile number.
validFlagIgnored — The integration layer does not forward it.
confirmDateGsm Approve Date
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.
UpdateCustomerMainData
customerNumberIdentifies the customer to update. A null is read as zero, which matches no customer.
customerTypeMust be a defined customer type. It decides whether persona or corporate is required. A blank value keeps the stored type.
Values:
1— corporate2— individual3— employee4— sole proprietorship
Not set is N.
externalCustomerNumberIgnored — The service does not write it.
accountingCustomerTypeNotNull — When supplied it must be defined. Blank keeps the stored value.
Values:
1— corporate2— individual3— employee
creditCustomerTypeNotNull — When supplied it must be defined. Blank keeps the stored value.
Values:
S— standardV— VIPP— VIP platinum
branchCodeNull keeps the stored branch.
isLiteDefault — Defaults to false. True requires tenantId and forces the lite defaults, but only if the customer has a register row.
tenantIdConditional · NotNullOrWhiteSpace — Required when isLite is true, and must match a defined tenant.
statusCodeBlank keeps the stored status. It is not checked against a status definition table.
Values:
A— validB— pendingC— stolenD— cancelled by the bankF— fraudG— temporarily blockedI— cancelledL— lostM— cancelled by the customerT— corporate dummy
blockedAccountFlagNull keeps the stored flag.
validFlagNull keeps the stored flag. It is copied onto the personal and firm records as well.
UpdateCustomerPersonalData
nameGiven name. A blank value keeps the stored name.
surnameFamily name. A blank value keeps the stored surname.
birthDateDate of birth.
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.
middleNameCustomer Middle Name
birthPlaceCustomer Place Of Birth
fatherNameCustomer Father's Name
motherNameCustomer Mother's Name
maritalStatusCustomer Marital Status Code
Values:
1— singleEV— married3— divorced4— widowed2— other0— unknown
educationStatusEducational Status Code
Values:
1— literate2— primary4— secondary5— two-year college6— university7— master's8— doctorate
nationalityNationality Code, see Nationality_Def Table
identityTypeIdentity Type Code, see Identity_Type_Def table
Values:
1— identity cardPT— identity card2— driver's licenceEH— driver's permit3— passportPS— passportKK— TRNC identity cardMK— blue cardIT— residence permitAA— an identity document listed in the annex to the European AgreementDG— another type of identity0— unknown
identityNumberresidenceTypeNotNull — When supplied it must be a defined residence type. Blank keeps the stored value.
Values:
I— resident in TurkeyD— resident abroad
disabledFlagNull keeps the stored flag.
titleCustomer Title
genderGender Type, E=Male, K=Female, X=Unknown
Values:
E— maleK— femaleX— unknown
occupationOccupation Type, see Occupation_Def table
workplaceNameCustomer Workplace Name
businessTitleCustomer Business Title
UpdateCustomerPhoneData
phoneTypeMust be a defined phone type of at most two characters.
Values:
1— telephone2— fax0— unknown
phoneCountryIdMandatory in practice. It must be a defined country and must not exceed four digits.
phoneAreaCodeMandatory in practice. At most ten characters, and it must contain at least one digit.
phoneNumberMandatory in practice. At most twenty characters, and it must contain at least one digit.
phoneNumberTextMandatory in practice. At most fifty characters, and it must contain at least one digit.
isContactNumberCounted against the phone numbers already stored for the customer; exactly one in total must carry it.
updateAllDataIgnored — The integration layer does not forward it.
customerNumberIgnored — Overwritten with the customer number being updated.
recordIdRequired · Ignored — The integration layer does not forward it, so it never selects an existing phone number.
validFlagIgnored — The integration layer does not forward it.
UpdateCustomerPreferenceData
sendWarningLetterFlagNull keeps the stored flag.
communicationTypeNotNull — When supplied it must be a defined communication language. Blank keeps the stored value.
Values:
1— dial-up2— ADSL3— GSM4— GPRS
autoLimitIncreaseFlagNull keeps the stored flag.
statementPostingFlagNull keeps the stored flag.
statementSmsSendFlagNull keeps the stored flag.
statementEMailSendFlagNull keeps the stored flag.
earnRewardFlagNull keeps the stored flag.
sensitiveDataPermissionFlagNull keeps the stored flag.
customLimitationFlagWhen it is null the service falls back to the stored sensitive data permission flag rather than to the stored custom limitation flag.
UpdateCustomerRequest
channelThree-digit code identifying the channel on behalf of which the request is made (e.g. 002 for Internet). Mandatory in every request. Used for entitlement checks, limit enforcement and audit logging. Channel codes are managed through configuration parameters and may change over time. Refer to the Channels page for the current list of valid codes.
Customer data. The main block inside it is mandatory as well.
Communication records. Every entry is created as a new record; see the 200 description.
UpdateCustomerResponse
customerNumberThe 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.
personIdThe person behind the customer record.
UpdateCustomerSegmentData
behavioralSegmentCodeNotNull — When supplied it must be defined. Blank keeps the stored value.
valueSegmentCodeNotNull — When supplied it must be defined. Blank keeps the stored value.
Values:
02— standard03— private10— prestige07— prestige+09— FES99— Islamic
Not set is N.
valueSubSegmentCodeNotNull — When supplied it must be defined. Unlike the other two it is written unconditionally, so leaving it out clears the stored value.
Values:
10— private20— private plus30— investor40— other