{ "openapi": "3.0.4", "info": { "title": "Ana Bankacılık Iletisim Servisi Ripper istikameti", "description": "Reach the ledger behind the card — authorisation, posting and limits against core banking", "contact": { "name": "DgPays", "url": "https://www.dgpays.com" }, "license": { "name": "License", "url": "https://www.dgpays.com" }, "version": "v8.3.5.10" }, "servers": [ { "url": "https://devcard.sim-ant.com/SandBox/Integrationcorebanking", "description": "Sandbox — safe to call; nothing settles." } ], "paths": { "/Indoor/api/getCardRestriction": { "post": { "tags": [ "Permissions and restrictions" ], "summary": "Service that lists restrictions defined on the card", "description": "Retrieves debit card restrictions for a given ShadowCardNumber. Accepts GetDebitCardRestrictionRequest with ShadowCardNumber. Returns GetDebitCardRestrictionResponse containing a list of CardRestriction items, each including RestrictionCode, RestrictionCodeDescription, RestrictionPermissionIndicator, and RestrictionPermissionIndicatorDescription. Uses _intRepository.GetCardRestriction internally.", "operationId": "getCardRestriction", "requestBody": { "description": "Get Debit Card Restriction Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetDebitCardRestrictionRequest" } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetDebitCardRestrictionResponse" } } } }, "404": { "$ref": "#/components/responses/ActionNotFound" }, "400": { "$ref": "#/components/responses/BusinessFailure" }, "500": { "$ref": "#/components/responses/TechnicalFailure" } } } }, "/Indoor/api/getCardTypeByBin": { "post": { "tags": [ "Reference data" ], "summary": "Service that lists card types based on the provided BIN number", "description": "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.", "operationId": "getCardTypeByBin", "requestBody": { "description": "Get Card Type By Bin Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetCardTypeByBinRequest" } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetCardTypeByBinResponse" } } } }, "404": { "$ref": "#/components/responses/ActionNotFound" }, "400": { "$ref": "#/components/responses/BusinessFailure" }, "500": { "$ref": "#/components/responses/TechnicalFailure" } } } }, "/Indoor/api/getCreditTransactionList": { "post": { "tags": [ "Transactions" ], "summary": "Service that lists all credit card transactions", "description": "Retrieves a list of credit card transactions for a given shadow card number. Accepts GetCreditTransactionListRequest containing ShadowCardNumber, EmbossName, SourceNetwork, TrnCodeMatrixId, MaxAmount, MinAmount, Transactiondatebegin, Transactiondateend, and TrnCode. Returns GetCreditTransactionListResponse with a list of CreditTransactionList items. Each item contains transaction details including AcqRefNumber, AuthorizationNumber, BillingAmount, BillingCurrency, Merchant details, Card details, transaction amounts, dates, log/status codes, installment info, and rewards. Validates Transactiondatebegin, Transactiondateend, and ShadowCardNumber before calling _crdTransactionServiceProxy.GetCreditTransactionList().", "operationId": "getCreditTransactionList", "requestBody": { "description": "Get Credit Transaction List Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetCreditTransactionListRequest" } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetCreditTransactionListResponse" } } } }, "404": { "$ref": "#/components/responses/ActionNotFound" }, "400": { "$ref": "#/components/responses/BusinessFailure" }, "500": { "$ref": "#/components/responses/TechnicalFailure" } } } }, "/Indoor/api/getBasicCardInformationByPan": { "post": { "tags": [ "Card lifecycle" ], "summary": "Service that lists card details based on an open card number", "description": "Retrieves basic card information for a given PAN (Primary Account Number). Accepts GetBasicCardInformationByPanRequest containing Pan. Returns GetBasicCardInformationByPanResponse with Bin, Psn (card sequence number), CardType, MaskedCardNumber, EncryptedCardNumber, HashCardNumber, ShadowCardNumber, and CustomerNumber.", "operationId": "getBasicCardInformationByPan", "requestBody": { "description": "Get Basic Card Information By Pan Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetBasicCardInformationByPanRequest" } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetBasicCardInformationByPanResponse" } } } }, "404": { "$ref": "#/components/responses/ActionNotFound" }, "400": { "$ref": "#/components/responses/BusinessFailure" }, "500": { "$ref": "#/components/responses/TechnicalFailure" } } } }, "/Indoor/api/getApplicableProductsByCustomerNumber": { "post": { "tags": [ "Card issuance and personalisation" ], "summary": "Service that lists eligible products by customer number", "description": "Retrieves applicable card products for a specific customer. Supports Debit and Credit cards, filtering by customer number, main customer number, and optional product group code. Maps cached card products to GetApplicableProductsItem including ProductName, ProductNumber, Brand, ProductShortName, DigitalAbility, TenantId, and CardAnnualFeeAmount for Credit cards. Returns results as GetApplicableProductsByCustomerNumberResponse with Debit and Credit lists. Prepaid card support is planned but not implemented.", "operationId": "getApplicableProductsByCustomerNumber", "requestBody": { "description": "Get Applicable Products By Customer Number Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetApplicableProductsByCustomerNumberRequest" } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetApplicableProductsByCustomerNumberResponse" } } } }, "404": { "$ref": "#/components/responses/ActionNotFound" }, "400": { "$ref": "#/components/responses/BusinessFailure" }, "500": { "$ref": "#/components/responses/TechnicalFailure" } } } }, "/Indoor/api/getPaymentAndCashadvanceInformationByCriterias": { "post": { "tags": [ "Transactions" ], "summary": "Service that lists customer’s payment and cash-advance information based on specified criteria", "description": "Retrieves payment and cash advance information filtered by various criteria including shadow card number, date range, customer number, channel type, branch, and transaction code. Returns a list of transactions with details such as masked card number, payment date, transaction amount, transaction code, currency, description, status, provision number, product transaction reference, channel information, and status description.", "operationId": "getPaymentAndCashadvanceInformationByCriterias", "requestBody": { "description": "Get Payment And Cashadvance Information By Criterias Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetPaymentAndCashadvanceInformationByCriteriasRequest" } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetPaymentAndCashadvanceInformationByCriteriasResponse" } } } }, "404": { "$ref": "#/components/responses/ActionNotFound" }, "400": { "$ref": "#/components/responses/BusinessFailure" }, "500": { "$ref": "#/components/responses/TechnicalFailure" } } } }, "/Indoor/api/getProductByShadowCardNumber": { "post": { "tags": [ "Reference data" ], "summary": "Service that lists product information for a card based on Shadow Card Number", "description": "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.", "operationId": "getProductByShadowCardNumber", "requestBody": { "description": "Get Product By Shadow Card Number Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetProductByShadowCardNumberRequest" } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetProductByShadowCardNumberResponse" } } } }, "404": { "$ref": "#/components/responses/ActionNotFound" }, "400": { "$ref": "#/components/responses/BusinessFailure" }, "500": { "$ref": "#/components/responses/TechnicalFailure" } } } }, "/Indoor/api/getDelinquencyInterestAmount": { "post": { "tags": [ "Statements and billing" ], "summary": "Service that displays late interest/profit share amount", "description": "Retrieves delinquency interest amounts for a given ShadowCardNumber. Accepts GetDelinquencyInterestAmountRequest with ShadowCardNumber. Calls _intRepository.GetDelinquencyInterestAmount() and maps results to ListGetDelinquencyInterestAmountResponse containing ListOfDelinquency with properties such as CurrencyCode, Rate, MainCardRefNumber, DelayAmountWithTax, and DelayType.", "operationId": "getDelinquencyInterestAmount", "requestBody": { "description": "Get Delinquency Interest Amount Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetDelinquencyInterestAmountRequest" } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListGetDelinquencyInterestAmountResponse" } } } }, "404": { "$ref": "#/components/responses/ActionNotFound" }, "400": { "$ref": "#/components/responses/BusinessFailure" }, "500": { "$ref": "#/components/responses/TechnicalFailure" } } } }, "/Indoor/api/createIndividualDebitCard": { "post": { "tags": [ "Card issuance and personalisation" ], "summary": "Individual Debit Card creation service", "description": "Creates an individual debit card for a customer. If ProductNumber is not provided, automatically selects the primary product. Builds card address info, maps account list, sets card permissions, and calls CreateIndividualCard on the debit management service. Returns card identifiers and warnings.", "operationId": "createIndividualDebitCard", "requestBody": { "description": "Create Individual Debit Card Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateIndividualDebitCardRequest" } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateIndividualDebitCardResponse" } } } }, "404": { "$ref": "#/components/responses/ActionNotFound" }, "400": { "$ref": "#/components/responses/BusinessFailure" }, "500": { "$ref": "#/components/responses/TechnicalFailure" } } } }, "/Indoor/api/createCorporateDebitCard": { "post": { "tags": [ "Card issuance and personalisation" ], "summary": "Corporate Debit Card creation service", "description": "Creates a corporate debit card for a customer. Auto-selects ProductNumber if null. Sends customer details, branch info, card delivery type, permissions, accounts, and optional application date & name on card to _debitManagementServiceProxy.CreateCorporateCard. Returns CardRefNumber, MainCardRefNumber, MaskedCardNumber, ShadowCardNumber, RecordId, and Warnings.", "operationId": "createCorporateDebitCard", "requestBody": { "description": "Create Corporate Debit Card Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateCorporateDebitCardRequest" } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateCorporateDebitCardResponse" } } } }, "404": { "$ref": "#/components/responses/ActionNotFound" }, "400": { "$ref": "#/components/responses/BusinessFailure" }, "500": { "$ref": "#/components/responses/TechnicalFailure" } } } }, "/Indoor/api/replaceDebitCard": { "post": { "tags": [ "Card issuance and personalisation" ], "summary": "Debit card renewal service", "description": "Replaces a debit card. Calls the debit management service to generate a new card or update product details for the specified debit card. Returns the new shadow card number, masked card number, card reference number, and flags indicating if a new card was generated or the product was changed.", "operationId": "replaceDebitCard", "requestBody": { "description": "Replace Debit Card Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReplaceDebitCardRequest" } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReplaceDebitCardResponse" } } } }, "404": { "$ref": "#/components/responses/ActionNotFound" }, "400": { "$ref": "#/components/responses/BusinessFailure" }, "500": { "$ref": "#/components/responses/TechnicalFailure" } } } }, "/Indoor/api/getDebitCardInfo": { "post": { "tags": [ "Card lifecycle" ], "summary": "Service that retrieves debit card information", "description": "Retrieves detailed debit card information for a given ShadowCardNumber. Accepts GetDebitCardInfoRequest with ShadowCardNumber. Calls _intRepository.GetSearchByCustomernumberCardnumber() and _debitManagementServiceProxy.ListCardAccountByShadowCardNumber() to retrieve card details. Returns GetDebitCardInfoResponse containing DebitCardModel with properties such as Barcode, BranchCode, CardStatusCode, MaskedCardNumber, CustomerNumber, VirtualFlag, SupplementaryCardFlag, and a list of CardAccountInfo including AccountNumber, AccountType, AccountBranchId, AccountOrderFlag, and FecCode.", "operationId": "getDebitCardInfo", "requestBody": { "description": "Get Debit Card Info Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetDebitCardInfoRequest" } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetDebitCardInfoResponse" } } } }, "404": { "$ref": "#/components/responses/ActionNotFound" }, "400": { "$ref": "#/components/responses/BusinessFailure" }, "500": { "$ref": "#/components/responses/TechnicalFailure" } } } }, "/Indoor/api/changeDebitCardStatus": { "post": { "tags": [ "Card lifecycle" ], "summary": "Service that updates the status information of a debit card", "description": "Changes the status of a debit card. Sends ShadowCardNumber, StatusCode, StatusReasonCode, Channel, and optional CloseRequestDate to _debitManagementServiceProxy.ChangeCardStatus. Returns an empty ChangeDebitCardStatusResponse.", "operationId": "changeDebitCardStatus", "requestBody": { "description": "Change Debit Card Status Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChangeDebitCardStatusRequest" } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChangeDebitCardStatusResponse" } } } }, "404": { "$ref": "#/components/responses/ActionNotFound" }, "400": { "$ref": "#/components/responses/BusinessFailure" }, "500": { "$ref": "#/components/responses/TechnicalFailure" } } } }, "/Indoor/api/changeDebitCardBranch": { "post": { "tags": [ "Card lifecycle" ], "summary": "Service that changes the branch associated with a debit card", "description": "Changes the branch of a debit card. Sends ShadowCardNumber, TargetBranchCode, and Channel to _debitManagementServiceProxy.ChangeCardBranch. Returns IsSuccess, OldBranch, and NewBranch.", "operationId": "changeDebitCardBranch", "requestBody": { "description": "Change Debit Card Branch Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChangeDebitCardBranchRequest" } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChangeDebitCardBranchResponse" } } } }, "404": { "$ref": "#/components/responses/ActionNotFound" }, "400": { "$ref": "#/components/responses/BusinessFailure" }, "500": { "$ref": "#/components/responses/TechnicalFailure" } } } }, "/Indoor/api/attachDebitCardAccount": { "post": { "tags": [ "Card lifecycle" ], "summary": "Service that links an account to a card", "description": "Attaches a debit card to a bank account using account details including branch, type, suffix, number, shadow card number, alias, and IBAN. Converts request and response between internal and service contracts.", "operationId": "attachDebitCardAccount", "requestBody": { "description": "Attach Debit Card Account Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AttachDebitCardAccountRequest" } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AttachDebitCardAccountResponse" } } } }, "404": { "$ref": "#/components/responses/ActionNotFound" }, "400": { "$ref": "#/components/responses/BusinessFailure" }, "500": { "$ref": "#/components/responses/TechnicalFailure" } } } }, "/Indoor/api/getDebitTransactionAll": { "post": { "tags": [ "Transactions" ], "summary": "Service that lists all debit card transactions", "description": "Retrieves all debit transactions for a given ShadowCardNumber within a specified date range. Accepts GetDebitTransactionAllRequest with ShadowCardNumber, BeginDate, EndDate, NetworkType, TrnCodeMatrixId, AuthStatus, MaxAmount, MinAmount, ResponseCode, and ResponseReasonCode. Calls _intRepository.GetAuthorizationListByBegindateEnddate() and _intRepository.GetDbttransactionByCardrefCustomernum(), then maps results to GetDebitTransactionAllResponse containing ListOfTransaction with properties such as TransactionDate, CardRefNumber, MaskedCardNumber, NetworkTypeDescription, ChannelTypeDescription, TrnCodeMatrixDescription, TrnStatusDescription, ResponseCodeDescription, ResponseReasonCodeDescription, TrnAmount, TrnCurrencyDescription, LocalAmount, SettlementAmount, AuthorizationNumber, PinUsage, PanEntryMode, OfflineFlag, Rrn, TerminalType, MerchantName, MccDescription, TerminalNumber, MerchantCountryCode, IsChipFlag, AuthorizationMatchStatus, BkmUniqueMerchantId, MatchStatusDescription, CardSeqNumber, Utid, LocalCurrencyDescription, CustomerNumber, MainCustomerNumber, SettlementCurrencyDescription, and TrnDescription.", "operationId": "getDebitTransactionAll", "requestBody": { "description": "Get Debit Transaction All Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetDebitTransactionAllRequest" } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetDebitTransactionAllResponse" } } } }, "404": { "$ref": "#/components/responses/ActionNotFound" }, "400": { "$ref": "#/components/responses/BusinessFailure" }, "500": { "$ref": "#/components/responses/TechnicalFailure" } } } }, "/Indoor/api/cancelDebitEmbossByShadowCardNumber": { "post": { "tags": [ "Card issuance and personalisation" ], "summary": "Service that cancels debit card issuance based on the Shadow Card Number", "description": "Cancels a debit card embossing using the shadow card number. Validates the request for non-empty ShadowCardNumber and a valid Channel, then calls the internal debit management service to perform the cancellation. Logs success and failure events.", "operationId": "cancelDebitEmbossByShadowCardNumber", "requestBody": { "description": "Cancel Debit Emboss By Shadow Card Number Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CancelDebitEmbossByShadowCardNumberRequest" } } }, "required": true }, "responses": { "200": { "description": "Success" }, "404": { "$ref": "#/components/responses/ActionNotFound" }, "400": { "$ref": "#/components/responses/BusinessFailure" }, "500": { "$ref": "#/components/responses/TechnicalFailure" } } } }, "/Indoor/api/getDebitCardLogDataListByShadowCardNumber": { "post": { "tags": [ "Card lifecycle" ], "summary": "Service that lists debit card log information based on the provided Shadow Card Number", "description": "Retrieves debit card log data for a given ShadowCardNumber. Accepts GetDebitCardLogDataListByShadowCardNumberRequest with ShadowCardNumber, CustomerNumber, LogCode, StartDate, and EndDate. Calls _debitManagementServiceProxy.GetCardLogDataListByShadowCardNumber() and maps results to CardLogData. Returns GetDebitCardLogDataListByShadowCardNumberResponse containing a list of CardLogData with properties such as CardRefNumber, ShadowCardNumber, MaskedCardNumber, CustomerNumber, LogCode, LogCodeDescription, OldValue, NewValue, CardLogDetail, InsertChannelId, InsertChannelDescription, InsertUserId, and InsertDate.", "operationId": "getDebitCardLogDataListByShadowCardNumber", "requestBody": { "description": "Get Debit Card Log Data List By Shadow Card Number Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetDebitCardLogDataListByShadowCardNumberRequest" } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetDebitCardLogDataListByShadowCardNumberResponse" } } } }, "404": { "$ref": "#/components/responses/ActionNotFound" }, "400": { "$ref": "#/components/responses/BusinessFailure" }, "500": { "$ref": "#/components/responses/TechnicalFailure" } } } }, "/Indoor/api/getPendingCardEmbossList": { "post": { "tags": [ "Card issuance and personalisation" ], "summary": "Service that lists cards currently in the printing process", "description": "Retrieves pending card emboss information for a given shadow card number. Returns details including card sequence number, emboss date, application date, emboss reason code and description, sub reason code and description, emboss status, masked card number, product type code and description, shadow card number, and valid flag.", "operationId": "getPendingCardEmbossList", "requestBody": { "description": "Get Pending Card Emboss List Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetPendingCardEmbossListRequest" } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetPendingCardEmbossListResponse" } } } }, "404": { "$ref": "#/components/responses/ActionNotFound" }, "400": { "$ref": "#/components/responses/BusinessFailure" }, "500": { "$ref": "#/components/responses/TechnicalFailure" } } } }, "/Indoor/api/cancelEmbossByShadowCardNumber": { "post": { "tags": [ "Card issuance and personalisation" ], "summary": "Service that cancels card issuance based on the Shadow Card Number according to the related domain", "description": "Cancels an emboss operation for a card by its ShadowCardNumber. Determines the card type (Debit, Credit, Prepaid) and calls the appropriate cancel method. Debit cards are handled via CancelDebitEmbossByShadowCardNumber; Credit and Prepaid cards are not implemented. Validates ShadowCardNumber and Channel before processing.", "operationId": "cancelEmbossByShadowCardNumber", "requestBody": { "description": "Cancel Emboss By Shadow Card Number Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CancelEmbossByShadowCardNumberRequest" } } }, "required": true }, "responses": { "200": { "description": "Success" }, "404": { "$ref": "#/components/responses/ActionNotFound" }, "400": { "$ref": "#/components/responses/BusinessFailure" }, "500": { "$ref": "#/components/responses/TechnicalFailure" } } } }, "/Indoor/api/getAvailableCardStatusList": { "post": { "tags": [ "Reference data" ], "summary": "Service that lists statuses of available cards", "description": "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.", "operationId": "getAvailableCardStatusList", "requestBody": { "description": "Get Available Card Status List Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetAvailableCardStatusListRequest" } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetAvailableCardStatusListResponse" } } } }, "404": { "$ref": "#/components/responses/ActionNotFound" }, "400": { "$ref": "#/components/responses/BusinessFailure" }, "500": { "$ref": "#/components/responses/TechnicalFailure" } } } }, "/Indoor/api/getEmbossReasonSubDefByValidFlag": { "post": { "tags": [ "Reference data" ], "summary": "Service that lists valid card issuance reasons", "description": "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.", "operationId": "getEmbossReasonSubDefByValidFlag", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetEmbossReasonSubDefByValidFlagResponse" } } } }, "404": { "$ref": "#/components/responses/ActionNotFound" }, "400": { "$ref": "#/components/responses/BusinessFailure" }, "500": { "$ref": "#/components/responses/TechnicalFailure" } } } }, "/Indoor/api/getAvailableEmbossReasonList": { "post": { "tags": [ "Reference data" ], "summary": "Service that lists card issuance reasons available for printing", "description": "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.", "operationId": "getAvailableEmbossReasonList", "requestBody": { "description": "Get Available Emboss Reason List Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetAvailableEmbossReasonListRequest" } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetAvailableEmbossReasonListResponse" } } } }, "404": { "$ref": "#/components/responses/ActionNotFound" }, "400": { "$ref": "#/components/responses/BusinessFailure" }, "500": { "$ref": "#/components/responses/TechnicalFailure" } } } }, "/Indoor/api/accountStatus": { "post": { "tags": [ "Account linking" ], "summary": "Service that displays the account status", "description": "Retrieves the current status of an account by querying the core banking and BKM management systems. The service accepts account identification details and returns the account status information mapped from the BKM response. This operation is read-only and does not perform any state-changing action on the account.", "operationId": "accountStatus", "requestBody": { "description": "Account Status Req", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccountStatusReq" } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccountStatusRes" } } } }, "404": { "$ref": "#/components/responses/ActionNotFound" }, "400": { "$ref": "#/components/responses/BusinessFailure" }, "500": { "$ref": "#/components/responses/TechnicalFailure" } } } }, "/Indoor/api/getCustomerOperationLimit": { "post": { "tags": [ "Operation limits" ], "summary": "Service that lists customized or parameter-based limit details defined for the customer", "description": "Retrieves the operation limits for a customer. Accepts GetCustomerOperationLimitRequest with CustomerNumber and Channel. Returns GetCustomerOperationLimitResponse containing a ListOfOperationLimit. Each OperationLimitItem includes Keys (ChannelType, EventCode, NetworkType, TrnLimitationGroupCode, ChannelDescription, NetworkDescription, TrnLimitationGroupDescription, EventDescription, TrnMainLimitationGroupCode, TrnMainLimitationGroupDescription, LimitProfileDetailId), and limit values such as DailyTrnCount, DailyTrnAmount, WeeklyTrnCount, WeeklyTrnAmount, MonthlyTrnCount, MonthlyTrnAmount, YearlyTrnCount, YearlyTrnAmount, PerTrnAmount, PerTrnAmountLimitRatio, and CardType. Calls _cisServiceProxy.GetCustomerOperationLimit() and maps results to internal structure.", "operationId": "getCustomerOperationLimit", "requestBody": { "description": "Get Customer Operation Limit Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetCustomerOperationLimitRequest" } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetCustomerOperationLimitResponse" } } } }, "404": { "$ref": "#/components/responses/ActionNotFound" }, "400": { "$ref": "#/components/responses/BusinessFailure" }, "500": { "$ref": "#/components/responses/TechnicalFailure" } } } }, "/Indoor/api/setCustomerOperationLimit": { "post": { "tags": [ "Operation limits" ], "summary": "Service that customizes the customers transaction limit", "description": "Sets operation limits for a customer. The SetCustomerOperationLimit method maps the request data to the internal customer management service, sends it, and returns a structured response containing each operation limit's status, action type, any errors, and detailed information about the limits including daily, weekly, monthly, and yearly transaction amounts and counts, as well as associated keys and profile information.", "operationId": "setCustomerOperationLimit", "requestBody": { "description": "Set Customer Operation Limit Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SetCustomerOperationLimitRequest" } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SetCustomerOperationLimitResponse" } } } }, "404": { "$ref": "#/components/responses/ActionNotFound" }, "400": { "$ref": "#/components/responses/BusinessFailure" }, "500": { "$ref": "#/components/responses/TechnicalFailure" } } } }, "/Indoor/api/removeCustomerOperationLimit": { "post": { "tags": [ "Operation limits" ], "summary": "Service that removes customizable limits defined for a customer", "description": "Removes customer operation limits. Calls CIS service to remove limits for the specified customer and returns a list of results including action type, errors, success flag, and operation limit record IDs.", "operationId": "removeCustomerOperationLimit", "requestBody": { "description": "Remove Customer Operation Limit Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RemoveCustomerOperationLimitRequest" } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RemoveCustomerOperationLimitResponse" } } } }, "404": { "$ref": "#/components/responses/ActionNotFound" }, "400": { "$ref": "#/components/responses/BusinessFailure" }, "500": { "$ref": "#/components/responses/TechnicalFailure" } } } }, "/Indoor/api/setCardOperationLimit": { "post": { "tags": [ "Operation limits" ], "summary": "Service that customizes the transaction limit of a card", "description": "Sets or updates operation limits for a debit or credit card. Determines the card type and calls the corresponding management service to apply daily, weekly, monthly, and yearly transaction limits, along with per-transaction limits. Returns a list of results including action type, success status, errors, and the updated operation limit details for each limit set.", "operationId": "setCardOperationLimit", "requestBody": { "description": "Set Card Operation Limit Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SetCardOperationLimitRequest" } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SetCardOperationLimitResponse" } } } }, "404": { "$ref": "#/components/responses/ActionNotFound" }, "400": { "$ref": "#/components/responses/BusinessFailure" }, "500": { "$ref": "#/components/responses/TechnicalFailure" } } } }, "/Indoor/api/getCardOperationLimit": { "post": { "tags": [ "Operation limits" ], "summary": "Service that lists customized or parameter-based limit details defined on the card", "description": "Retrieves the operation limits for a card based on its CardRefNumber and CardType. Accepts GetCardOperationLimitRequest with Channel, CardRefNumber, and CardType. Returns GetCardOperationLimitResponse containing a list of OperationLimitItem including Keys, PerTrnAmount, Daily/Weekly/Monthly/Yearly transaction counts and amounts, and CardType. Supports both Debit and Credit cards, using respective service proxies for fetching limit data.", "operationId": "getCardOperationLimit", "requestBody": { "description": "Get Card Operation Limit Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetCardOperationLimitRequest" } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetCardOperationLimitResponse" } } } }, "404": { "$ref": "#/components/responses/ActionNotFound" }, "400": { "$ref": "#/components/responses/BusinessFailure" }, "500": { "$ref": "#/components/responses/TechnicalFailure" } } } }, "/Indoor/api/removeCardOperationLimit": { "post": { "tags": [ "Operation limits" ], "summary": "Service that removes customized limits defined for a card", "description": "Removes card operation limits for debit and credit cards. Validates request, checks card type, calls respective debit or credit management service to remove limits, and returns the result including action type, errors, and success status.", "operationId": "removeCardOperationLimit", "requestBody": { "description": "Remove Card Operation Limit Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RemoveCardOperationLimitRequest" } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RemoveCardOperationLimitResponse" } } } }, "404": { "$ref": "#/components/responses/ActionNotFound" }, "400": { "$ref": "#/components/responses/BusinessFailure" }, "500": { "$ref": "#/components/responses/TechnicalFailure" } } } }, "/Indoor/api/executeCampaignTransaction": { "post": { "tags": [ "Campaigns and rewards" ], "summary": "Service that performs financial maintenance for the customer and applies or cancels campaign discounts", "description": "Executes a campaign transaction for a given ShadowCardNumber. Validates the request including Channel, TrnCodeMatrixId, and Amount limits. Adjusts amount by dividing by 100. Retrieves default description from campaign system parameters if not provided. Calls DoManualFinance on CRD transaction service proxy with finance details including TranAmount, TranCurrency, TranDescription, ShadowCardNumber, ChannelType, RewardType.None, Onus network, current TranValueDate, and SystemEntry origin. Returns Utid and TrnId from the response.", "operationId": "executeCampaignTransaction", "requestBody": { "description": "Execute Campaign Transaction Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExecuteCampaignTransactionRequest" } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExecuteCampaignTransactionResponse" } } } }, "404": { "$ref": "#/components/responses/ActionNotFound" }, "400": { "$ref": "#/components/responses/BusinessFailure" }, "500": { "$ref": "#/components/responses/TechnicalFailure" } } } }, "/Indoor/api/changeCreditCardLimitDecrease": { "post": { "tags": [ "Card and customer limits" ], "summary": "Service that performs credit card limit decrease", "description": "Decreases the credit card limit. Uses ShadowCardNumber and CardRefNumber to identify the card. Sends requested limit changes, limit ratios, and cash limit ratios to the _limitServiceProxy.ChangeCardLimitDecrease method. Optionally updates customer limit based on ChangeCustomerLimit flag.", "operationId": "changeCreditCardLimitDecrease", "requestBody": { "description": "Change Credit Card Limit Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChangeCreditCardLimitRequest" } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChangeCreditCardLimitResponse" } } } }, "404": { "$ref": "#/components/responses/ActionNotFound" }, "400": { "$ref": "#/components/responses/BusinessFailure" }, "500": { "$ref": "#/components/responses/TechnicalFailure" } } } }, "/Indoor/api/changeCreditCardLimitIncrease": { "post": { "tags": [ "Card and customer limits" ], "summary": "Service that performs credit card limit increase", "description": "Increases the credit card limit. Uses ShadowCardNumber and CardRefNumber to identify the card. Sends requested limit changes, limit ratios, and cash limit ratios to the _limitServiceProxy.ChangeCardLimitIncrease method. Optionally updates customer limit based on ChangeCustomerLimit flag.", "operationId": "changeCreditCardLimitIncrease", "requestBody": { "description": "Change Credit Card Limit Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChangeCreditCardLimitRequest" } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChangeCreditCardLimitResponse" } } } }, "404": { "$ref": "#/components/responses/ActionNotFound" }, "400": { "$ref": "#/components/responses/BusinessFailure" }, "500": { "$ref": "#/components/responses/TechnicalFailure" } } } }, "/Indoor/api/changeCustomerLimitDecrease": { "post": { "tags": [ "Card and customer limits" ], "summary": "Service that performs customer limit decrease", "description": "Decreases the customer limit. Sends CustomerNumber and NewCustomerLimit to _cisServiceProxy.ChangeCustomerLimit. Optionally uses CardProfileSetCode for customer profile adjustments.", "operationId": "changeCustomerLimitDecrease", "requestBody": { "description": "Change Customer Limit Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChangeCustomerLimitRequest" } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChangeCustomerLimitResponse" } } } }, "404": { "$ref": "#/components/responses/ActionNotFound" }, "400": { "$ref": "#/components/responses/BusinessFailure" }, "500": { "$ref": "#/components/responses/TechnicalFailure" } } } }, "/Indoor/api/changeCustomerLimitIncrease": { "post": { "tags": [ "Card and customer limits" ], "summary": "Service that performs customer limit increase", "description": "Increases the customer limit. Sends CustomerNumber and NewCustomerLimit to _cisServiceProxy.ChangeCustomerLimit. Optionally uses CardProfileSetCode for customer profile adjustments.", "operationId": "changeCustomerLimitIncrease", "requestBody": { "description": "Change Customer Limit Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChangeCustomerLimitRequest" } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChangeCustomerLimitResponse" } } } }, "404": { "$ref": "#/components/responses/ActionNotFound" }, "400": { "$ref": "#/components/responses/BusinessFailure" }, "500": { "$ref": "#/components/responses/TechnicalFailure" } } } }, "/Indoor/api/setCardPinViaSMS": { "post": { "tags": [ "PIN and card security" ], "summary": "Service that enables PIN creation via SMS for the card", "description": "Attempts to set a card PIN via SMS by sending a notification through the notification service. Uses the provided channel, tenant ID, template code, customer number, recipient, and parameters to send the PIN information. Returns true if the SMS is sent successfully, otherwise false and logs the error.", "operationId": "setCardPinViaSMS", "requestBody": { "description": "Set Card Pin Via S M S Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SetCardPinViaSMSRequest" } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SetCardPinViaSMSResponse" } } } }, "404": { "$ref": "#/components/responses/ActionNotFound" }, "400": { "$ref": "#/components/responses/BusinessFailure" }, "500": { "$ref": "#/components/responses/TechnicalFailure" } } } }, "/Indoor/api/isSetCardPinViaSMSControl": { "post": { "tags": [ "PIN and card security" ], "summary": "Service that enables creating the PIN via SMS", "description": "Checks if a customer has any card eligible for PIN change via SMS and allows setting a new PIN for credit, debit, or prepaid cards. Validates mobile number, card last four digits, clear PIN, and bank key.", "operationId": "isSetCardPinViaSMSControl", "requestBody": { "description": "Is Set Card Pin Via S M S Control Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IsSetCardPinViaSMSControlRequest" } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IsSetCardPinViaSMSControlResponse" } } } }, "404": { "$ref": "#/components/responses/ActionNotFound" }, "400": { "$ref": "#/components/responses/BusinessFailure" }, "500": { "$ref": "#/components/responses/TechnicalFailure" } } } }, "/Indoor/api/getCreditCardLogDataListByShadowCardNumber": { "post": { "tags": [ "Card lifecycle" ], "summary": "Service that lists credit card log information based on the provided Shadow Card Number", "description": "Retrieves credit card log data for a given shadow card number. Accepts GetCreditCardLogDataListByShadowCardNumberRequest with parameters ShadowCardNumber, CustomerNumber, LogCode, StartDate, and EndDate. Returns GetCreditCardLogDataListByShadowCardNumberResponse containing a list of CreditCardLogData items, each with CardRefNumber, ShadowCardNumber, MaskedCardNumber, CustomerNumber, OldValue, NewValue, CardLogDetail, InsertChannelId, InsertChannelDescription, LogCode, LogCodeDescription, InsertDate, and InsertUserId. Internally calls _crdIssuingServiceProxy.GetCardLogDataListByShadowCardNumber(). Validates StartDate, EndDate, and ShadowCardNumber before processing.", "operationId": "getCreditCardLogDataListByShadowCardNumber", "requestBody": { "description": "Get Credit Card Log Data List By Shadow Card Number Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetCreditCardLogDataListByShadowCardNumberRequest" } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetCreditCardLogDataListByShadowCardNumberResponse" } } } }, "404": { "$ref": "#/components/responses/ActionNotFound" }, "400": { "$ref": "#/components/responses/BusinessFailure" }, "500": { "$ref": "#/components/responses/TechnicalFailure" } } } }, "/Indoor/api/setStatementDocumentId": { "post": { "tags": [ "Statements and billing" ], "summary": "Service that updates the customers card statement document ID and sends a notification", "description": "Sets or updates statement document IDs for a list of statements. For each statement in the request, it retrieves mailing info based on masked card number and statement date, then either creates a new statement document or updates an existing one. Additionally, if email sending is enabled, it triggers a notification with relevant statement and customer details. The SetStatementDocumentOnly method returns a summary of inserted, updated, and skipped rows.", "operationId": "setStatementDocumentId", "requestBody": { "description": "Set Statement Document Id Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SetStatementDocumentIdRequest" } } }, "required": true }, "responses": { "200": { "description": "Success" }, "404": { "$ref": "#/components/responses/ActionNotFound" }, "400": { "$ref": "#/components/responses/BusinessFailure" }, "500": { "$ref": "#/components/responses/TechnicalFailure" } } } }, "/Indoor/api/setStatementDocumentOnly": { "post": { "tags": [ "Statements and billing" ], "summary": "Service that updates the customers card statement document ID without sending a notification", "description": "Processes a batch of statement documents and updates the system accordingly. For each statement in the request, it retrieves mailing info based on masked card number and statement date. If no record exists, a new statement document is created; otherwise, the existing document is updated. The method returns a summary including total rows, inserted, updated, and skipped rows.", "operationId": "setStatementDocumentOnly", "requestBody": { "description": "Set Statement Document Id Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SetStatementDocumentIdRequest" } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SetStatementDocumentOnlyResponse" } } } }, "404": { "$ref": "#/components/responses/ActionNotFound" }, "400": { "$ref": "#/components/responses/BusinessFailure" }, "500": { "$ref": "#/components/responses/TechnicalFailure" } } } }, "/Indoor/api/getCardStatementCutoffReport": { "post": { "tags": [ "Statements and billing" ], "summary": "Service that returns Cutoff statement detail list using customer card information", "description": "Retrieves credit card statement cutoff information for a given ShadowCardNumber, MainCardRefNumber, and optional CustomerNumber on a specific InsertDate. Accepts GetCardStatementCutoffRequest with ShadowCardNumber, MainCardRefNumber, CustomerNumber, and InsertDate. Returns GetCardStatementCutoffResponse containing a list of CreditCardStatementCutoffItem objects, each including CardRefNumber, ShadowCardNumber, CustomerNumber, StatementDate, CapitalAmount, PurchaseInterestAmount, CashInterestAmount, PurchaseDueInterestAmount, CashDueInterestAmount, OtherFeeAmount, CardFeeAmount, CashFeeAmount, InterestBsmvAmount, InterestKkdfAmount, FeeBsmvAmount, and CashInstallmentProfitAmount. Uses _intRepository.GetCreditCardStatementCutoffReportByInsertDate internally.", "operationId": "getCardStatementCutoffReport", "requestBody": { "description": "Get Card Statement Cutoff Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetCardStatementCutoffRequest" } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetCardStatementCutoffResponse" } } } }, "404": { "$ref": "#/components/responses/ActionNotFound" }, "400": { "$ref": "#/components/responses/BusinessFailure" }, "500": { "$ref": "#/components/responses/TechnicalFailure" } } } }, "/Indoor/api/getClearPanByShadow": { "post": { "tags": [ "PIN and card security" ], "summary": "Service that displays open PIN information for the given Shadow Card Number", "description": "Resolves the clear PAN (Primary Account Number) from a given shadow card number. Accepts GetClearPanByShadowRequest with ShadowCardNumber and returns GetClearPanByShadowResponse containing ClearPan. Internally calls _cisServiceProxy.GetCardInfoByShadowCardNumber(). Also provides GetCardInfoByClearPan which retrieves detailed card information by ClearPan, returning GetCardInfoByClearPanResponse with properties like Bin, CardRefNumber, ProductNumber, CardSeqNumber, CardType, CustomerNumber, EncryptedCardNumber, ExpiryDate, HashCardNumber, MainCardRefNumber, MainCustomerNumber, MaskedCardNumber, MaskedPanAlternative, OwnerSearchName, ShadowCardNumber, StatusCode, and StatusReasonCode.", "operationId": "getClearPanByShadow", "requestBody": { "description": "Get Clear Pan By Shadow Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetClearPanByShadowRequest" } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetClearPanByShadowResponse" } } } }, "404": { "$ref": "#/components/responses/ActionNotFound" }, "400": { "$ref": "#/components/responses/BusinessFailure" }, "500": { "$ref": "#/components/responses/TechnicalFailure" } } } }, "/Indoor/api/getCardInfoByClearPan": { "post": { "tags": [ "PIN and card security" ], "summary": "Service that lists card information based on the provided open PIN", "description": "Retrieves card information for a given clear PAN (primary account number). Accepts GetCardInfoByClearPanRequest with ClearPan. Returns GetCardInfoByClearPanResponse containing Bin, CardRefNumber, ProductNumber, CardSeqNumber, CardType, ClearPan, CustomerNumber, EncryptedCardNumber, ExpiryDate, HashCardNumber, MainCardRefNumber, MainCustomerNumber, MaskedCardNumber, MaskedPanAlternative, OwnerSearchName, ShadowCardNumber, StatusCode, and StatusReasonCode.", "operationId": "getCardInfoByClearPan", "requestBody": { "description": "Get Card Info By Clear Pan Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetCardInfoByClearPanRequest" } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetCardInfoByClearPanResponse" } } } }, "404": { "$ref": "#/components/responses/ActionNotFound" }, "400": { "$ref": "#/components/responses/BusinessFailure" }, "500": { "$ref": "#/components/responses/TechnicalFailure" } } } }, "/Indoor/api/setCreditCardPin": { "post": { "tags": [ "PIN and card security" ], "summary": "Service that generates a card PIN", "description": "Sets or verifies the PIN for a credit card. The SetCreditCardPin method first validates the card status of the customer and throws an exception if the card is in an invalid or problematic state. It then calls the credit PIN management service to set the PIN and returns the encrypted PIN and success flag. The VerifyCreditCardPin method verifies the provided PIN against the credit PIN management service and returns whether it is correct, along with remaining attempt counts and whether the try limit is exceeded.", "operationId": "setCreditCardPin", "requestBody": { "description": "Set Credit Card Pin Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SetCreditCardPinRequest" } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SetCardPinResponse" } } } }, "404": { "$ref": "#/components/responses/ActionNotFound" }, "400": { "$ref": "#/components/responses/BusinessFailure" }, "500": { "$ref": "#/components/responses/TechnicalFailure" } } } }, "/Indoor/api/verifyCreditCardPin": { "post": { "tags": [ "PIN and card security" ], "summary": "Service that verifies the accuracy of the card PIN", "description": "Verifies the PIN of a credit card. The method takes the shadow card number, clear PIN, and channel as input, calls the underlying credit PIN management service, and returns whether the PIN is verified along with the remaining try count and whether the maximum try count has been exceeded.", "operationId": "verifyCreditCardPin", "requestBody": { "description": "Verify Credit Card Pin Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VerifyCreditCardPinRequest" } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VerifyCardPinResponse" } } } }, "404": { "$ref": "#/components/responses/ActionNotFound" }, "400": { "$ref": "#/components/responses/BusinessFailure" }, "500": { "$ref": "#/components/responses/TechnicalFailure" } } } }, "/Indoor/api/createDisputeCase": { "post": { "tags": [ "Disputes and chargebacks" ], "summary": "Used to initiate spending disputes from various customer interaction channels", "description": "Creates a dispute case for a card using provided card info, case type, dispute date, reason, and explanation. Maps optional dispute case details (UTID, currency, amount) and DMS references. Calls _bkmBatchService.CreateDisputeCase and returns CaseNumber and list of DisputeTransaction details including DisputeTransactionId and UTID.", "operationId": "createDisputeCase", "requestBody": { "description": "Create Dispute Case Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateDisputeCaseRequest" } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateDisputeCaseResponse" } } } }, "404": { "$ref": "#/components/responses/ActionNotFound" }, "400": { "$ref": "#/components/responses/BusinessFailure" }, "500": { "$ref": "#/components/responses/TechnicalFailure" } } } }, "/Indoor/api/cancelDisputeCase": { "post": { "tags": [ "Disputes and chargebacks" ], "summary": "Used in an ongoing dispute process when the customer withdraws the dispute request", "description": "Cancels a dispute case by calling the internal BKM batch service with CaseNumber, Channel, DisputeTransactionId, UTID, and Description. Returns a response indicating whether the cancellation was successful.", "operationId": "cancelDisputeCase", "requestBody": { "description": "Cancel Dispute Case Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CancelDisputeCaseRequest" } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CancelDisputeCaseResponse" } } } }, "404": { "$ref": "#/components/responses/ActionNotFound" }, "400": { "$ref": "#/components/responses/BusinessFailure" }, "500": { "$ref": "#/components/responses/TechnicalFailure" } } } }, "/Indoor/api/addDocumentByCaseNumber": { "post": { "tags": [ "Disputes and chargebacks" ], "summary": "Used when an ongoing dispute case requires adding a new document to the case record", "description": "Adds one or more document references to an existing case in the core banking system using the provided case number. The service accepts channel information, case number, and a list of DMS document references, and forwards them to the BKM batch service for processing. This operation performs a state-changing action by attaching documents to the specified case.", "operationId": "addDocumentByCaseNumber", "requestBody": { "description": "Add Document By Case Number Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AddDocumentByCaseNumberRequest" } } }, "required": true }, "responses": { "200": { "description": "Success" }, "404": { "$ref": "#/components/responses/ActionNotFound" }, "400": { "$ref": "#/components/responses/BusinessFailure" }, "500": { "$ref": "#/components/responses/TechnicalFailure" } } } }, "/Indoor/api/getDisputeList": { "post": { "tags": [ "Disputes and chargebacks" ], "summary": "Used to view registered case transactions and their statuses presented to the customer", "description": "Retrieves the list of dispute transactions. Accepts GetDisputeListRequest with parameters such as CardNumber, CardRefNumber, CaseNumber, CustomerNumber, DisputeTransactionId, EncryptedCardNumber, ShadowCardNumber, and UTID. Calls _bkmBatchService.GetDisputeList() and maps results to GetDisputeListResponse containing DisputeList with properties like CaseNumber, DisputeTransactionId, CustomerNumber, DisputeAmount, DisputeCurrencyCode, DisputeDate, DisputeReasonCode, MaskedCardNumber, MerchantName, TrnAmount, InsertUserId, TrnCurrencyCode, TrnDate, TrnStatusDescription, AuthorizationNumber, Mcc, SourceNetwork, and Utid.", "operationId": "getDisputeList", "requestBody": { "description": "Get Dispute List Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetDisputeListRequest" } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetDisputeListResponse" } } } }, "404": { "$ref": "#/components/responses/ActionNotFound" }, "400": { "$ref": "#/components/responses/BusinessFailure" }, "500": { "$ref": "#/components/responses/TechnicalFailure" } } } }, "/Indoor/api/getDisputeReasonDefList": { "post": { "tags": [ "Disputes and chargebacks" ], "summary": "Service that returns available dispute reasons used when creating a new dispute case via Create Dispute Case", "description": "Retrieves the list of dispute reason definitions. Calls _bkmBatchService.GetDisputeReasonDefList() and maps results to GetDisputeReasonDefResponse containing DisputeReasonDefinitions with properties DisputeReasonCode and DisputeReasonDescription.", "operationId": "getDisputeReasonDefList", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetDisputeReasonDefResponse" } } } }, "404": { "$ref": "#/components/responses/ActionNotFound" }, "400": { "$ref": "#/components/responses/BusinessFailure" }, "500": { "$ref": "#/components/responses/TechnicalFailure" } } } }, "/Indoor/api/getCardDelinquencyInfoByCustomerNumber": { "post": { "tags": [ "Collections and legal follow-up" ], "summary": "Service that returns customer delinquency information", "description": "Retrieves the delinquency information of all cards for a given main customer number. Accepts GetCardDelinquencyInfoByCustomerNumberRequest with MainCustomerNumber. Returns GetCardDelinquencyInfoByCustomerNumberResponse containing DigitalCardLimit, CustomerLimit, DelinquencyStatus, DelinquencyDayCount, StatementRemainAmount, DelinquencyPeriod, NewDeficientPaymentCounter, DayCoutAfterLimitIncrease, and DayCoutAfterLimitDecrease.", "operationId": "getCardDelinquencyInfoByCustomerNumber", "requestBody": { "description": "Get Card Delinquency Info By Customer Number Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetCardDelinquencyInfoByCustomerNumberRequest" } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetCardDelinquencyInfoByCustomerNumberResponse" } } } }, "404": { "$ref": "#/components/responses/ActionNotFound" }, "400": { "$ref": "#/components/responses/BusinessFailure" }, "500": { "$ref": "#/components/responses/TechnicalFailure" } } } }, "/Indoor/api/getDebitCardForRewardByBank": { "post": { "tags": [ "Campaigns and rewards" ], "summary": "Service that returns shadow and masked card numbers for the given customer number", "description": "Retrieves the debit card information eligible for rewards for a given customer. Accepts GetDebitCardForRewardByBankRequest with CustomerNumber and Channel. Calls _debitManagementServiceProxy.GetDebitCardForRewardByBank() and returns GetDebitCardForRewardByBankResponse containing AccountNumber, MaskedCardNumber, and ShadowCardNumber.", "operationId": "getDebitCardForRewardByBank", "requestBody": { "description": "Get Debit Card For Reward By Bank Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetDebitCardForRewardByBankRequest" } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetDebitCardForRewardByBankResponse" } } } }, "404": { "$ref": "#/components/responses/ActionNotFound" }, "400": { "$ref": "#/components/responses/BusinessFailure" }, "500": { "$ref": "#/components/responses/TechnicalFailure" } } } }, "/Indoor/api/createFollowUpByMainCustomerNumber": { "post": { "tags": [ "Collections and legal follow-up" ], "summary": "Service that closes customer cards based on customer number and forwards the customer to the Legal Follow-Up queue", "description": "Creates a follow-up for a corporate customer using MainCustomerNumber. Validates customer exists and is corporate. Cancels active main cards (excluding supplementary and already bank-cancelled cards) by calling ChangeCardStatus on each. Finally, creates follow-up queue entry using MainCustomerNumber and Channel.", "operationId": "createFollowUpByMainCustomerNumber", "requestBody": { "description": "Create Follow Up By Main Customer Number Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateFollowUpByMainCustomerNumberRequest" } } }, "required": true }, "responses": { "200": { "description": "Success" }, "404": { "$ref": "#/components/responses/ActionNotFound" }, "400": { "$ref": "#/components/responses/BusinessFailure" }, "500": { "$ref": "#/components/responses/TechnicalFailure" } } } }, "/Indoor/api/getCardByCardNumber": { "post": { "tags": [ "Card lifecycle" ], "summary": "Service that lists card details based on an open card number", "description": "Retrieves detailed card information for a given card number (PAN) and optional PAN sequence number. Accepts GetCardByCardNumberRequest containing CardNumber and PanSequenceNumber. Returns GetCardByCardNumberResponse with Bin, CardNumber, CardRefNumber, CardSeqNumber, CardType, CustomerNumber, EncryptedCardNumber, ExpiryDate, HashCardNumber, MainCardRefNumber, MainCustomerNumber, MaskedCardNumber, MaskedPanAlternative, OwnerSearchName, ProductNumber, StatusCode, and StatusReasonCode.", "operationId": "getCardByCardNumber", "requestBody": { "description": "Get Card By Card Number Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetCardByCardNumberRequest" } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetCardByCardNumberResponse" } } } }, "404": { "$ref": "#/components/responses/ActionNotFound" }, "400": { "$ref": "#/components/responses/BusinessFailure" }, "500": { "$ref": "#/components/responses/TechnicalFailure" } } } }, "/Indoor/api/getAssetByShadowCardNumber": { "post": { "tags": [ "Customers" ], "summary": "Service that lists card information based on the provided Shadow Card Number", "description": "Retrieves debit card asset information based on the ShadowCardNumber. Calls the CIS service proxy to fetch details and maps them to GetAssetByShadowCardNumberResponse, including Bin, ProductNumber, OwnerSearchName, CardRefNumber, CardStatusCode, CardStatusReasonCode, CustomerNumber, EmbossName, ExpiryDate, InsertDate, InsertUserId, MainCardRefNumber, MainCustomerNumber, MaskedCardNumber, MaskedPanAlternative, OwnerName, OwnerSecondName, OwnerSurname, PSN, ServiceDomainId, and SupplementaryCard flag.", "operationId": "getAssetByShadowCardNumber", "requestBody": { "description": "Get Asset By Shadow Card Number Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetAssetByShadowCardNumberRequest" } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetAssetByShadowCardNumberResponse" } } } }, "404": { "$ref": "#/components/responses/ActionNotFound" }, "400": { "$ref": "#/components/responses/BusinessFailure" }, "500": { "$ref": "#/components/responses/TechnicalFailure" } } } }, "/Indoor/api/getSecureCardByPan": { "post": { "tags": [ "Card lifecycle" ], "summary": "Service that displays secure card information based on an open card number", "description": "Retrieves secure card information using the PAN. The response includes encrypted card number, hashed card number, first six digits, first eight digits, last four digits, and a record ID.", "operationId": "getSecureCardByPan", "requestBody": { "description": "Get Secure Card By Pan Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetSecureCardByPanRequest" } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetSecureCardByPanResponse" } } } }, "404": { "$ref": "#/components/responses/ActionNotFound" }, "400": { "$ref": "#/components/responses/BusinessFailure" }, "500": { "$ref": "#/components/responses/TechnicalFailure" } } } }, "/Indoor/api/getMccGroupAll": { "post": { "tags": [ "Reference data" ], "summary": "Service that lists all MCC group information", "description": "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.", "operationId": "getMccGroupAll", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetMccGroupAllResponse" } } } }, "404": { "$ref": "#/components/responses/ActionNotFound" }, "400": { "$ref": "#/components/responses/BusinessFailure" }, "500": { "$ref": "#/components/responses/TechnicalFailure" } } } }, "/Indoor/api/getTrnStatusAll": { "post": { "tags": [ "Reference data" ], "summary": "Service that lists all transaction status information", "description": "Retrieves all transaction statuses along with their codes, descriptions, and validity flags for core banking integration.", "operationId": "getTrnStatusAll", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetTrnStatusAllResponse" } } } }, "404": { "$ref": "#/components/responses/ActionNotFound" }, "400": { "$ref": "#/components/responses/BusinessFailure" }, "500": { "$ref": "#/components/responses/TechnicalFailure" } } } }, "/Indoor/api/getBinDomesticByBin": { "post": { "tags": [ "Reference data" ], "summary": "Service that lists local card information based on the provided BIN", "description": "Service that lists local card information based on the provided BIN.", "operationId": "getBinDomesticByBin", "requestBody": { "description": "Get Bin Domestic By Bin Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetBinDomesticByBinRequest" } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetBinDomesticByBinResponse" } } } }, "404": { "$ref": "#/components/responses/ActionNotFound" }, "400": { "$ref": "#/components/responses/BusinessFailure" }, "500": { "$ref": "#/components/responses/TechnicalFailure" } } } }, "/Indoor/api/getEncryptDataBlock": { "post": { "tags": [ "PIN and card security" ], "summary": "Service that retrieves the encrypted data block", "description": "Encrypts a given data block using KMT service. Validates input DataBlock, retrieves encryption parameters from cache, calls _kmtServiceProxy.EncryptDataBlock() with KeyId, IV, and CBC mode, and returns GetEncryptDataBlockResponse containing EncryptedDataBlock.", "operationId": "getEncryptDataBlock", "requestBody": { "description": "Get Encrypt Data Block Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetEncryptDataBlockRequest" } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetEncryptDataBlockResponse" } } } }, "404": { "$ref": "#/components/responses/ActionNotFound" }, "400": { "$ref": "#/components/responses/BusinessFailure" }, "500": { "$ref": "#/components/responses/TechnicalFailure" } } } }, "/Indoor/api/getCustomerDetail": { "post": { "tags": [ "Customers" ], "summary": "Service that lists detailed customer information", "description": "Retrieves detailed customer information, including personal, firm, and contact details. Accepts GetCustomerDetailRequest containing CustomerNumber, Channel, CommCompanyCode, and flags for including address, email, GSM, and phone details. Returns GetCustomerDetailResponse with a Customer object containing MasterInformation, PersonalInformation, FirmInformation, ListOfAddress, ListOfEmail, ListOfGSM, and ListOfPhone. Calls _cisServiceProxy.GetCustomerDetail() and maps the response to internal data structures. Null is returned if the customer does not exist.", "operationId": "getCustomerDetail", "requestBody": { "description": "Get Customer Detail Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetCustomerDetailRequest" } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetCustomerDetailResponse" } } } }, "404": { "$ref": "#/components/responses/ActionNotFound" }, "400": { "$ref": "#/components/responses/BusinessFailure" }, "500": { "$ref": "#/components/responses/TechnicalFailure" } } } }, "/Indoor/api/getApplicableProducts": { "post": { "tags": [ "Reference data" ], "summary": "Service that lists eligible products", "description": "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.", "operationId": "getApplicableProducts", "requestBody": { "description": "Get Applicable Products Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetApplicableProductsRequest" } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetApplicableProductsResponse" } } } }, "404": { "$ref": "#/components/responses/ActionNotFound" }, "400": { "$ref": "#/components/responses/BusinessFailure" }, "500": { "$ref": "#/components/responses/TechnicalFailure" } } } }, "/Indoor/api/decryptDataBlock": { "post": { "tags": [ "PIN and card security" ], "summary": "Service that decrypts the data block", "description": "Decrypts an encrypted data block using KMT service. Validates that EncryptDataBlock is not null or empty, retrieves encryption parameters from cache, calls DecryptDataBlock on KMT proxy with KeyId, IV, and CBC mode, and returns the clear data block.", "operationId": "decryptDataBlock", "requestBody": { "description": "Decrypt Data Block Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DecryptDataBlockRequest" } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DecryptDataBlockResponse" } } } }, "404": { "$ref": "#/components/responses/ActionNotFound" }, "400": { "$ref": "#/components/responses/BusinessFailure" }, "500": { "$ref": "#/components/responses/TechnicalFailure" } } } }, "/Indoor/api/getCardByShadowCardNumber": { "post": { "tags": [ "Card lifecycle" ], "summary": "Service that lists card information based on the Shadow Card Number", "description": "Service that lists card information based on the Shadow Card Number.", "operationId": "getCardByShadowCardNumber", "requestBody": { "description": "Get Card By Shadow Card Number Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetCardByShadowCardNumberRequest" } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetCardByShadowCardNumberResponse" } } } }, "404": { "$ref": "#/components/responses/ActionNotFound" }, "400": { "$ref": "#/components/responses/BusinessFailure" }, "500": { "$ref": "#/components/responses/TechnicalFailure" } } } }, "/Indoor/api/addToLegalFollowUp": { "post": { "tags": [ "Collections and legal follow-up" ], "summary": "Service that marks the customer as Legal Follow-Up", "description": "Adds a customer account to the legal follow-up queue, including business key and follow-up reason. Ensures validation of input parameters before invoking the legal management service.", "operationId": "addToLegalFollowUp", "requestBody": { "description": "Add To Legal Follow Up Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AddToLegalFollowUpRequest" } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AddToLegalFollowUpResponse" } } } }, "404": { "$ref": "#/components/responses/ActionNotFound" }, "400": { "$ref": "#/components/responses/BusinessFailure" }, "500": { "$ref": "#/components/responses/TechnicalFailure" } } } }, "/Indoor/api/createCustomer": { "post": { "tags": [ "Customers" ], "description": "Create Customer\n\n**Part of:**\n\n- Journey 01 · Launching a new card product — step 3, Register the customer", "operationId": "createCustomer", "requestBody": { "description": "Create Customer Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateCustomerRequest" } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateCustomerResponse" } } } }, "404": { "$ref": "#/components/responses/ActionNotFound" }, "400": { "$ref": "#/components/responses/BusinessFailure" }, "500": { "$ref": "#/components/responses/TechnicalFailure" } }, "x-everest-journeys": [ { "journey": "launch", "journeyName": "Launching a new card product", "n": "01", "section": "credit", "step": 3, "title": "Register the customer" } ] } }, "/Indoor/api/updateCustomer": { "post": { "tags": [ "Customers" ], "description": "Update Customer", "operationId": "updateCustomer", "requestBody": { "description": "Update Customer Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateCustomerRequest" } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateCustomerResponse" } } } }, "404": { "$ref": "#/components/responses/ActionNotFound" }, "400": { "$ref": "#/components/responses/BusinessFailure" }, "500": { "$ref": "#/components/responses/TechnicalFailure" } } } }, "/Indoor/api/getAuthorizationListByBegindateEnddate": { "post": { "tags": [ "Transactions" ], "summary": "Service that lists authorization transactions within the specified date range", "description": "Retrieves a list of authorization transactions based on the provided date range and optional filters. The method accepts GetAuthorizationListByBegindateEnddateRequest containing GetAuthorizationListByBegindateEnddateParam, which allows filtering by AuthStatus, BeginDate, EndDate, MaxAmount, MinAmount, NetworkType, ResponseCode, ResponseReasonCode, ShadowCardNumber, and TrnCodeMatrixId. The response returns GetAuthorizationListByBegindateEnddateResponse containing a list of GetAuthorizationListByBegindateEnddateResult items, including details such as AuthorizationNumber, CardRefNumber, CustomerNumber, ShadowCardNumber, TransactionDate, TrnAmount, TrnCurrencyDescription, TrnStatusDescription, MerchantName, MerchantCountryCode, ChannelTypeDescription, TerminalNumber, and other authorization-related metadata.", "operationId": "getAuthorizationListByBegindateEnddate", "requestBody": { "description": "Get Authorization List By Begindate Enddate Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetAuthorizationListByBegindateEnddateRequest" } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetAuthorizationListByBegindateEnddateResponse" } } } }, "404": { "$ref": "#/components/responses/ActionNotFound" }, "400": { "$ref": "#/components/responses/BusinessFailure" }, "500": { "$ref": "#/components/responses/TechnicalFailure" } } } }, "/Indoor/api/getAutoPaymentQueue": { "post": { "tags": [ "Debt payment" ], "summary": "Service that lists the automatic payment instruction queue", "description": "Retrieves a list of scheduled auto payments for credit card customers within a specified date range and pagination limits. The method accepts GetAutoPaymentQueueRequest containing GetAutoPaymentQueueParam with StartRowNo, EndRowNo, and DueDate. The response returns GetAutoPaymentQueueResponse with a list of GetAutoPaymentQueueResult items, including CustomerNumber, MainCardRefNumber, ShadowCardNumber, MaskedCardNumber, PaymentAccount details, DailyPaymentAmount, PaymentTotalCurrent, RemainingAmount, Statement details, PaymentType, and RemainingMinimumPaymentAmount (calculated from the latest statement).", "operationId": "getAutoPaymentQueue", "requestBody": { "description": "Get Auto Payment Queue Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetAutoPaymentQueueRequest" } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetAutoPaymentQueueResponse" } } } }, "404": { "$ref": "#/components/responses/ActionNotFound" }, "400": { "$ref": "#/components/responses/BusinessFailure" }, "500": { "$ref": "#/components/responses/TechnicalFailure" } } } }, "/Indoor/api/getDbttransactionByCardrefCustomernum": { "post": { "tags": [ "Transactions" ], "summary": "Service that lists in-period debit transactions", "description": "Retrieves DBT transactions for a given card reference or customer number. \nAccepts GetDbttransactionByCardrefCustomernumRequest with GetDbttransactionByCardrefCustomernumParam containing filters such as CustomerNumber, MainCardRefNumber, CardSeqNumber, TransactionDateBegin, TransactionDateEnd, MCC, RRN, TRN_STATUS, TRN_CODE_MATRIX_ID, ResponseCode, NetworkType, AuthorizationMatchStatus, MinAmount, MaxAmount, EmbossName, SourceNetwork. \nReturns GetDbttransactionByCardrefCustomernumResponse containing a list of GetDbttransactionByCardrefCustomernumResult items. \nEach result item includes transaction details such as PAN_ENTRY_MODE, MASKED_CARD_NUMBER, MAIN_CARD_REF_NUMBER, CUSTOMER_NUMBER, MAIN_CUSTOMER_NUMBER, PRODUCT, CHANNEL_TYPE_DESCRIPTION, NETWORK_DESCRIPTION, TERMINAL_TYPE, SETTLEMENT_AMOUNT, SETTLEMENT_CURRENCY, CLEARING_NUMBER, CLEARING_CHANNEL, CLEARING_DATE, TRN_CODE_MATRIX_DESC, TRN_AMOUNT, TRN_CURRENCY, LOCAL_AMOUNT, LOCAL_CURRENCY, TRN_DATE, EARNED_REWARD_MERCHANT, EARNED_REWARD_BANK, REWARD_TYPE_DESCRIPTION, MCC_DESCRIPTION, AUTHORIZATION_NUMBER, TERMINAL_NUMBER, MERCHANT_NAME, MERCHANT_CITY, MERCHANT_COUNTRY_CODE, BKM_UNIQUE_MERCHANT_ID, MERCHANT_AMEX_ID, INVOICE_NUMBER, DISPLAY_AT_CHANNELS, TRN_DESCRIPTION, EOD_DATE, TRN_ORIGIN, ACQ_REF_NUMBER, CAMPAIGN_CODE_ACQ, CAMPAIGN_CODE_ISS, EARNED_REWARD_CAMPAIGN_ISS, EARNED_REWARD_CAMPAIGN_ACQ, REF_UTID, UTID, REQUEST_DATE, OFFLINE_FLAG, EMBOSS_NAME, CARD_SEQ_NUMBER, AUTHORIZATION_MATCH_STATUS, CURRENCY_CODE_DESCRIPTION, MATCH_STATUS_DESCRIPTION, RRN, TRN_STATUS_DESCRIPTION, BILLING_AMOUNT, BILLING_CURRENCY, PIN_USAGE, IS_CHIP_FLAG. \nCalls _intRepository.GetDbttransactionByCardrefCustomernum() and maps results to internal structure.", "operationId": "getDbttransactionByCardrefCustomernum", "requestBody": { "description": "Get Dbttransaction By Cardref Customernum Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetDbttransactionByCardrefCustomernumRequest" } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetDbttransactionByCardrefCustomernumResponse" } } } }, "404": { "$ref": "#/components/responses/ActionNotFound" }, "400": { "$ref": "#/components/responses/BusinessFailure" }, "500": { "$ref": "#/components/responses/TechnicalFailure" } } } }, "/Indoor/api/getMccDefinitionGroupbyMccMccdescription": { "post": { "tags": [ "Reference data" ], "summary": "Service that lists all MCC information with descriptions", "description": "Retrieves MCC definition groups by MCC and MCC description from the internal repository using _intRepository.GetMccDefinitionGroupbyMccMccdescription().", "operationId": "getMccDefinitionGroupbyMccMccdescription", "responses": { "200": { "description": "Success" }, "404": { "$ref": "#/components/responses/ActionNotFound" }, "400": { "$ref": "#/components/responses/BusinessFailure" }, "500": { "$ref": "#/components/responses/TechnicalFailure" } } } }, "/Indoor/api/getNetworkTypeDefByValidFlag": { "post": { "tags": [ "Reference data" ], "summary": "Service that lists valid network types", "description": "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.", "operationId": "getNetworkTypeDefByValidFlag", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetNetworkTypeDefByValidFlagResponse" } } } }, "404": { "$ref": "#/components/responses/ActionNotFound" }, "400": { "$ref": "#/components/responses/BusinessFailure" }, "500": { "$ref": "#/components/responses/TechnicalFailure" } } } }, "/Indoor/api/getResponseCodeDefByValidFlag": { "post": { "tags": [ "Reference data" ], "summary": "Service that lists valid response codes", "description": "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.", "operationId": "getResponseCodeDefByValidFlag", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetResponseCodeDefByValidFlagResponse" } } } }, "404": { "$ref": "#/components/responses/ActionNotFound" }, "400": { "$ref": "#/components/responses/BusinessFailure" }, "500": { "$ref": "#/components/responses/TechnicalFailure" } } } }, "/Indoor/api/getResponseReasonCodeDefByValidFlag": { "post": { "tags": [ "Reference data" ], "summary": "Service that lists valid response reason codes", "description": "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.", "operationId": "getResponseReasonCodeDefByValidFlag", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetResponseReasonCodeDefByValidFlagResponse" } } } }, "404": { "$ref": "#/components/responses/ActionNotFound" }, "400": { "$ref": "#/components/responses/BusinessFailure" }, "500": { "$ref": "#/components/responses/TechnicalFailure" } } } }, "/Indoor/api/getTrnCodeDefByValidFlag": { "post": { "tags": [ "Reference data" ], "summary": "Service that lists valid transaction codes", "description": "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.", "operationId": "getTrnCodeDefByValidFlag", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetTrnCodeDefByValidFlagResponse" } } } }, "404": { "$ref": "#/components/responses/ActionNotFound" }, "400": { "$ref": "#/components/responses/BusinessFailure" }, "500": { "$ref": "#/components/responses/TechnicalFailure" } } } }, "/Indoor/api/getTrnCodeMatrixByValidFlag": { "post": { "tags": [ "Reference data" ], "summary": "Service that lists valid Trn Code Matrix information", "description": "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.", "operationId": "getTrnCodeMatrixByValidFlag", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetTrnCodeMatrixByValidFlagResponse" } } } }, "404": { "$ref": "#/components/responses/ActionNotFound" }, "400": { "$ref": "#/components/responses/BusinessFailure" }, "500": { "$ref": "#/components/responses/TechnicalFailure" } } } }, "/Indoor/api/healthCheck": { "post": { "tags": [ "Platform operations" ], "summary": "Method that checks whether the service is operational", "description": "Performs a health check on the CoreBankingIntegrationIndoor service, returning the current server date and a result status.", "operationId": "healthCheck", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HealthCheckResponse" } } } }, "404": { "$ref": "#/components/responses/ActionNotFound" }, "400": { "$ref": "#/components/responses/BusinessFailure" }, "500": { "$ref": "#/components/responses/TechnicalFailure" } } } }, "/Indoor/api/refreshCache": { "post": { "tags": [ "Platform operations" ], "summary": "Refresh Cache", "description": "Refreshes and loads all cached data including card products, parameters, BINs, card statuses, campaigns, statement operation codes, MCC groups, transaction statuses, applicable products, and domestic BINs. Provides helper methods to get cached values and validate PIN patterns.", "operationId": "refreshCache", "responses": { "200": { "description": "Success" }, "404": { "$ref": "#/components/responses/ActionNotFound" }, "400": { "$ref": "#/components/responses/BusinessFailure" }, "500": { "$ref": "#/components/responses/TechnicalFailure" } } } } }, "components": { "schemas": { "AccountStatusReq": { "required": [ "timeStamp" ], "type": "object", "properties": { "transactionID": { "type": "string", "description": "Transaction Id - [Optional]", "nullable": true }, "dsTransID": { "type": "string", "description": "Ds Trans Id - [Optional]", "nullable": true }, "sourceSystem": { "type": "string", "description": "Source System - [Optional]", "nullable": true }, "version": { "type": "string", "description": "Version - [Optional]", "nullable": true }, "timeStamp": { "type": "integer", "description": "Time Stamp - [Optional]", "format": "int64" }, "cardHolderData": { "allOf": [ { "$ref": "#/components/schemas/CardHolderData" } ], "description": "Card Holder Data - [Optional]", "nullable": true }, "transactionData": { "allOf": [ { "$ref": "#/components/schemas/TransactionData" } ], "description": "Transaction Data - [Optional]", "nullable": true }, "deviceData": { "allOf": [ { "$ref": "#/components/schemas/DeviceData" } ], "description": "Device Data - [Optional]", "nullable": true }, "merchantData": { "allOf": [ { "$ref": "#/components/schemas/MerchantData" } ], "description": "Merchant Data - [Optional]", "nullable": true } } }, "AccountStatusRes": { "required": [ "timeStamp" ], "type": "object", "properties": { "transactionID": { "type": "string", "description": "Transaction Id - [Optional]", "nullable": true }, "memberRefID": { "type": "string", "description": "Member Ref Id - [Optional]", "nullable": true }, "status": { "type": "string", "description": "Status - [Optional]", "nullable": true }, "challengeType": { "type": "integer", "description": "Challenge Type - [Optional]", "format": "int32", "nullable": true }, "language": { "type": "string", "description": "Language - [Optional]", "nullable": true }, "riskValue": { "type": "string", "description": "Risk Value - [Optional]", "nullable": true }, "mobileNo": { "allOf": [ { "$ref": "#/components/schemas/MobileNo" } ], "description": "Mobile No - [Optional]", "nullable": true }, "timeStamp": { "type": "integer", "description": "Time Stamp - [Optional]", "format": "int64" }, "version": { "type": "string", "description": "Version - [Optional]", "nullable": true }, "result": { "allOf": [ { "$ref": "#/components/schemas/Result" } ], "description": "Result - [Optional]", "nullable": true } } }, "AddDocumentByCaseNumberRequest": { "required": [ "CaseNumber" ], "type": "object", "properties": { "Channel": { "type": "string", "description": "Channel - [Optional]", "nullable": true }, "CaseNumber": { "type": "integer", "description": "Case Number - [Optional]", "format": "int32" }, "DmsReference": { "type": "array", "items": { "$ref": "#/components/schemas/DmsReferences" }, "description": "Dms References - [Optional]", "nullable": true } } }, "AddToLegalFollowUpRequest": { "required": [ "MainCustomerNumber", "FollowupReason" ], "type": "object", "properties": { "MainCustomerNumber": { "type": "integer", "description": "Main Customer Number - [Optional]", "format": "int64" }, "BusinessKey": { "type": "number", "description": "Business Key - [Optional]", "format": "double", "nullable": true }, "FollowupReason": { "type": "integer", "description": "Followup Reason - [Optional]", "format": "int32" } } }, "AddToLegalFollowUpResponse": { "required": [ "isSuccess", "responseTime" ], "type": "object", "properties": { "isSuccess": { "type": "boolean", "description": "Is Success - [Optional]" }, "errorCode": { "type": "string", "description": "Error Code - [Optional]", "nullable": true }, "message": { "type": "string", "description": "Message - [Optional]", "nullable": true }, "responseTime": { "type": "string", "description": "Response Time - [Optional]", "format": "date-time" } } }, "ApplicableProductFilter": { "type": "object", "properties": { "productGroupCode": { "type": "string", "description": "Product Group Code - [Optional]", "nullable": true } } }, "AttachDebitCardAccountRequest": { "required": [ "fecCode", "accountBranchId", "accountSuffix", "accountNumber", "accountOrderFlag" ], "type": "object", "properties": { "fecCode": { "type": "integer", "description": "Fec Code - [Optional]", "format": "int32" }, "accountBranchId": { "type": "integer", "description": "Account Branch Id - [Optional]", "format": "int32" }, "accountType": { "type": "string", "description": "Account Type - [Optional]", "nullable": true }, "accountSuffix": { "type": "integer", "description": "Account Suffix - [Optional]", "format": "int32" }, "accountNumber": { "type": "integer", "description": "Account Number - [Optional]", "format": "int64" }, "shadowCardNumber": { "type": "string", "description": "Shadow Card Number - [Optional]", "nullable": true }, "accountAlias": { "type": "string", "description": "Account Alias - [Optional]", "nullable": true }, "iban": { "type": "string", "description": "Iban - [Optional]", "nullable": true }, "accountOrderFlag": { "type": "boolean", "description": "Account Order Flag - [Optional]" } } }, "AttachDebitCardAccountResponse": { "required": [ "recordId" ], "type": "object", "properties": { "recordId": { "type": "integer", "description": "Record Id - [Optional]", "format": "int64" } } }, "CancelDebitEmbossByShadowCardNumberRequest": { "type": "object", "properties": { "shadowCardNumber": { "type": "string", "description": "Shadow Card Number - [Optional]", "nullable": true }, "channel": { "type": "string", "description": "Channel - [Optional]", "nullable": true } } }, "CancelDisputeCaseRequest": { "required": [ "CaseNumber", "DisputeTransactionId" ], "type": "object", "properties": { "Channel": { "type": "string", "description": "Channel - [Optional]", "nullable": true }, "CaseNumber": { "type": "integer", "description": "Case Number - [Optional]", "format": "int32" }, "DisputeTransactionId": { "type": "integer", "description": "Dispute Transaction Id - [Optional]", "format": "int64" }, "UTID": { "type": "string", "description": "U T I D - [Optional]", "nullable": true }, "Description": { "type": "string", "description": "Description - [Optional]", "nullable": true } } }, "CancelDisputeCaseResponse": { "required": [ "isSuccessful" ], "type": "object", "properties": { "isSuccessful": { "type": "boolean", "description": "Is Successful - [Optional]" } } }, "CancelEmbossByShadowCardNumberRequest": { "type": "object", "properties": { "shadowCardNumber": { "type": "string", "description": "Shadow Card Number - [Optional]", "nullable": true }, "channel": { "type": "string", "description": "Channel - [Optional]", "nullable": true } } }, "CardAccountInfo": { "required": [ "accountNumber", "accountBranchId", "fecCode" ], "type": "object", "properties": { "accountNumber": { "type": "integer", "description": "Account Number - [Optional]", "format": "int64" }, "accountType": { "type": "string", "description": "Account Type - [Optional]", "nullable": true }, "accountBranchId": { "type": "integer", "description": "Account Branch Id - [Optional]", "format": "int32" }, "accountOrderFlag": { "type": "boolean", "description": "Account Order Flag - [Optional]", "nullable": true }, "fecCode": { "type": "integer", "description": "Fec Code - [Optional]", "format": "int32" } } }, "CardHolderData": { "type": "object", "properties": { "encryptedAccountNumber": { "allOf": [ { "$ref": "#/components/schemas/EncryptedAccountNumber" } ], "description": "Encrypted Account Number - [Optional]", "nullable": true }, "cardExpiryDate": { "type": "integer", "description": "Card Expiry Date - [Optional]", "format": "int32", "nullable": true }, "cardHolderName": { "type": "string", "description": "Cardholder Name - [Optional]", "nullable": true }, "addrMatch": { "type": "string", "description": "Addr Match - [Optional]", "nullable": true }, "billAddrCity": { "type": "string", "description": "Bill Addr City - [Optional]", "nullable": true }, "billAddrCountry": { "type": "string", "description": "Bill Addr Country - [Optional]", "nullable": true }, "billAddrLine1": { "type": "string", "description": "Bill Addr Line1 - [Optional]", "nullable": true }, "billAddrLine2": { "type": "string", "description": "Bill Addr Line2 - [Optional]", "nullable": true }, "billAddrLine3": { "type": "string", "description": "Bill Addr Line3 - [Optional]", "nullable": true }, "billAddrPostCode": { "type": "string", "description": "Bill Addr Post Code - [Optional]", "nullable": true }, "email": { "type": "string", "description": "Email - [Optional]", "nullable": true }, "homePhone": { "allOf": [ { "$ref": "#/components/schemas/HomePhone" } ], "description": "Home Phone - [Optional]", "nullable": true }, "mobilePhone": { "allOf": [ { "$ref": "#/components/schemas/MobilePhone" } ], "description": "Mobile Phone - [Optional]", "nullable": true }, "shipAddrCity": { "type": "string", "description": "Ship Addr City - [Optional]", "nullable": true }, "shipAddrCountry": { "type": "string", "description": "Ship Addr Country - [Optional]", "nullable": true }, "shipAddrLine1": { "type": "string", "description": "Ship Addr Line1 - [Optional]", "nullable": true }, "shipAddrLine2": { "type": "string", "description": "Ship Addr Line2 - [Optional]", "nullable": true }, "shipAddrLine3": { "type": "string", "description": "Ship Addr Line3 - [Optional]", "nullable": true }, "shipAddrPostCode": { "type": "string", "description": "Ship Addr Post Code - [Optional]", "nullable": true }, "workPhone": { "allOf": [ { "$ref": "#/components/schemas/WorkPhone" } ], "description": "Work Phone - [Optional]", "nullable": true }, "acctInfo": { "allOf": [ { "$ref": "#/components/schemas/CardholderAccount" } ], "description": "Acct Info - [Optional]", "nullable": true } } }, "CardLogData": { "type": "object", "properties": { "cardRefNumber": { "type": "string", "description": "Card Ref Number - [Optional]", "nullable": true }, "shadowCardNumber": { "type": "string", "description": "Shadow Card Number - [Optional]", "nullable": true }, "maskedCardNumber": { "type": "string", "description": "Masked Card Number - [Optional]", "nullable": true }, "customerNumber": { "type": "integer", "description": "Customer Number - [Optional]", "format": "int64", "nullable": true }, "logCode": { "type": "string", "description": "Log Code - [Optional]", "nullable": true }, "logCodeDescription": { "type": "string", "description": "Log Code Description - [Optional]", "nullable": true }, "oldValue": { "type": "string", "description": "Old Value - [Optional]", "nullable": true }, "newValue": { "type": "string", "description": "New Value - [Optional]", "nullable": true }, "cardLogDetail": { "type": "string", "description": "Card Log Detail - [Optional]", "nullable": true }, "insertChannelId": { "type": "string", "description": "Insert Channel Id - [Optional]", "nullable": true }, "insertChannelDescription": { "type": "string", "description": "Insert Channel Description - [Optional]", "nullable": true }, "insertUserId": { "type": "string", "description": "Insert User Id - [Optional]", "nullable": true }, "insertDate": { "type": "string", "description": "Insert Date - [Optional]", "format": "date-time", "nullable": true } } }, "CardRestriction": { "type": "object", "properties": { "restrictionCode": { "type": "string", "description": "Restriction Code - [Optional]", "nullable": true }, "restrictionCodeDescription": { "type": "string", "description": "Restriction Code Description - [Optional]", "nullable": true }, "restrictionPermissionIndicator": { "type": "string", "description": "Restriction Permission Indicator - [Optional]", "nullable": true }, "restrictionPermissionIndicatorDescription": { "type": "string", "description": "Restriction Permission Indicator Description - [Optional]", "nullable": true } } }, "CardholderAccount": { "type": "object", "properties": { "chAccAgeInd": { "type": "string", "description": "Ch Acc Age Ind - [Optional]", "nullable": true }, "chAccDate": { "type": "string", "description": "Ch Acc Date - [Optional]", "nullable": true }, "chAccChangeInd": { "type": "string", "description": "Ch Acc Change Ind - [Optional]", "nullable": true }, "chAccChange": { "type": "string", "description": "Ch Acc Change - [Optional]", "nullable": true }, "chAccPwChangeInd": { "type": "string", "description": "Ch Acc Pw Change Ind - [Optional]", "nullable": true }, "chAccPwChange": { "type": "string", "description": "Ch Acc Pw Change - [Optional]", "nullable": true }, "shipAddressUsageInd": { "type": "string", "description": "Ship Address Usage Ind - [Optional]", "nullable": true }, "shipAddressUsage": { "type": "string", "description": "Ship Address Usage - [Optional]", "nullable": true }, "txnActivityDay": { "type": "string", "description": "Txn Activity Day - [Optional]", "nullable": true }, "txnActivityYear": { "type": "string", "description": "Txn Activity Year - [Optional]", "nullable": true }, "provisionAttemptsDay": { "type": "string", "description": "Provision Attempts Day - [Optional]", "nullable": true }, "nbPurchaseAccount": { "type": "string", "description": "Nb Purchase Account - [Optional]", "nullable": true }, "suspiciousAccActivity": { "type": "string", "description": "Suspicious Acc Activity - [Optional]", "nullable": true }, "shipNameIndicator": { "type": "string", "description": "Ship Name Indicator - [Optional]", "nullable": true }, "paymentAccInd": { "type": "string", "description": "Payment Acc Ind - [Optional]", "nullable": true }, "paymentAccAge": { "type": "string", "description": "Payment Acc Age - [Optional]", "nullable": true } } }, "ChangeCreditCardLimitRequest": { "required": [ "changeCustomerLimit" ], "type": "object", "properties": { "channel": { "type": "string", "description": "Channel - [Optional]", "nullable": true }, "shadowCardNumber": { "type": "string", "description": "Shadow Card Number - [Optional]", "nullable": true }, "limit": { "type": "number", "description": "Limit - [Optional]", "format": "double", "nullable": true }, "cardRefNumber": { "type": "string", "description": "Card Ref Number - [Optional]", "nullable": true }, "limitRatio": { "type": "number", "description": "Limit Ratio - [Optional]", "format": "double", "nullable": true }, "cashLimitRatio": { "type": "number", "description": "Cash Limit Ratio - [Optional]", "format": "double", "nullable": true }, "changeCustomerLimit": { "type": "boolean", "description": "Change Customer Limit - [Optional]" }, "cardProfileSetCode": { "type": "string", "description": "Card Profile Set Code - [Optional]", "nullable": true } } }, "ChangeCreditCardLimitResponse": { "type": "object" }, "ChangeCustomerLimitRequest": { "required": [ "customerNumber", "newCustomerLimit" ], "type": "object", "properties": { "customerNumber": { "type": "integer", "description": "Customer Number - [Optional]", "format": "int64" }, "newCustomerLimit": { "type": "number", "description": "New Customer Limit - [Optional]", "format": "double" }, "cardProfileSetCode": { "type": "string", "description": "Card Profile Set Code - [Optional]", "nullable": true } } }, "ChangeCustomerLimitResponse": { "type": "object" }, "ChangeDebitCardBranchRequest": { "required": [ "targetBranchCode" ], "type": "object", "properties": { "shadowCardNumber": { "type": "string", "description": "Shadow Card Number - [Optional]", "nullable": true }, "targetBranchCode": { "type": "integer", "description": "Target Branch Code - [Optional]", "format": "int32" }, "channel": { "type": "string", "description": "Channel - [Optional]", "nullable": true } } }, "ChangeDebitCardBranchResponse": { "required": [ "isSuccess", "oldBranch", "newBranch" ], "type": "object", "properties": { "isSuccess": { "type": "boolean", "description": "Is Success - [Optional]" }, "oldBranch": { "type": "integer", "description": "Old Branch - [Optional]", "format": "int32" }, "newBranch": { "type": "integer", "description": "New Branch - [Optional]", "format": "int32" } } }, "ChangeDebitCardStatusRequest": { "type": "object", "properties": { "shadowCardNumber": { "type": "string", "description": "Shadow Card Number - [Optional]", "nullable": true }, "statusCode": { "type": "string", "description": "Status Code - [Optional]", "nullable": true }, "statusReasonCode": { "type": "string", "description": "Status Reason Code - [Optional]", "nullable": true }, "channel": { "type": "string", "description": "Channel - [Optional]", "nullable": true }, "closeRequestDate": { "type": "string", "description": "Close Request Date - [Optional]", "format": "date-time", "nullable": true } } }, "ChangeDebitCardStatusResponse": { "required": [ "toStatusActive" ], "type": "object", "properties": { "toStatusActive": { "type": "boolean", "description": "To Status Active - [Optional]" } } }, "CreateCorporateDebitCardAccount": { "required": [ "accountNumber" ], "type": "object", "properties": { "accountType": { "type": "string", "description": "Account Type - [Optional]", "nullable": true }, "accountNumber": { "type": "integer", "description": "Account Number - [Optional]", "format": "int64" }, "accountOrderFlag": { "type": "boolean", "description": "Account Order Flag - [Optional]", "nullable": true } } }, "CreateCorporateDebitCardPermissions": { "required": [ "eCommercePermitted" ], "type": "object", "properties": { "eCommercePermitted": { "type": "boolean", "description": "E Commerce Permitted - [Optional]" } } }, "CreateCorporateDebitCardRequest": { "required": [ "customerNumber", "mainCustomerNumber", "branchCode" ], "type": "object", "properties": { "channel": { "type": "string", "description": "Channel - [Optional]", "nullable": true }, "productNumber": { "type": "string", "description": "Product Number - [Optional]", "nullable": true }, "customerNumber": { "type": "integer", "description": "Customer Number - [Optional]", "format": "int64" }, "mainCustomerNumber": { "type": "integer", "description": "Main Customer Number - [Optional]", "format": "int64" }, "branchCode": { "type": "integer", "description": "Branch Code - [Optional]", "format": "int32" }, "cardDeliveryType": { "type": "string", "description": "Card Delivery Type - [Optional]", "nullable": true }, "cardSendAddressType": { "type": "string", "description": "Card Send Address Type - [Optional]", "nullable": true }, "cardSendAddressId": { "type": "integer", "description": "Card Send Address Id - [Optional]", "format": "int64", "nullable": true }, "cardDeliveryBranchCode": { "type": "integer", "description": "Card Delivery Branch Code - [Optional]", "format": "int32", "nullable": true }, "permissions": { "allOf": [ { "$ref": "#/components/schemas/CreateCorporateDebitCardPermissions" } ], "description": "Permissions - [Optional]", "nullable": true }, "listOfAccount": { "type": "array", "items": { "$ref": "#/components/schemas/CreateCorporateDebitCardAccount" }, "description": "List Of Account - [Optional]", "nullable": true }, "applicationDate": { "type": "string", "description": "Application Date - [Optional]", "format": "date-time", "nullable": true }, "nameOnCard": { "type": "string", "description": "Name On Card - [Optional]", "nullable": true }, "secondNameOnCard": { "type": "string", "description": "Second Name On Card", "nullable": true } } }, "CreateCorporateDebitCardResponse": { "required": [ "recordId" ], "type": "object", "properties": { "recordId": { "type": "integer", "description": "Record Id - [Optional]", "format": "int64" }, "maskedCardNumber": { "type": "string", "description": "Masked Card Number - [Optional]", "nullable": true }, "shadowCardNumber": { "type": "string", "description": "Shadow Card Number - [Optional]", "nullable": true }, "cardRefNumber": { "type": "string", "description": "Card Ref Number - [Optional]", "nullable": true }, "mainCardRefNumber": { "type": "string", "description": "Main Card Ref Number - [Optional]", "nullable": true }, "warnings": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Warnings - [Optional]", "nullable": true } } }, "CreateCustomerAddressData": { "required": [ "customerNumber", "addressType", "addressText", "isDefault", "isCardAddress", "isConfirmed" ], "type": "object", "properties": { "customerNumber": { "type": "integer", "description": "Customer Number", "format": "int64" }, "addressType": { "type": "string", "description": "Address Type" }, "addressText": { "type": "string", "description": "Full Address Text" }, "isDefault": { "type": "boolean", "description": "Default Address Indicator, true=Default, false=Not" }, "isCardAddress": { "type": "boolean", "description": "Card Address Indicator, true=Card Address, false=Not" }, "isConfirmed": { "type": "boolean", "description": "ApprovedCard Address Indicator, true=Approved Address, false=Not" }, "addressId": { "type": "integer", "description": "External System Relational Identifier, Correlation Identifier", "format": "int64", "nullable": true }, "countryId": { "type": "integer", "description": "Country Id, see Country_Def table", "format": "int32", "nullable": true }, "industrialZoneId": { "type": "integer", "description": "Industrial Zone Identifier", "format": "int32", "nullable": true }, "industrialZoneName": { "type": "string", "description": "Industrial Zone Name", "nullable": true }, "cityId": { "type": "integer", "description": "City Identifier, see City_Def table", "format": "int32", "nullable": true }, "cityName": { "type": "string", "description": "City Name, see City_Def table", "nullable": true }, "countyId": { "type": "integer", "description": "County Identifier, see County_Def table", "format": "int32", "nullable": true }, "countyName": { "type": "string", "description": "County Name, see County_Def table", "nullable": true }, "townId": { "type": "integer", "description": "Town Identifier, see Town_Def table", "format": "int32", "nullable": true }, "townName": { "type": "string", "description": "Town Name, see Town_Def table", "nullable": true }, "villageId": { "type": "integer", "description": "Village Identifier, see Village_Def table", "format": "int32", "nullable": true }, "villageName": { "type": "string", "description": "Village Name, see Village_Def table", "nullable": true }, "districtId": { "type": "integer", "description": "District Identifier, see District_Def table", "format": "int32", "nullable": true }, "districtName": { "type": "string", "description": "District Name, see District_Def table", "nullable": true }, "streetId": { "type": "integer", "description": "Street Identifier, see Street_Def table", "format": "int32", "nullable": true }, "streetName": { "type": "string", "description": "Street Name, see Street_Def table", "nullable": true }, "siteName": { "type": "string", "description": "Address Site Name", "nullable": true }, "buildingId": { "type": "integer", "description": "Building Identifier", "format": "int32", "nullable": true }, "buildingName": { "type": "string", "description": "Building Name", "nullable": true }, "buildingNumber": { "type": "string", "description": "Building Number", "nullable": true }, "buildingEntrance": { "type": "string", "description": "Building Entrance Number", "nullable": true }, "flatNumber": { "type": "integer", "description": "Flat Number", "format": "int32", "nullable": true }, "apartmentNumber": { "type": "string", "description": "Apartment Number", "nullable": true }, "stateId": { "type": "integer", "description": "State Identifier", "format": "int32", "nullable": true }, "stateName": { "type": "string", "description": "State Name", "nullable": true }, "zipCode": { "type": "string", "description": "Zip Code", "nullable": true }, "poBoxNumber": { "type": "string", "description": "Post Box Number", "nullable": true } } }, "CreateCustomerData": { "required": [ "main", "preferences" ], "type": "object", "properties": { "main": { "allOf": [ { "$ref": "#/components/schemas/CreateCustomerMainData" } ], "description": "Customer Creation Main Data Model" }, "persona": { "allOf": [ { "$ref": "#/components/schemas/CreateCustomerPersonalData" } ], "description": "Customer Creation Persona Data Model", "nullable": true }, "corporate": { "allOf": [ { "$ref": "#/components/schemas/CreateCustomerFirmData" } ], "description": "Customer Creation Corporate Data Model", "nullable": true }, "segment": { "allOf": [ { "$ref": "#/components/schemas/CreateCustomerSegmentData" } ], "description": "Customer Creation Segment Data Model", "nullable": true }, "preferences": { "allOf": [ { "$ref": "#/components/schemas/CreateCustomerPreferenceData" } ], "description": "Customer Creation Preferences Data Model" }, "limit": { "allOf": [ { "$ref": "#/components/schemas/CreateCustomerLimitData" } ], "description": "Customer Creation Limit Data Model", "nullable": true } } }, "CreateCustomerEmailData": { "required": [ "customerNumber", "isConfirmed" ], "type": "object", "properties": { "customerNumber": { "type": "integer", "description": "Customer Number", "format": "int64" }, "eMailAddress": { "type": "string", "description": "Email Address", "nullable": true }, "isConfirmed": { "type": "boolean", "description": "Approved Email Address Indicator, true=Approved, false=Not" } } }, "CreateCustomerFirmData": { "required": [ "firmName", "authorityCustomerNumber" ], "type": "object", "properties": { "firmNumber": { "type": "integer", "description": "Firm Number", "format": "int64", "nullable": true }, "taxNumber": { "type": "string", "description": "Tax Office Number", "nullable": true }, "taxOffice": { "type": "string", "description": "Tax Office", "nullable": true }, "firmName": { "type": "string", "description": "Firm Name" }, "embossFirmName": { "type": "string", "description": "Firm Name On Card", "nullable": true }, "authorityCustomerNumber": { "type": "integer", "description": "Firm Responsable Employee Customer Number", "format": "int64" }, "firmCustomerType": { "type": "string", "description": "Firm Customer Type", "nullable": true }, "tradeRegistrationNumber": { "type": "string", "description": "Trading Registration Number", "nullable": true }, "tradeRegistrationDate": { "type": "string", "description": "Trading Registration Date", "format": "date-time", "nullable": true }, "tradeRegistrationOffice": { "type": "string", "description": "Trading Registration Office", "nullable": true }, "foundationDate": { "type": "string", "description": "Corporate Foundation Date", "format": "date-time", "nullable": true }, "authorityName": { "type": "string", "description": "Corporate Responsable Employee Full Name", "nullable": true }, "authorityGsmNumber": { "type": "string", "description": "Corporate Responsable Employee Mobile Number", "nullable": true }, "authorityMailAddress": { "type": "string", "description": "Corporate Responsable Employee E-Mail Address", "nullable": true } } }, "CreateCustomerGsmData": { "required": [ "customerNumber", "gsmCountryId", "gsmAreaCode", "gsmNumber", "isConfirmed", "isContactNumber" ], "type": "object", "properties": { "customerNumber": { "type": "integer", "description": "Customer Number", "format": "int64" }, "gsmCountryId": { "type": "integer", "description": "Gsm Country Identifier, see Country_Def table", "format": "int32" }, "gsmAreaCode": { "type": "integer", "description": "Gsm Area Code", "format": "int32" }, "gsmNumber": { "type": "string", "description": "Gsm Number" }, "phoneNumberText": { "type": "string", "description": "Full Gsm Number with country code and area code", "nullable": true }, "isConfirmed": { "type": "boolean", "description": "Approved Gsm Indicator, true=Approved Gsm, false=Not" }, "confirmDate": { "type": "string", "description": "Gsm Approve Date", "format": "date-time", "nullable": true }, "isContactNumber": { "type": "boolean", "description": "Contact Gsm Indicator, Primary GSM, true=Contact Gsm, false=Not" } } }, "CreateCustomerLimitData": { "required": [ "limit", "cashLimit" ], "type": "object", "properties": { "limit": { "type": "number", "description": "Credit Limit Value, default=0", "format": "double" }, "cashLimit": { "type": "number", "description": "Cash Advance Limit Value, default=0", "format": "double" } } }, "CreateCustomerMainData": { "required": [ "firmCustomerFlag", "customerType" ], "type": "object", "properties": { "customerNumber": { "type": "integer", "description": "Customer Number, if null then Generate New Customer Number", "format": "int64", "nullable": true }, "personId": { "type": "integer", "description": "Persona Identifier, if null then set Customer Number", "format": "int64", "nullable": true }, "externalCustomerNumber": { "type": "integer", "description": "External System Relational Identifier, if null then set Customer Number", "format": "int64", "nullable": true }, "firmCustomerFlag": { "type": "boolean", "description": "Corporate Customer Indicator, true=Corporate Customer, false=Not" }, "customerType": { "type": "string", "description": "Customer Type, 1=Corporate, 2=Retail, 3=Employee, 4=Sole Proprietorship" }, "accountingCustomerType": { "type": "string", "description": "Accounting Customer Type", "nullable": true }, "creditCustomerType": { "type": "string", "description": "Credit Customer Type", "nullable": true }, "branchCode": { "type": "integer", "description": "Customer Branch Code, if null then set Zero", "format": "int32", "nullable": true }, "isLite": { "type": "boolean", "description": "Lite Customer Flag, if null then set Zero", "nullable": true }, "tenantId": { "type": "string", "description": "Lite Customer TenantId", "nullable": true } } }, "CreateCustomerPersonalData": { "required": [ "disabledFlag", "name", "surname", "birthDate" ], "type": "object", "properties": { "citizenshipNumber": { "type": "string", "description": "Citizen Identifier, if Customer Type = 2 then mandatory else optional", "nullable": true }, "residenceType": { "type": "string", "description": "Residence Type, I=Domestic Residence, D=Abroad Residence", "nullable": true }, "disabledFlag": { "type": "boolean", "description": "Disabled Indicator, true=disabled, false=Not" }, "name": { "type": "string", "description": "Customer Name" }, "middleName": { "type": "string", "description": "Customer Middle Name", "nullable": true }, "surname": { "type": "string", "description": "Customer Surname" }, "birthDate": { "type": "string", "description": "Customer Date Of Birth", "format": "date-time" }, "birthPlace": { "type": "string", "description": "Customer Place Of Birth", "nullable": true }, "fatherName": { "type": "string", "description": "Customer Father's Name", "nullable": true }, "motherName": { "type": "string", "description": "Customer Mother's Name", "nullable": true }, "maritalStatus": { "type": "string", "description": "Customer Marital Status Code", "nullable": true }, "educationStatus": { "type": "string", "description": "Educational Status Code", "nullable": true }, "nationality": { "type": "string", "description": "Nationality Code, see Nationality_Def Table", "nullable": true }, "identityType": { "type": "string", "description": "Identity Type Code, see Identity_Type_Def table", "nullable": true }, "identityNumber": { "type": "string", "description": "Identity Number", "nullable": true }, "title": { "type": "string", "description": "Customer Title", "nullable": true }, "gender": { "type": "string", "description": "Gender Type, E=Male, K=Female, X=Unknown", "nullable": true }, "occupation": { "type": "string", "description": "Occupation Type, see Occupation_Def table", "nullable": true }, "workplaceName": { "type": "string", "description": "Customer Workplace Name", "nullable": true }, "businessTitle": { "type": "string", "description": "Customer Business Title", "nullable": true } } }, "CreateCustomerPhoneData": { "required": [ "customerNumber", "phoneType", "isContactNumber" ], "type": "object", "properties": { "customerNumber": { "type": "integer", "description": "Customer Number", "format": "int64" }, "phoneType": { "type": "string", "description": "Phone Type, see Phone_Type_Def table" }, "phoneCountryId": { "type": "integer", "description": "Phone Country Code, see Country_Def", "format": "int32", "nullable": true }, "phoneAreaCode": { "type": "string", "description": "Phone Area Code", "nullable": true }, "phoneNumber": { "type": "string", "description": "Phone Number", "nullable": true }, "phoneNumberText": { "type": "string", "description": "Full Phone Number Text", "nullable": true }, "isContactNumber": { "type": "boolean", "description": "Contact Phone Address Indicator, Primary Phone Address, true=Contact Phone, false=Not" } } }, "CreateCustomerPreferenceData": { "required": [ "sendWarningLetterFlag", "autoLimitIncreaseFlag", "statementPostingFlag", "statementSmsSendFlag", "statementEMailSendFlag", "earnRewardFlag", "sensitiveDataPermissionFlag", "customLimitationFlag" ], "type": "object", "properties": { "sendWarningLetterFlag": { "type": "boolean", "description": "Warning Letter Indicator, true=Send Warning Letter, false=Not" }, "communicationType": { "type": "string", "description": "Communication Language Preference, TR=Turkish, EN=English, see Comm_Language_Def table", "nullable": true }, "autoLimitIncreaseFlag": { "type": "boolean", "description": "Auto-Limit Increase Indicator, true=Auto-Limit Increase Enabled, false=Not" }, "statementPostingFlag": { "type": "boolean", "description": "Statement Send via Posting Indicator, true=Enabled, false=Not" }, "statementSmsSendFlag": { "type": "boolean", "description": "Statement Send via SMS Indicator, true=Enabled, false=Not" }, "statementEMailSendFlag": { "type": "boolean", "description": "Statement Send via E-Mail Indicator, true=Enabled, false=Not" }, "earnRewardFlag": { "type": "boolean", "description": "Customer Earned Loyalty Reward Indicator, true=Enabled, false=Not" }, "sensitiveDataPermissionFlag": { "type": "boolean", "description": "GDPR Consent Usage Approved Indicator, true=Enabled, false=Not" }, "customLimitationFlag": { "type": "boolean", "description": "Custom Limitation Enable Indicator, true=Enabled, false=Not" } } }, "CreateCustomerRequest": { "required": [ "channel", "customer" ], "type": "object", "properties": { "channel": { "type": "string", "description": "Creation Transaction On Channel" }, "customer": { "allOf": [ { "$ref": "#/components/schemas/CreateCustomerData" } ], "description": "Customer Create Data Model" }, "communications": { "allOf": [ { "$ref": "#/components/schemas/CustomerCommunicationData" } ], "description": "Customer Communication Data Model", "nullable": true } } }, "CreateCustomerResponse": { "required": [ "customerNumber", "personId" ], "type": "object", "properties": { "customerNumber": { "type": "integer", "description": "Customer Number", "format": "int64" }, "personId": { "type": "integer", "description": "Person Id", "format": "int64" } } }, "CreateCustomerSegmentData": { "type": "object", "properties": { "behavioralSegmentCode": { "type": "string", "description": "Customer Behavioral Segment Code", "nullable": true }, "valueSegmentCode": { "type": "string", "description": "Customer Value Segment Code", "nullable": true }, "valueSubSegmentCode": { "type": "string", "description": "Customer Value Sub-Segment Code", "nullable": true } } }, "CreateDisputeCaseDetail": { "required": [ "DisputeAmount" ], "type": "object", "properties": { "UTID": { "type": "string", "description": "U T I D - [Optional]", "nullable": true }, "CurrencyCode": { "type": "string", "description": "Currency Code - [Optional]", "nullable": true }, "DisputeAmount": { "type": "number", "description": "Dispute Amount - [Optional]", "format": "double" } } }, "CreateDisputeCaseRequest": { "required": [ "DisputeDate" ], "type": "object", "properties": { "Channel": { "type": "string", "description": "Channel - [Optional]", "nullable": true }, "ShadowCardNumber": { "type": "string", "description": "Shadow Card Number - [Optional]", "nullable": true }, "CardRefNumber": { "type": "string", "description": "Card Ref Number - [Optional]", "nullable": true }, "EncryptedCardNumber": { "type": "string", "description": "Encrypted Card Number - [Optional]", "nullable": true }, "CardNumber": { "type": "string", "description": "Card Number - [Optional]", "nullable": true }, "CaseType": { "type": "string", "description": "Case Type - [Optional]", "nullable": true }, "DisputeDate": { "type": "string", "description": "Dispute Date - [Optional]", "format": "date-time" }, "DisputeReasonCode": { "type": "string", "description": "Dispute Reason Code - [Optional]", "nullable": true }, "DisputeExplanation": { "type": "string", "description": "Dispute Explanation - [Optional]", "nullable": true }, "CreateDisputeCaseDetail": { "type": "array", "items": { "$ref": "#/components/schemas/CreateDisputeCaseDetail" }, "description": "Create Dispute Case Detail - [Optional]", "nullable": true }, "DmsReference": { "type": "array", "items": { "$ref": "#/components/schemas/DmsReference" }, "description": "Dms Reference - [Optional]", "nullable": true } } }, "CreateDisputeCaseResponse": { "required": [ "CaseNumber" ], "type": "object", "properties": { "CaseNumber": { "type": "integer", "description": "Case Number - [Optional]", "format": "int32" }, "DisputeTransaction": { "type": "array", "items": { "$ref": "#/components/schemas/DisputeTransactionDetail" }, "description": "Dispute Transaction - [Optional]", "nullable": true } } }, "CreateFollowUpByMainCustomerNumberRequest": { "required": [ "mainCustomerNumber" ], "type": "object", "properties": { "mainCustomerNumber": { "type": "integer", "description": "Main Customer Number - [Optional]", "format": "int64" }, "channel": { "type": "string", "description": "Channel - [Optional]", "nullable": true } } }, "CreateIndividualDebitCardAccount": { "required": [ "accountNumber" ], "type": "object", "properties": { "accountType": { "type": "string", "description": "Account Type - [Optional]", "nullable": true }, "accountNumber": { "type": "integer", "description": "Account Number - [Optional]", "format": "int64" }, "accountOrderFlag": { "type": "boolean", "description": "Account Order Flag - [Optional]", "nullable": true } } }, "CreateIndividualDebitCardPermissions": { "required": [ "eCommercePermitted" ], "type": "object", "properties": { "eCommercePermitted": { "type": "boolean", "description": "E Commerce Permitted - [Optional]" } } }, "CreateIndividualDebitCardRequest": { "required": [ "digitalCard", "customerNumber", "branchCode" ], "type": "object", "properties": { "channel": { "type": "string", "description": "Channel - [Optional]", "nullable": true }, "productNumber": { "type": "string", "description": "Product Number - [Optional]", "nullable": true }, "digitalCard": { "type": "boolean", "description": "Digital Card - [Optional]" }, "customerNumber": { "type": "integer", "description": "Customer Number - [Optional]", "format": "int64" }, "mainCustomerNumber": { "type": "integer", "description": "Main Customer Number - [Optional]", "format": "int64", "nullable": true }, "branchCode": { "type": "integer", "description": "Branch Code - [Optional]", "format": "int32" }, "cardDeliveryType": { "type": "string", "description": "Card Delivery Type - [Optional]", "nullable": true }, "cardSendAddressType": { "type": "string", "description": "Card Send Address Type - [Optional]", "nullable": true }, "cardSendAddressId": { "type": "integer", "description": "Card Send Address Id - [Optional]", "format": "int64", "nullable": true }, "cardDeliveryBranchCode": { "type": "integer", "description": "Card Delivery Branch Code - [Optional]", "format": "int32", "nullable": true }, "enrollMasterpass": { "type": "boolean", "description": "Enroll Masterpass - [Optional]", "nullable": true }, "permissions": { "allOf": [ { "$ref": "#/components/schemas/CreateIndividualDebitCardPermissions" } ], "description": "Permissions - [Optional]", "nullable": true }, "listOfAccount": { "type": "array", "items": { "$ref": "#/components/schemas/CreateIndividualDebitCardAccount" }, "description": "List Of Account - [Optional]", "nullable": true }, "applicationDate": { "type": "string", "description": "Application Date - [Optional]", "format": "date-time", "nullable": true }, "contractType": { "type": "string", "description": "Contract Type - [Optional]", "nullable": true }, "contractVersionNumber": { "type": "string", "description": "Contract Version Number - [Optional]", "nullable": true }, "virtualCardRelatedCardRefNumber": { "type": "string", "description": "Virtual Card Related Card Ref Number - [Optional]", "nullable": true }, "nameOnCard": { "type": "string", "description": "Name On Card - [Optional]", "nullable": true } } }, "CreateIndividualDebitCardResponse": { "required": [ "recordId" ], "type": "object", "properties": { "recordId": { "type": "integer", "description": "Record Id - [Optional]", "format": "int64" }, "maskedCardNumber": { "type": "string", "description": "Masked Card Number - [Optional]", "nullable": true }, "shadowCardNumber": { "type": "string", "description": "Shadow Card Number - [Optional]", "nullable": true }, "cardRefNumber": { "type": "string", "description": "Card Ref Number - [Optional]", "nullable": true }, "mainCardRefNumber": { "type": "string", "description": "Main Card Ref Number - [Optional]", "nullable": true }, "warnings": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Warnings - [Optional]", "nullable": true } } }, "CreditCardLogData": { "type": "object", "properties": { "cardRefNumber": { "type": "string", "description": "Card Ref Number - [Optional]", "nullable": true }, "shadowCardNumber": { "type": "string", "description": "Shadow Card Number - [Optional]", "nullable": true }, "maskedCardNumber": { "type": "string", "description": "Masked Card Number - [Optional]", "nullable": true }, "customerNumber": { "type": "integer", "description": "Customer Number - [Optional]", "format": "int64", "nullable": true }, "logCode": { "type": "string", "description": "Log Code - [Optional]", "nullable": true }, "logCodeDescription": { "type": "string", "description": "Log Code Description - [Optional]", "nullable": true }, "oldValue": { "type": "string", "description": "Old Value - [Optional]", "nullable": true }, "newValue": { "type": "string", "description": "New Value - [Optional]", "nullable": true }, "cardLogDetail": { "type": "string", "description": "Card Log Detail - [Optional]", "nullable": true }, "insertChannelId": { "type": "string", "description": "Insert Channel Id - [Optional]", "nullable": true }, "insertChannelDescription": { "type": "string", "description": "Insert Channel Description - [Optional]", "nullable": true }, "insertUserId": { "type": "string", "description": "Insert User Id - [Optional]", "nullable": true }, "insertDate": { "type": "string", "description": "Insert Date - [Optional]", "format": "date-time", "nullable": true } } }, "CreditCardStatementCutoffItem": { "required": [ "customerNumber", "statementDate", "capitalAmount", "purchaseInterestAmount", "cashInterestAmount", "purchaseDueInterestAmount", "cashDueInterestAmount", "otherFeeAmount", "cashFeeAmount", "cardFeeAmount", "interestKkdfAmount", "interestBsmvAmount", "feeBsmvAmount", "cashInstallmentProfitAmount" ], "type": "object", "properties": { "cardRefNumber": { "type": "string", "description": "Card Ref Number - [Optional]", "nullable": true }, "shadowCardNumber": { "type": "string", "description": "Shadow Card Number - [Optional]", "nullable": true }, "customerNumber": { "type": "integer", "description": "Customer Number - [Optional]", "format": "int64" }, "statementDate": { "type": "string", "description": "Statement Date - [Optional]", "format": "date-time" }, "capitalAmount": { "type": "number", "description": "Capital Amount - [Optional]", "format": "double" }, "purchaseInterestAmount": { "type": "number", "description": "Purchase Interest Amount - [Optional]", "format": "double" }, "cashInterestAmount": { "type": "number", "description": "Cash Interest Amount - [Optional]", "format": "double" }, "purchaseDueInterestAmount": { "type": "number", "description": "Purchase Due Interest Amount - [Optional]", "format": "double" }, "cashDueInterestAmount": { "type": "number", "description": "Cash Due Interest Amount - [Optional]", "format": "double" }, "otherFeeAmount": { "type": "number", "description": "Other Fee Amount - [Optional]", "format": "double" }, "cashFeeAmount": { "type": "number", "description": "Cash Fee Amount - [Optional]", "format": "double" }, "cardFeeAmount": { "type": "number", "description": "Card Fee Amount - [Optional]", "format": "double" }, "interestKkdfAmount": { "type": "number", "description": "Interest Kkdf Amount - [Optional]", "format": "double" }, "interestBsmvAmount": { "type": "number", "description": "Interest Bsmv Amount - [Optional]", "format": "double" }, "feeBsmvAmount": { "type": "number", "description": "Fee Bsmv Amount - [Optional]", "format": "double" }, "cashInstallmentProfitAmount": { "type": "number", "description": "Cash Installment Profit Amount - [Optional]", "format": "double" } } }, "CreditTransactionList": { "type": "object", "properties": { "acqRefNumber": { "type": "string", "description": "Acq Ref Number - [Optional]", "nullable": true }, "authorizationMatchStatus": { "type": "string", "description": "Authorization Match Status - [Optional]", "nullable": true }, "authorizationNumber": { "type": "string", "description": "Authorization Number - [Optional]", "nullable": true }, "billingAmount": { "type": "number", "description": "Billing Amount - [Optional]", "format": "double", "nullable": true }, "billingCurrency": { "type": "string", "description": "Billing Currency - [Optional]", "nullable": true }, "bkmUniqueMerchantId": { "type": "string", "description": "Bkm Unique Merchant Id - [Optional]", "nullable": true }, "campaignCodeAcq": { "type": "string", "description": "Campaign Code Acq - [Optional]", "nullable": true }, "campaignCodeIss": { "type": "string", "description": "Campaign Code Iss - [Optional]", "nullable": true }, "channelTypeDescription": { "type": "string", "description": "Channel Type Description - [Optional]", "nullable": true }, "clearingChannel": { "type": "string", "description": "Clearing Channel - [Optional]", "nullable": true }, "clearingDate": { "type": "string", "description": "Clearing Date - [Optional]", "format": "date-time", "nullable": true }, "clearingNumber": { "type": "integer", "description": "Clearing Number - [Optional]", "format": "int64", "nullable": true }, "customerNumberList": { "type": "integer", "description": "Customer Number List - [Optional]", "format": "int64", "nullable": true }, "displayAtChannels": { "type": "integer", "description": "Display At Channels - [Optional]", "format": "int32", "nullable": true }, "earnedRewardBank": { "type": "number", "description": "Earned Reward Bank - [Optional]", "format": "double", "nullable": true }, "earnedRewardCampaignAcq": { "type": "number", "description": "Earned Reward Campaign Acq - [Optional]", "format": "double", "nullable": true }, "earnedRewardCampaignIss": { "type": "number", "description": "Earned Reward Campaign Iss - [Optional]", "format": "double", "nullable": true }, "earnedRewardMerchant": { "type": "number", "description": "Earned Reward Merchant - [Optional]", "format": "double", "nullable": true }, "embossName": { "type": "string", "description": "Emboss Name - [Optional]", "nullable": true }, "eodDate": { "type": "string", "description": "Eod Date - [Optional]", "format": "date-time", "nullable": true }, "invoiceNumber": { "type": "string", "description": "Invoice Number - [Optional]", "nullable": true }, "installmentAmount": { "type": "number", "description": "Installment Amount - [Optional]", "format": "double", "nullable": true }, "installmentCount": { "type": "integer", "description": "Installment Count - [Optional]", "format": "int32", "nullable": true }, "installmentNumber": { "type": "integer", "description": "Installment Number - [Optional]", "format": "int32", "nullable": true }, "isChipFlag": { "type": "boolean", "description": "Is Chip Flag - [Optional]", "nullable": true }, "localAmount": { "type": "number", "description": "Local Amount - [Optional]", "format": "double", "nullable": true }, "localCurrency": { "type": "string", "description": "Local Currency - [Optional]", "nullable": true }, "mainCardRefNumber": { "type": "string", "description": "Main Card Ref Number - [Optional]", "nullable": true }, "mainCustomerNumber": { "type": "integer", "description": "Main Customer Number - [Optional]", "format": "int64", "nullable": true }, "maskedCardNumber": { "type": "string", "description": "Masked Card Number - [Optional]", "nullable": true }, "matchStatusDescription": { "type": "string", "description": "Match Status Description - [Optional]", "nullable": true }, "mccDescription": { "type": "string", "description": "Mcc Description - [Optional]", "nullable": true }, "merchantAmexId": { "type": "string", "description": "Merchant Amex Id - [Optional]", "nullable": true }, "merchantCity": { "type": "string", "description": "Merchant City - [Optional]", "nullable": true }, "merchantCountryCode": { "type": "string", "description": "Merchant Country Code - [Optional]", "nullable": true }, "merchantName": { "type": "string", "description": "Merchant Name - [Optional]", "nullable": true }, "networkDescription": { "type": "string", "description": "Network Description - [Optional]", "nullable": true }, "offlineFlag": { "type": "boolean", "description": "Offline Flag - [Optional]", "nullable": true }, "panEntryMode": { "type": "string", "description": "Pan Entry Mode - [Optional]", "nullable": true }, "pinEntryMode": { "type": "string", "description": "Pin Entry Mode - [Optional]", "nullable": true }, "pinUsage": { "type": "string", "description": "Pin Usage - [Optional]", "nullable": true }, "responseCodeDescription": { "type": "string", "description": "Response Code Description - [Optional]", "nullable": true }, "responseReasonCodeDescription": { "type": "string", "description": "Response Reason Code Description - [Optional]", "nullable": true }, "product": { "type": "string", "description": "Product - [Optional]", "nullable": true }, "refUtid": { "type": "string", "description": "Ref Utid - [Optional]", "nullable": true }, "requestDate": { "type": "string", "description": "Request Date - [Optional]", "format": "date-time", "nullable": true }, "rewardTypeDescription": { "type": "string", "description": "Reward Type Description - [Optional]", "nullable": true }, "rrn": { "type": "string", "description": "Rrn - [Optional]", "nullable": true }, "settlementAmount": { "type": "number", "description": "Settlement Amount - [Optional]", "format": "double", "nullable": true }, "settlementCurrency": { "type": "string", "description": "Settlement Currency - [Optional]", "nullable": true }, "terminalType": { "type": "string", "description": "Terminal Type - [Optional]", "nullable": true }, "terminalDescription": { "type": "string", "description": "Terminal Description - [Optional]", "nullable": true }, "terminalNumber": { "type": "string", "description": "Terminal Number - [Optional]", "nullable": true }, "trnAmount": { "type": "number", "description": "Trn Amount - [Optional]", "format": "double", "nullable": true }, "trnCodeMatrixDesc": { "type": "string", "description": "Trn Code Matrix Desc - [Optional]", "nullable": true }, "trnCode": { "type": "string", "description": "Trn Code - [Optional]", "nullable": true }, "trnCodeDescription": { "type": "string", "description": "Trn Code Description - [Optional]", "nullable": true }, "trnCurrency": { "type": "string", "description": "Trn Currency - [Optional]", "nullable": true }, "trnDate": { "type": "string", "description": "Trn Date - [Optional]", "format": "date-time", "nullable": true }, "trnDescription": { "type": "string", "description": "Trn Description - [Optional]", "nullable": true }, "trnOrigin": { "type": "integer", "description": "Trn Origin - [Optional]", "format": "int32", "nullable": true }, "utid": { "type": "string", "description": "Utid - [Optional]", "nullable": true } } }, "CustomerAddress": { "required": [ "validFlag", "recordId", "personId", "customerNumber" ], "type": "object", "properties": { "validFlag": { "type": "boolean", "description": "Valid Flag - [Optional]" }, "recordId": { "type": "integer", "description": "Record Id - [Optional]", "format": "int64" }, "personId": { "type": "integer", "description": "Person Id - [Optional]", "format": "int64" }, "customerNumber": { "type": "integer", "description": "Customer Number - [Optional]", "format": "int64" }, "addressType": { "type": "string", "description": "Address Type - [Optional]", "nullable": true }, "addressId": { "type": "integer", "description": "Address Id - [Optional]", "format": "int64", "nullable": true }, "countryId": { "type": "integer", "description": "Country Id - [Optional]", "format": "int32", "nullable": true }, "industrialZoneId": { "type": "integer", "description": "Industrial Zone Id - [Optional]", "format": "int32", "nullable": true }, "industrialZoneName": { "type": "string", "description": "Industrial Zone Name - [Optional]", "nullable": true }, "cityId": { "type": "integer", "description": "City Id - [Optional]", "format": "int32", "nullable": true }, "cityName": { "type": "string", "description": "City Name - [Optional]", "nullable": true }, "countyId": { "type": "integer", "description": "County Id - [Optional]", "format": "int32", "nullable": true }, "countyName": { "type": "string", "description": "County Name - [Optional]", "nullable": true }, "townshipId": { "type": "integer", "description": "Township Id - [Optional]", "format": "int32", "nullable": true }, "townshipName": { "type": "string", "description": "Township Name - [Optional]", "nullable": true }, "villageId": { "type": "integer", "description": "Village Id - [Optional]", "format": "int32", "nullable": true }, "villageName": { "type": "string", "description": "Village Name - [Optional]", "nullable": true }, "districtId": { "type": "integer", "description": "District Id - [Optional]", "format": "int32", "nullable": true }, "districtName": { "type": "string", "description": "District Name - [Optional]", "nullable": true }, "streetId": { "type": "integer", "description": "Street Id - [Optional]", "format": "int32", "nullable": true }, "streetName": { "type": "string", "description": "Street Name - [Optional]", "nullable": true }, "siteName": { "type": "string", "description": "Site Name - [Optional]", "nullable": true }, "buildingId": { "type": "integer", "description": "Building Id - [Optional]", "format": "int32", "nullable": true }, "buildingName": { "type": "string", "description": "Building Name - [Optional]", "nullable": true }, "buildingNumber": { "type": "string", "description": "Building Number - [Optional]", "nullable": true }, "buildingEntrance": { "type": "string", "description": "Building Entrance - [Optional]", "nullable": true }, "flatNo": { "type": "integer", "description": "Flat No - [Optional]", "format": "int32", "nullable": true }, "apartmentNumber": { "type": "string", "description": "Apartment Number - [Optional]", "nullable": true }, "stateId": { "type": "integer", "description": "State Id - [Optional]", "format": "int32", "nullable": true }, "stateName": { "type": "string", "description": "State Name - [Optional]", "nullable": true }, "zipCode": { "type": "string", "description": "Zip Code - [Optional]", "nullable": true }, "poBoxNo": { "type": "string", "description": "Po Box No - [Optional]", "nullable": true }, "addressText": { "type": "string", "description": "Address Text - [Optional]", "nullable": true }, "isDefault": { "type": "string", "description": "Is Default - [Optional]", "nullable": true }, "isCardAddress": { "type": "string", "description": "Is Card Address - [Optional]", "nullable": true }, "isConfirmed": { "type": "string", "description": "Is Confirmed - [Optional]", "nullable": true }, "channelCode": { "type": "string", "description": "Channel Code - [Optional]", "nullable": true }, "companyCode": { "type": "string", "description": "Company Code - [Optional]", "nullable": true }, "enteringChannelCode": { "type": "string", "description": "Entering Channel Code - [Optional]", "nullable": true } } }, "CustomerCommunicationData": { "type": "object", "properties": { "listOfAddress": { "type": "array", "items": { "$ref": "#/components/schemas/CreateCustomerAddressData" }, "description": "List Of Customer Address Data", "nullable": true }, "listOfGsm": { "type": "array", "items": { "$ref": "#/components/schemas/CreateCustomerGsmData" }, "description": "List Of Customer Gsm Data", "nullable": true }, "listOfEmail": { "type": "array", "items": { "$ref": "#/components/schemas/CreateCustomerEmailData" }, "description": "List Of Customer Email Data", "nullable": true }, "listOfPhone": { "type": "array", "items": { "$ref": "#/components/schemas/CreateCustomerPhoneData" }, "description": "List Of Customer Phone Data", "nullable": true } } }, "CustomerEMail": { "required": [ "validFlag", "recordId", "personId" ], "type": "object", "properties": { "validFlag": { "type": "boolean", "description": "Valid Flag - [Optional]" }, "recordId": { "type": "integer", "description": "Record Id - [Optional]", "format": "int64" }, "personId": { "type": "integer", "description": "Person Id - [Optional]", "format": "int64" }, "customerNumber": { "type": "integer", "description": "Customer Number - [Optional]", "format": "int64", "nullable": true }, "eMailId": { "type": "integer", "description": "E Mail Id - [Optional]", "format": "int64", "nullable": true }, "eMailAddress": { "type": "string", "description": "E Mail Address - [Optional]", "nullable": true }, "isConfirmed": { "type": "string", "description": "Is Confirmed - [Optional]", "nullable": true }, "confirmDate": { "type": "string", "description": "Confirm Date - [Optional]", "format": "date-time", "nullable": true }, "channelCode": { "type": "string", "description": "Channel Code - [Optional]", "nullable": true }, "companyCode": { "type": "string", "description": "Company Code - [Optional]", "nullable": true }, "enteringChannelCode": { "type": "string", "description": "Entering Channel Code - [Optional]", "nullable": true } } }, "CustomerFirmInfo": { "required": [ "validFlag", "customerNumber", "authorityCustomerNumber" ], "type": "object", "properties": { "validFlag": { "type": "boolean", "description": "Valid Flag - [Optional]" }, "customerNumber": { "type": "integer", "description": "Customer Number - [Optional]", "format": "int64" }, "firmName": { "type": "string", "description": "Firm Name - [Optional]", "nullable": true }, "embossFirmName": { "type": "string", "description": "Emboss Firm Name - [Optional]", "nullable": true }, "authorityCustomerNumber": { "type": "integer", "description": "Authority Customer Number - [Optional]", "format": "int64" }, "firmCustomerType": { "type": "string", "description": "Firm Customer Type - [Optional]", "nullable": true }, "tradeRegistrationNumber": { "type": "string", "description": "Trade Registration Number - [Optional]", "nullable": true }, "tradeRegistrationDate": { "type": "string", "description": "Trade Registration Date - [Optional]", "format": "date-time", "nullable": true }, "foundationDate": { "type": "string", "description": "Foundation Date - [Optional]", "format": "date-time", "nullable": true }, "tradeRegistrationOffice": { "type": "string", "description": "Trade Registration Office - [Optional]", "nullable": true }, "authorityName": { "type": "string", "description": "Authority Name - [Optional]", "nullable": true }, "authorityGsmNumber": { "type": "string", "description": "Authority Gsm Number - [Optional]", "nullable": true }, "authorityMailAddress": { "type": "string", "description": "Authority Mail Address - [Optional]", "nullable": true } } }, "CustomerGsm": { "required": [ "validFlag", "recordId", "personId", "gsmCountryId", "gsmAreaCode" ], "type": "object", "properties": { "validFlag": { "type": "boolean", "description": "Valid Flag - [Optional]" }, "recordId": { "type": "integer", "description": "Record Id - [Optional]", "format": "int64" }, "personId": { "type": "integer", "description": "Person Id - [Optional]", "format": "int64" }, "customerNumber": { "type": "integer", "description": "Customer Number - [Optional]", "format": "int64", "nullable": true }, "gsmId": { "type": "integer", "description": "Gsm Id - [Optional]", "format": "int64", "nullable": true }, "gsmCountryId": { "type": "integer", "description": "Gsm Country Id - [Optional]", "format": "int32" }, "gsmAreaCode": { "type": "integer", "description": "Gsm Area Code - [Optional]", "format": "int32" }, "gsmNumber": { "type": "string", "description": "Gsm Number - [Optional]", "nullable": true }, "phoneNumberText": { "type": "string", "description": "Phone Number Text - [Optional]", "nullable": true }, "isConfirmed": { "type": "string", "description": "Is Confirmed - [Optional]", "nullable": true }, "confirmDate": { "type": "string", "description": "Confirm Date - [Optional]", "format": "date-time", "nullable": true }, "confirmType": { "type": "string", "description": "Confirm Type - [Optional]", "nullable": true }, "rejectDate": { "type": "string", "description": "Reject Date - [Optional]", "format": "date-time", "nullable": true }, "isContactNumber": { "type": "string", "description": "Is Contact Number - [Optional]", "nullable": true }, "channelCode": { "type": "string", "description": "Channel Code - [Optional]", "nullable": true }, "companyCode": { "type": "string", "description": "Company Code - [Optional]", "nullable": true }, "enteringChannelCode": { "type": "string", "description": "Entering Channel Code - [Optional]", "nullable": true } } }, "CustomerMaster": { "required": [ "insertDate", "validFlag", "customerNumber", "personId", "externalCustomerNumber", "firmCustomerFlag", "branchCode", "limit", "cashLimit", "sendWarningLetterFlag", "activityCount", "overlimitFlag", "overlimitCounter", "deficientPaymentCounter", "autoLimitIncreaseFlag", "blockedAccountFlag", "disabledFlag", "statementPostingFlag", "statementSmsSendFlag", "statementeMailSendFlag", "earnRewardFlag", "sensitiveDataPermissionFlag", "customLimitationFlag" ], "type": "object", "properties": { "insertDate": { "type": "string", "description": "Insert Date - [Optional]", "format": "date-time" }, "insertUserId": { "type": "string", "description": "Insert User Id - [Optional]", "nullable": true }, "insertTokenId": { "type": "string", "description": "Insert Token Id - [Optional]", "nullable": true }, "updateDate": { "type": "string", "description": "Update Date - [Optional]", "format": "date-time", "nullable": true }, "updateUserId": { "type": "string", "description": "Update User Id - [Optional]", "nullable": true }, "updateTokenId": { "type": "string", "description": "Update Token Id - [Optional]", "nullable": true }, "validFlag": { "type": "boolean", "description": "Valid Flag - [Optional]" }, "customerNumber": { "type": "integer", "description": "Customer Number - [Optional]", "format": "int64" }, "personId": { "type": "integer", "description": "Person Id - [Optional]", "format": "int64" }, "externalCustomerNumber": { "type": "integer", "description": "External Customer Number - [Optional]", "format": "int64" }, "firmCustomerFlag": { "type": "boolean", "description": "Firm Customer Flag - [Optional]" }, "firmNumber": { "type": "integer", "description": "Firm Number - [Optional]", "format": "int64", "nullable": true }, "taxNumber": { "type": "string", "description": "Tax Number - [Optional]", "nullable": true }, "taxOffice": { "type": "string", "description": "Tax Office - [Optional]", "nullable": true }, "citizenshipNumber": { "type": "string", "description": "Citizenship Number - [Optional]", "nullable": true }, "branchCode": { "type": "integer", "description": "Branch Code - [Optional]", "format": "int32" }, "limit": { "type": "number", "description": "Limit - [Optional]", "format": "double" }, "cashLimit": { "type": "number", "description": "Cash Limit - [Optional]", "format": "double" }, "oldLimit": { "type": "number", "description": "Old Limit - [Optional]", "format": "double", "nullable": true }, "lastLimitUpdateDate": { "type": "string", "description": "Last Limit Update Date - [Optional]", "format": "date-time", "nullable": true }, "proceedingStatusCode": { "type": "string", "description": "Proceeding Status Code - [Optional]", "nullable": true }, "proceedingStatusUpdateDate": { "type": "string", "description": "Proceeding Status Update Date - [Optional]", "format": "date-time", "nullable": true }, "prevProceedingStatusCode": { "type": "string", "description": "Prev Proceeding Status Code - [Optional]", "nullable": true }, "sendWarningLetterFlag": { "type": "boolean", "description": "Send Warning Letter Flag - [Optional]" }, "delinquencyStatus": { "type": "string", "description": "Delinquency Status - [Optional]", "nullable": true }, "delinquencyPeriod": { "type": "integer", "description": "Delinquency Period - [Optional]", "format": "int32", "nullable": true }, "delinquencyStartDate": { "type": "string", "description": "Delinquency Start Date - [Optional]", "format": "date-time", "nullable": true }, "delinquencyChangeDate": { "type": "string", "description": "Delinquency Change Date - [Optional]", "format": "date-time", "nullable": true }, "activityStatus": { "type": "string", "description": "Activity Status - [Optional]", "nullable": true }, "activityCount": { "type": "integer", "description": "Activity Count - [Optional]", "format": "int32" }, "overlimitFlag": { "type": "boolean", "description": "Overlimit Flag - [Optional]" }, "overlimitCounter": { "type": "integer", "description": "Overlimit Counter - [Optional]", "format": "int32" }, "deficientPaymentCounter": { "type": "integer", "description": "Deficient Payment Counter - [Optional]", "format": "int32" }, "annualDeficientPaymentCounter": { "type": "integer", "description": "Annual Deficient Payment Counter - [Optional]", "format": "int32", "nullable": true }, "customerType": { "type": "string", "description": "Customer Type - [Optional]", "nullable": true }, "accountingCustomerType": { "type": "string", "description": "Accounting Customer Type - [Optional]", "nullable": true }, "creditCustomerType": { "type": "string", "description": "Credit Customer Type - [Optional]", "nullable": true }, "behavioralSegmentCode": { "type": "string", "description": "Behavioral Segment Code - [Optional]", "nullable": true }, "valueSubSegmentCode": { "type": "string", "description": "Value Sub Segment Code - [Optional]", "nullable": true }, "valueSegmentCode": { "type": "string", "description": "Value Segment Code - [Optional]", "nullable": true }, "residenceType": { "type": "string", "description": "Residence Type - [Optional]", "nullable": true }, "communicationType": { "type": "string", "description": "Communication Type - [Optional]", "nullable": true }, "statusCode": { "type": "string", "description": "Status Code - [Optional]", "nullable": true }, "statusUpdateDate": { "type": "string", "description": "Status Update Date - [Optional]", "format": "date-time", "nullable": true }, "prevStatusCode": { "type": "string", "description": "Prev Status Code - [Optional]", "nullable": true }, "prevStatusUpdateDate": { "type": "string", "description": "Prev Status Update Date - [Optional]", "format": "date-time", "nullable": true }, "limitAllocationIncome": { "type": "number", "description": "Limit Allocation Income - [Optional]", "format": "double", "nullable": true }, "firstTransactionDate": { "type": "string", "description": "First Transaction Date - [Optional]", "format": "date-time", "nullable": true }, "autoLimitIncreaseFlag": { "type": "boolean", "description": "Auto Limit Increase Flag - [Optional]" }, "firstCardIssueDate": { "type": "string", "description": "First Card Issue Date - [Optional]", "format": "date-time", "nullable": true }, "kkbStatusCode": { "type": "string", "description": "Kkb Status Code - [Optional]", "nullable": true }, "kkbStatusUpdateDate": { "type": "string", "description": "Kkb Status Update Date - [Optional]", "format": "date-time", "nullable": true }, "blockedAccountFlag": { "type": "boolean", "description": "Blocked Account Flag - [Optional]" }, "disabledFlag": { "type": "boolean", "description": "Disabled Flag - [Optional]" }, "limitStatus": { "type": "string", "description": "Limit Status - [Optional]", "nullable": true }, "limitStatusUpdateDate": { "type": "string", "description": "Limit Status Update Date - [Optional]", "format": "date-time", "nullable": true }, "statementPostingFlag": { "type": "boolean", "description": "Statement Posting Flag - [Optional]" }, "statementSmsSendFlag": { "type": "boolean", "description": "Statement Sms Send Flag - [Optional]" }, "statementeMailSendFlag": { "type": "boolean", "description": "Statement E Mail Send Flag - [Optional]" }, "earnRewardFlag": { "type": "boolean", "description": "Earn Reward Flag - [Optional]" }, "sensitiveDataPermissionFlag": { "type": "boolean", "description": "Sensitive Data Permission Flag - [Optional]" }, "customLimitationFlag": { "type": "boolean", "description": "Custom Limitation Flag - [Optional]" } } }, "CustomerPersonalInfo": { "required": [ "validFlag", "personId", "customerNumber", "birthDate" ], "type": "object", "properties": { "validFlag": { "type": "boolean", "description": "Valid Flag - [Optional]" }, "personId": { "type": "integer", "description": "Person Id - [Optional]", "format": "int64" }, "customerNumber": { "type": "integer", "description": "Customer Number - [Optional]", "format": "int64" }, "name": { "type": "string", "description": "Name - [Optional]", "nullable": true }, "middleName": { "type": "string", "description": "Middle Name - [Optional]", "nullable": true }, "surname": { "type": "string", "description": "Surname - [Optional]", "nullable": true }, "birthDate": { "type": "string", "description": "Birth Date - [Optional]", "format": "date-time" }, "birthPlace": { "type": "string", "description": "Birth Place - [Optional]", "nullable": true }, "fatherName": { "type": "string", "description": "Father Name - [Optional]", "nullable": true }, "motherName": { "type": "string", "description": "Mother Name - [Optional]", "nullable": true }, "maritalStatus": { "type": "string", "description": "Marital Status - [Optional]", "nullable": true }, "educationStatus": { "type": "string", "description": "Education Status - [Optional]", "nullable": true }, "nationality": { "type": "string", "description": "Nationality - [Optional]", "nullable": true }, "identityType": { "type": "string", "description": "Identity Type - [Optional]", "nullable": true }, "identityNumber": { "type": "string", "description": "Identity Number - [Optional]", "nullable": true }, "title": { "type": "string", "description": "Title - [Optional]", "nullable": true }, "gender": { "type": "string", "description": "Gender - [Optional]", "nullable": true }, "occupation": { "type": "string", "description": "Occupation - [Optional]", "nullable": true }, "workplaceName": { "type": "string", "description": "Workplace Name - [Optional]", "nullable": true }, "businessTitle": { "type": "string", "description": "Business Title - [Optional]", "nullable": true } } }, "CustomerPhone": { "required": [ "validFlag", "recordId", "personId" ], "type": "object", "properties": { "validFlag": { "type": "boolean", "description": "Valid Flag - [Optional]" }, "recordId": { "type": "integer", "description": "Record Id - [Optional]", "format": "int64" }, "customerNumber": { "type": "integer", "description": "Customer Number - [Optional]", "format": "int64", "nullable": true }, "phoneType": { "type": "string", "description": "Phone Type - [Optional]", "nullable": true }, "phoneId": { "type": "integer", "description": "Phone Id - [Optional]", "format": "int64", "nullable": true }, "addressId": { "type": "integer", "description": "Address Id - [Optional]", "format": "int64", "nullable": true }, "personId": { "type": "integer", "description": "Person Id - [Optional]", "format": "int64" }, "phoneCountryId": { "type": "integer", "description": "Phone Country Id - [Optional]", "format": "int32", "nullable": true }, "phoneAreaCode": { "type": "string", "description": "Phone Area Code - [Optional]", "nullable": true }, "phoneNumber": { "type": "string", "description": "Phone Number - [Optional]", "nullable": true }, "phoneNumberText": { "type": "string", "description": "Phone Number Text - [Optional]", "nullable": true }, "addressType": { "type": "string", "description": "Address Type - [Optional]", "nullable": true }, "isContactNumber": { "type": "string", "description": "Is Contact Number - [Optional]", "nullable": true }, "channelCode": { "type": "string", "description": "Channel Code - [Optional]", "nullable": true }, "companyCode": { "type": "string", "description": "Company Code - [Optional]", "nullable": true }, "enteringChannelCode": { "type": "string", "description": "Entering Channel Code - [Optional]", "nullable": true } } }, "DebitCardModel": { "required": [ "customerNumber", "supplementaryCardFlag", "cardRefCurrentCardFlag", "branchCode", "virtualFlag", "emvFlag", "magneticStripeFlag", "contactlessFlag", "rewardEarningFlag", "provisionStatusFlag", "digitalCardFlag", "cvv2RetryCount", "pinRetryCount", "sendingBranchCode" ], "type": "object", "properties": { "shadowCardNumber": { "type": "string", "description": "Shadow Card Number - [Optional]", "nullable": true }, "maskedCardNumber": { "type": "string", "description": "Masked Card Number - [Optional]", "nullable": true }, "cardRefNumber": { "type": "string", "description": "Card Ref Number - [Optional]", "nullable": true }, "mainCardRefNumber": { "type": "string", "description": "Main Card Ref Number - [Optional]", "nullable": true }, "customerNumber": { "type": "integer", "description": "Customer Number - [Optional]", "format": "int64" }, "mainCustomerNumber": { "type": "integer", "description": "Main Customer Number - [Optional]", "format": "int64", "nullable": true }, "relatedCardRefNumber": { "type": "string", "description": "Related Card Ref Number - [Optional]", "nullable": true }, "supplementaryCardFlag": { "type": "boolean", "description": "Supplementary Card Flag - [Optional]" }, "cardRefCurrentCardFlag": { "type": "boolean", "description": "Card Ref Current Card Flag - [Optional]" }, "branchCode": { "type": "integer", "description": "Branch Code - [Optional]", "format": "int32" }, "branchName": { "type": "string", "description": "Branch Name - [Optional]", "nullable": true }, "ownerName": { "type": "string", "description": "Owner Name - [Optional]", "nullable": true }, "ownerSecondName": { "type": "string", "description": "Owner Second Name - [Optional]", "nullable": true }, "ownerSurname": { "type": "string", "description": "Owner Surname - [Optional]", "nullable": true }, "embossName": { "type": "string", "description": "Emboss Name - [Optional]", "nullable": true }, "productNumber": { "type": "string", "description": "Product Number - [Optional]", "nullable": true }, "cardStatusCode": { "type": "string", "description": "Card Status Code - [Optional]", "nullable": true }, "cardStatusDscr": { "type": "string", "description": "Card Status Dscr - [Optional]", "nullable": true }, "cardStatusReasonCode": { "type": "string", "description": "Card Status Reason Code - [Optional]", "nullable": true }, "cardStatusReasonDscr": { "type": "string", "description": "Card Status Reason Dscr - [Optional]", "nullable": true }, "virtualFlag": { "type": "boolean", "description": "Virtual Flag - [Optional]" }, "productName": { "type": "string", "description": "Product Name - [Optional]", "nullable": true }, "productShortName": { "type": "string", "description": "Product Short Name - [Optional]", "nullable": true }, "emvFlag": { "type": "boolean", "description": "Emv Flag - [Optional]" }, "magneticStripeFlag": { "type": "boolean", "description": "Magnetic Stripe Flag - [Optional]" }, "contactlessFlag": { "type": "boolean", "description": "Contactless Flag - [Optional]" }, "rewardEarningFlag": { "type": "boolean", "description": "Reward Earning Flag - [Optional]" }, "cardBrand": { "type": "string", "description": "Card Brand - [Optional]", "nullable": true }, "cardBrandDescription": { "type": "string", "description": "Card Brand Description - [Optional]", "nullable": true }, "cardDeliveryType": { "type": "string", "description": "Card Delivery Type - [Optional]", "nullable": true }, "expiryDateStr": { "type": "string", "description": "Expiry Date Str - [Optional]", "nullable": true }, "provisionStatusFlag": { "type": "boolean", "description": "Provision Status Flag - [Optional]" }, "digitalCardFlag": { "type": "boolean", "description": "Digital Card Flag - [Optional]" }, "insertDate": { "type": "string", "description": "Insert Date - [Optional]", "format": "date-time", "nullable": true }, "cvv2RetryCount": { "type": "integer", "description": "Cvv2 Retry Count - [Optional]", "format": "int32" }, "pinRetryCount": { "type": "integer", "description": "Pin Retry Count - [Optional]", "format": "int32" }, "barcode": { "type": "string", "description": "Barcode - [Optional]", "nullable": true }, "fromShadowCardNumber": { "type": "string", "description": "From Shadow Card Number - [Optional]", "nullable": true }, "toShadowCardNumber": { "type": "string", "description": "To Shadow Card Number - [Optional]", "nullable": true }, "requestDate": { "type": "string", "description": "Request Date - [Optional]", "format": "date-time", "nullable": true }, "requestChannel": { "type": "string", "description": "Request Channel - [Optional]", "nullable": true }, "embossReasonCode": { "type": "string", "description": "Emboss Reason Code - [Optional]", "nullable": true }, "embossReasonDescription": { "type": "string", "description": "Emboss Reason Description - [Optional]", "nullable": true }, "embossReasonSubCode": { "type": "string", "description": "Emboss Reason Sub Code - [Optional]", "nullable": true }, "embossReasonSubDesc": { "type": "string", "description": "Emboss Reason Sub Desc - [Optional]", "nullable": true }, "cardStatusChangeDate": { "type": "string", "description": "Card Status Change Date - [Optional]", "format": "date-time", "nullable": true }, "lastTrnDate": { "type": "string", "description": "Last Trn Date - [Optional]", "format": "date-time", "nullable": true }, "firstPinSetDate": { "type": "string", "description": "First Pin Set Date - [Optional]", "format": "date-time", "nullable": true }, "lastPinChangeDate": { "type": "string", "description": "Last Pin Change Date - [Optional]", "format": "date-time", "nullable": true }, "deliveryAddress": { "type": "string", "description": "Delivery Address - [Optional]", "nullable": true }, "sendingBranchCode": { "type": "integer", "description": "Sending Branch Code - [Optional]", "format": "int32" }, "sendingAddressType": { "type": "string", "description": "Sending Address Type - [Optional]", "nullable": true }, "cardAccountInfoList": { "type": "array", "items": { "$ref": "#/components/schemas/CardAccountInfo" }, "description": "Card Account Info List - [Optional]", "nullable": true } } }, "DecryptDataBlockRequest": { "type": "object", "properties": { "encryptDataBlock": { "type": "string", "description": "Encrypt Data Block - [Optional]", "nullable": true } } }, "DecryptDataBlockResponse": { "type": "object", "properties": { "clearDataBlock": { "type": "string", "description": "Clear Data Block - [Optional]", "nullable": true } } }, "DeviceData": { "type": "object", "properties": { "deviceChannel": { "type": "string", "description": "Device Channel - [Optional]", "nullable": true }, "browserIP": { "type": "string", "description": "Browser I P - [Optional]", "nullable": true }, "deviceInfo": { "type": "string", "description": "Device Info - [Optional]", "nullable": true } } }, "DisputeList": { "type": "object", "properties": { "CaseNumber": { "type": "integer", "description": "Case Number - [Optional]", "format": "int64", "nullable": true }, "CustomerNumber": { "type": "integer", "description": "Customer Number - [Optional]", "format": "int64", "nullable": true }, "DisputeAmount": { "type": "number", "description": "Dispute Amount - [Optional]", "format": "double", "nullable": true }, "DisputeCurrencyCode": { "type": "string", "description": "Dispute Currency Code - [Optional]", "nullable": true }, "DisputeDate": { "type": "string", "description": "Dispute Date - [Optional]", "format": "date-time", "nullable": true }, "DisputeReasonCode": { "type": "string", "description": "Dispute Reason Code - [Optional]", "nullable": true }, "DisputeTransactionId": { "type": "integer", "description": "Dispute Transaction Id - [Optional]", "format": "int64", "nullable": true }, "InsertUserId": { "type": "string", "description": "Insert User Id - [Optional]", "nullable": true }, "MaskedCardNumber": { "type": "string", "description": "Masked Card Number - [Optional]", "nullable": true }, "MerchantName": { "type": "string", "description": "Merchant Name - [Optional]", "nullable": true }, "TrnAmount": { "type": "number", "description": "Trn Amount - [Optional]", "format": "double", "nullable": true }, "TrnCurrencyCode": { "type": "string", "description": "Trn Currency Code - [Optional]", "nullable": true }, "TrnDate": { "type": "string", "description": "Trn Date - [Optional]", "format": "date-time", "nullable": true }, "TrnStatusDescription": { "type": "string", "description": "Trn Status Description - [Optional]", "nullable": true }, "AuthorizationNumber": { "type": "string", "description": "Authorization Number - [Optional]", "nullable": true }, "Mcc": { "type": "string", "description": "Mcc - [Optional]", "nullable": true }, "SourceNetwork": { "type": "string", "description": "Source Network - [Optional]", "nullable": true }, "Utid": { "type": "string", "description": "Utid - [Optional]", "nullable": true } } }, "DisputeReasonDefinitions": { "required": [ "DisputeReasonCode" ], "type": "object", "properties": { "DisputeReasonCode": { "type": "integer", "description": "Dispute Reason Code - [Optional]", "format": "int32" }, "DisputeReasonDescription": { "type": "string", "description": "Dispute Reason Description - [Optional]", "nullable": true } } }, "DisputeTransactionDetail": { "required": [ "DisputeTransactionId" ], "type": "object", "properties": { "UTID": { "type": "string", "description": "U T I D - [Optional]", "nullable": true }, "DisputeTransactionId": { "type": "integer", "description": "Dispute Transaction Id - [Optional]", "format": "int64" } } }, "DmsReference": { "type": "object", "properties": { "DmsReferenceId": { "type": "string", "description": "Dms Reference Id - [Optional]", "nullable": true } } }, "DmsReferences": { "type": "object", "properties": { "DmsReferenceId": { "type": "string", "description": "Dms Reference Id - [Optional]", "nullable": true } } }, "EmbossReasonSubDef": { "required": [ "validFlag", "useFlag" ], "type": "object", "properties": { "validFlag": { "type": "boolean", "description": "Valid Flag - [Optional]" }, "embossReasonSubCode": { "type": "string", "description": "Emboss Reason Sub Code - [Optional]", "nullable": true }, "embossReasonSubDesc": { "type": "string", "description": "Emboss Reason Sub Desc - [Optional]", "nullable": true }, "useFlag": { "type": "boolean", "description": "Use Flag - [Optional]" } } }, "EncryptedAccountNumber": { "required": [ "cryptoAlgorithm", "keyID" ], "type": "object", "properties": { "encData": { "type": "string", "description": "Enc Data - [Optional]", "nullable": true }, "cryptoAlgorithm": { "type": "integer", "description": "Crypto Algorithm - [Optional]", "format": "int32" }, "keyID": { "type": "integer", "description": "Key Id - [Optional]", "format": "int32" } } }, "Error": { "type": "object", "properties": { "transactionId": { "type": "string", "description": "Transaction Id", "nullable": true }, "errorCode": { "type": "string", "description": "Error Code", "nullable": true }, "description": { "type": "string", "description": "Description", "nullable": true }, "message": { "type": "string", "description": "Message", "nullable": true }, "messageFormat": { "type": "string", "description": "Message Format", "nullable": true }, "arguments": { "type": "array", "items": { "type": "string" }, "description": "Arguments", "nullable": true }, "propertyName": { "type": "string", "description": "Property Name", "nullable": true }, "detail": { "type": "string", "description": "Detail", "nullable": true }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/Error" }, "description": "Items", "nullable": true }, "isTechnicalError": { "type": "boolean", "description": "Is Technical Error", "nullable": true }, "exceptionType": { "type": "string", "description": "Exception Type", "nullable": true } } }, "ExecuteCampaignTransactionRequest": { "required": [ "amount" ], "type": "object", "properties": { "shadowCardNumber": { "type": "string", "description": "Shadow Card Number - [Optional]", "nullable": true }, "trnCodeMatrixId": { "type": "string", "description": "Trn Code Matrix Id - [Optional]", "nullable": true }, "amount": { "type": "number", "description": "Amount - [Optional]", "format": "double" }, "currency": { "type": "string", "description": "Currency - [Optional]", "nullable": true }, "description": { "type": "string", "description": "Description - [Optional]", "nullable": true }, "requestChannel": { "type": "string", "description": "Request Channel - [Optional]", "nullable": true } } }, "ExecuteCampaignTransactionResponse": { "required": [ "trnId" ], "type": "object", "properties": { "utid": { "type": "string", "description": "Utid - [Optional]", "nullable": true }, "trnId": { "type": "integer", "description": "Trn Id - [Optional]", "format": "int64" } } }, "GetApplicableProductsByCustomerNumberRequest": { "required": [ "customerNumber", "receiveCreditProducts", "receiveDebitProducts", "receivePrepaidProducts" ], "type": "object", "properties": { "channel": { "type": "string", "description": "Channel - [Optional]", "nullable": true }, "customerNumber": { "type": "integer", "description": "Customer Number - [Optional]", "format": "int64" }, "mainCustomerNumber": { "type": "integer", "description": "Main Customer Number - [Optional]", "format": "int64", "nullable": true }, "filter": { "allOf": [ { "$ref": "#/components/schemas/ApplicableProductFilter" } ], "description": "Filter - [Optional]", "nullable": true }, "receiveCreditProducts": { "type": "boolean", "description": "Receive Credit Products - [Optional]" }, "receiveDebitProducts": { "type": "boolean", "description": "Receive Debit Products - [Optional]" }, "receivePrepaidProducts": { "type": "boolean", "description": "Receive Prepaid Products - [Optional]" } } }, "GetApplicableProductsByCustomerNumberResponse": { "type": "object", "properties": { "debit": { "allOf": [ { "$ref": "#/components/schemas/GetApplicableProductsDomain" } ], "description": "Debit - [Optional]", "nullable": true }, "credit": { "allOf": [ { "$ref": "#/components/schemas/GetApplicableProductsDomain" } ], "description": "Credit - [Optional]", "nullable": true }, "prepaid": { "allOf": [ { "$ref": "#/components/schemas/GetApplicableProductsDomain" } ], "description": "Prepaid - [Optional]", "nullable": true } } }, "GetApplicableProductsDomain": { "type": "object", "properties": { "listOfProduct": { "type": "array", "items": { "$ref": "#/components/schemas/GetApplicableProductsItem" }, "description": "List Of Product - [Optional]", "nullable": true } } }, "GetApplicableProductsItem": { "required": [ "digitalAbility" ], "type": "object", "properties": { "productNumber": { "type": "string", "description": "Product Number - [Optional]", "nullable": true }, "productName": { "type": "string", "description": "Product Name - [Optional]", "nullable": true }, "productShortName": { "type": "string", "description": "Product Short Name - [Optional]", "nullable": true }, "brand": { "type": "string", "description": "Brand - [Optional]", "nullable": true }, "digitalAbility": { "type": "boolean", "description": "Digital Ability - [Optional]" }, "tenantId": { "type": "string", "description": "Tenant Id - [Optional]", "nullable": true }, "cardAnnualFeeAmount": { "type": "number", "description": "Card Annual Fee Amount - [Optional]", "format": "double", "nullable": true } } }, "GetApplicableProductsRequest": { "type": "object", "properties": { "queryDate": { "type": "string", "description": "Query Date - [Optional]", "format": "date-time", "nullable": true } } }, "GetApplicableProductsResponse": { "type": "object", "properties": { "listOfProduct": { "type": "array", "items": { "$ref": "#/components/schemas/GetApplicableProductsResponseItem" }, "description": "List Of Product - [Optional]", "nullable": true } } }, "GetApplicableProductsResponseItem": { "required": [ "virtualAbility", "digitalAbility", "contactlessAbility", "emvAbility", "isNoName" ], "type": "object", "properties": { "productNumber": { "type": "string", "description": "Product Number - [Optional]", "nullable": true }, "productName": { "type": "string", "description": "Product Name - [Optional]", "nullable": true }, "productShortName": { "type": "string", "description": "Product Short Name - [Optional]", "nullable": true }, "brand": { "type": "string", "description": "Brand - [Optional]", "nullable": true }, "virtualAbility": { "type": "boolean", "description": "Virtual Ability - [Optional]" }, "digitalAbility": { "type": "boolean", "description": "Digital Ability - [Optional]" }, "typeCode": { "type": "string", "description": "Type Code - [Optional]", "nullable": true }, "segmentCode": { "type": "string", "description": "Segment Code - [Optional]", "nullable": true }, "bin": { "type": "string", "description": "Bin - [Optional]", "nullable": true }, "contactlessAbility": { "type": "boolean", "description": "Contactless Ability - [Optional]" }, "emvAbility": { "type": "boolean", "description": "Emv Ability - [Optional]" }, "groupCode": { "type": "string", "description": "Group Code - [Optional]", "nullable": true }, "classCode": { "type": "string", "description": "Class Code - [Optional]", "nullable": true }, "isNoName": { "type": "boolean", "description": "Is No Name - [Optional]" }, "typeCodeDetail": { "type": "string", "description": "Type Code Detail - [Optional]", "nullable": true }, "tenantId": { "type": "string", "description": "Tenant Id - [Optional]", "nullable": true }, "listOfApplicableChannel": { "type": "array", "items": { "type": "string" }, "description": "List Of Applicable Channel - [Optional]", "nullable": true } } }, "GetAssetByShadowCardNumberRequest": { "type": "object", "properties": { "shadowCardNumber": { "type": "string", "description": "Shadow Card Number - [Optional]", "nullable": true } } }, "GetAssetByShadowCardNumberResponse": { "required": [ "customerNumber", "supplementaryCard", "mainCustomerNumber", "insertDate" ], "type": "object", "properties": { "customerNumber": { "type": "integer", "description": "Customer Number - [Optional]", "format": "int64" }, "serviceDomainId": { "type": "string", "description": "Service Domain Id - [Optional]", "nullable": true }, "ownerName": { "type": "string", "description": "Owner Name - [Optional]", "nullable": true }, "maskedCardNumber": { "type": "string", "description": "Masked Card Number - [Optional]", "nullable": true }, "ownerSecondName": { "type": "string", "description": "Owner Second Name - [Optional]", "nullable": true }, "ownerSurname": { "type": "string", "description": "Owner Surname - [Optional]", "nullable": true }, "psn": { "type": "string", "description": "Psn - [Optional]", "nullable": true }, "bin": { "type": "string", "description": "Bin - [Optional]", "nullable": true }, "supplementaryCard": { "type": "boolean", "description": "Supplementary Card - [Optional]" }, "cardStatusCode": { "type": "string", "description": "Card Status Code - [Optional]", "nullable": true }, "cardStatusReasonCode": { "type": "string", "description": "Card Status Reason Code - [Optional]", "nullable": true }, "productNumber": { "type": "string", "description": "Product Number - [Optional]", "nullable": true }, "cardRefNumber": { "type": "string", "description": "Card Ref Number - [Optional]", "nullable": true }, "maskedPanAlternative": { "type": "string", "description": "Masked Pan Alternative - [Optional]", "nullable": true }, "mainCardRefNumber": { "type": "string", "description": "Main Card Ref Number - [Optional]", "nullable": true }, "ownerSearchName": { "type": "string", "description": "Owner Search Name - [Optional]", "nullable": true }, "mainCustomerNumber": { "type": "integer", "description": "Main Customer Number - [Optional]", "format": "int64" }, "insertUserId": { "type": "string", "description": "Insert User Id - [Optional]", "nullable": true }, "insertDate": { "type": "string", "description": "Insert Date - [Optional]", "format": "date-time" } } }, "GetAuthorizationListByBegindateEnddateParam": { "type": "object", "properties": { "AuthStatus": { "type": "string", "description": "Auth Status - [Optional]", "nullable": true }, "BeginDate": { "type": "string", "description": "Begin Date - [Optional]", "format": "date-time", "nullable": true }, "EndDate": { "type": "string", "description": "End Date - [Optional]", "format": "date-time", "nullable": true }, "MaxAmount": { "type": "number", "description": "Max Amount - [Optional]", "format": "double", "nullable": true }, "MinAmount": { "type": "number", "description": "Min Amount - [Optional]", "format": "double", "nullable": true }, "NetworkType": { "type": "string", "description": "Network Type - [Optional]", "nullable": true }, "ResponseCode": { "type": "string", "description": "Response Code - [Optional]", "nullable": true }, "ResponseReasonCode": { "type": "string", "description": "Response Reason Code - [Optional]", "nullable": true }, "ShadowCardNumber": { "type": "string", "description": "Shadow Card Number - [Optional]", "nullable": true }, "TrnCodeMatrixId": { "type": "string", "description": "Trn Code Matrix Id - [Optional]", "nullable": true } } }, "GetAuthorizationListByBegindateEnddateRequest": { "type": "object", "properties": { "GetAuthorizationListByBegindateEnddateParam": { "allOf": [ { "$ref": "#/components/schemas/GetAuthorizationListByBegindateEnddateParam" } ], "description": "Get Authorization List By Begindate Enddate Param - [Optional]", "nullable": true } } }, "GetAuthorizationListByBegindateEnddateResponse": { "type": "object", "properties": { "GetAuthorizationListByBegindateEnddateResult": { "type": "array", "items": { "$ref": "#/components/schemas/GetAuthorizationListByBegindateEnddateResult" }, "description": "Get Authorization List By Begindate Enddate Result - [Optional]", "nullable": true } } }, "GetAuthorizationListByBegindateEnddateResult": { "type": "object", "properties": { "AuthorizationMatchStatus": { "type": "string", "description": "Authorization Match Status - [Optional]", "nullable": true }, "AuthorizationNumber": { "type": "string", "description": "Authorization Number - [Optional]", "nullable": true }, "BkmUniqueMerchantId": { "type": "string", "description": "Bkm Unique Merchant Id - [Optional]", "nullable": true }, "CardRefNumber": { "type": "string", "description": "Card Ref Number - [Optional]", "nullable": true }, "CardSeqNumber": { "type": "integer", "description": "Card Seq Number - [Optional]", "format": "int32", "nullable": true }, "ChannelTypeDescription": { "type": "string", "description": "Channel Type Description - [Optional]", "nullable": true }, "Customer": { "type": "string", "description": "Customer - [Optional]", "nullable": true }, "CustomerNumber": { "type": "integer", "description": "Customer Number - [Optional]", "format": "int64", "nullable": true }, "IsChipFlag": { "type": "boolean", "description": "Is Chip Flag - [Optional]", "nullable": true }, "LocalAmount": { "type": "number", "description": "Local Amount - [Optional]", "format": "double", "nullable": true }, "LocalCurrencyDescription": { "type": "string", "description": "Local Currency Description - [Optional]", "nullable": true }, "MainCustomerNumber": { "type": "integer", "description": "Main Customer Number - [Optional]", "format": "int64", "nullable": true }, "MaskedCardNumber": { "type": "string", "description": "Masked Card Number - [Optional]", "nullable": true }, "MatchStatusDescription": { "type": "string", "description": "Match Status Description - [Optional]", "nullable": true }, "MccDescription": { "type": "string", "description": "Mcc Description - [Optional]", "nullable": true }, "MerchantCountryCode": { "type": "string", "description": "Merchant Country Code - [Optional]", "nullable": true }, "MerchantName": { "type": "string", "description": "Merchant Name - [Optional]", "nullable": true }, "NetworkTypeDescription": { "type": "string", "description": "Network Type Description - [Optional]", "nullable": true }, "OfflineFlag": { "type": "boolean", "description": "Offline Flag - [Optional]", "nullable": true }, "OpenReceiptFormIsEnabled": { "type": "number", "description": "Open Receipt Form Is Enabled - [Optional]", "format": "double", "nullable": true }, "PanEntryMode": { "type": "string", "description": "Pan Entry Mode - [Optional]", "nullable": true }, "PinUsage": { "type": "string", "description": "Pin Usage - [Optional]", "nullable": true }, "PreAuthorizationStatus": { "type": "string", "description": "Pre Authorization Status - [Optional]", "nullable": true }, "ProductName": { "type": "string", "description": "Product Name - [Optional]", "nullable": true }, "ResponseCodeDescription": { "type": "string", "description": "Response Code Description - [Optional]", "nullable": true }, "ResponseReasonCodeDescription": { "type": "string", "description": "Response Reason Code Description - [Optional]", "nullable": true }, "Rrn": { "type": "string", "description": "Rrn - [Optional]", "nullable": true }, "SettlementAmount": { "type": "number", "description": "Settlement Amount - [Optional]", "format": "double", "nullable": true }, "SettlementCurrencyDescription": { "type": "string", "description": "Settlement Currency Description - [Optional]", "nullable": true }, "SuccessCode": { "type": "string", "description": "Success Code - [Optional]", "nullable": true }, "TerminalNumber": { "type": "string", "description": "Terminal Number - [Optional]", "nullable": true }, "TerminalType": { "type": "string", "description": "Terminal Type - [Optional]", "nullable": true }, "TransactionDate": { "type": "string", "description": "Transaction Date - [Optional]", "format": "date-time", "nullable": true }, "TransactionDescription": { "type": "string", "description": "Transaction Description - [Optional]", "nullable": true }, "TransactionTime": { "type": "string", "description": "Transaction Time - [Optional]", "nullable": true }, "TrnAmount": { "type": "number", "description": "Trn Amount - [Optional]", "format": "double", "nullable": true }, "TrnCodeMatrixDescription": { "type": "string", "description": "Trn Code Matrix Description - [Optional]", "nullable": true }, "TrnCurrencyDescription": { "type": "string", "description": "Trn Currency Description - [Optional]", "nullable": true }, "TrnStatusDescription": { "type": "string", "description": "Trn Status Description - [Optional]", "nullable": true }, "Utid": { "type": "string", "description": "Utid - [Optional]", "nullable": true } } }, "GetAutoPaymentQueueParam": { "required": [ "dueDate", "endRowNo", "startRowNo" ], "type": "object", "properties": { "dueDate": { "type": "string", "description": "Due Date - [Optional]", "format": "date-time" }, "endRowNo": { "type": "integer", "description": "End Row No - [Optional]", "format": "int32" }, "startRowNo": { "type": "integer", "description": "Start Row No - [Optional]", "format": "int32" } } }, "GetAutoPaymentQueueRequest": { "type": "object", "properties": { "getAutoPaymentQueueParam": { "allOf": [ { "$ref": "#/components/schemas/GetAutoPaymentQueueParam" } ], "description": "Get Auto Payment Queue Param - [Optional]", "nullable": true } } }, "GetAutoPaymentQueueResponse": { "type": "object", "properties": { "getAutoPaymentQueueResult": { "type": "array", "items": { "$ref": "#/components/schemas/GetAutoPaymentQueueResult" }, "description": "Get Auto Payment Queue Result - [Optional]", "nullable": true } } }, "GetAutoPaymentQueueResult": { "type": "object", "properties": { "customerNumber": { "type": "integer", "description": "Customer Number - [Optional]", "format": "int32", "nullable": true }, "dailyPaymentAmount": { "type": "number", "description": "Daily Payment Amount - [Optional]", "format": "double", "nullable": true }, "dueDate": { "type": "string", "description": "Due Date - [Optional]", "format": "date-time", "nullable": true }, "dueOptionDate": { "type": "string", "description": "Due Option Date - [Optional]", "format": "date-time", "nullable": true }, "mainCardRefNumber": { "type": "string", "description": "Main Card Ref Number - [Optional]", "nullable": true }, "maskedCardNumber": { "type": "string", "description": "Masked Card Number - [Optional]", "nullable": true }, "paymentAccountBranchCode": { "type": "integer", "description": "Payment Account Branch Code - [Optional]", "format": "int32", "nullable": true }, "paymentAccountNumber": { "type": "number", "description": "Payment Account Number - [Optional]", "format": "double", "nullable": true }, "paymentAccountOwnerName": { "type": "string", "description": "Payment Account Owner Name - [Optional]", "nullable": true }, "paymentAccountSuffix": { "type": "integer", "description": "Payment Account Suffix - [Optional]", "format": "int32", "nullable": true }, "paymentTotalCurrent": { "type": "number", "description": "Payment Total Current - [Optional]", "format": "double", "nullable": true }, "paymentType": { "type": "string", "description": "Payment Type - [Optional]", "nullable": true }, "remainingMinimumPaymentAmount": { "type": "number", "description": "Remaining Minimum Payment Amount - [Optional]", "format": "double", "nullable": true }, "remainingAmount": { "type": "number", "description": "Remaining Amount - [Optional]", "format": "double", "nullable": true }, "shadowCardNumber": { "type": "string", "description": "Shadow Card Number - [Optional]", "nullable": true }, "statementCurrencyCode": { "type": "string", "description": "Statement Currency Code - [Optional]", "nullable": true }, "statementDate": { "type": "string", "description": "Statement Date - [Optional]", "format": "date-time", "nullable": true }, "statementMinAmount": { "type": "number", "description": "Statement Min Amount - [Optional]", "format": "double", "nullable": true }, "statementTotalAmount": { "type": "number", "description": "Statement Total Amount - [Optional]", "format": "double", "nullable": true } } }, "GetAvailableCardStatusListRequest": { "type": "object", "properties": { "shadowCardNumber": { "type": "string", "description": "Shadow Card Number - [Optional]", "nullable": true }, "channel": { "type": "string", "description": "Channel - [Optional]", "nullable": true } } }, "GetAvailableCardStatusListResponse": { "type": "object", "properties": { "listOfStatus": { "type": "array", "items": { "$ref": "#/components/schemas/GetAvailableCardStatusListResponseItem" }, "description": "List Of Status - [Optional]", "nullable": true } } }, "GetAvailableCardStatusListResponseItem": { "type": "object", "properties": { "statusCode": { "type": "string", "description": "Status Code - [Optional]", "nullable": true }, "statusDescription": { "type": "string", "description": "Status Description - [Optional]", "nullable": true }, "reasonCode": { "type": "string", "description": "Reason Code - [Optional]", "nullable": true }, "reasonDescription": { "type": "string", "description": "Reason Description - [Optional]", "nullable": true } } }, "GetAvailableEmbossReasonByCardStatusResult": { "type": "object", "properties": { "embossReasonSubCode": { "type": "string", "description": "Emboss Reason Sub Code - [Optional]", "nullable": true }, "embossReasonSubDesc": { "type": "string", "description": "Emboss Reason Sub Desc - [Optional]", "nullable": true }, "statusCode": { "type": "string", "description": "Status Code - [Optional]", "nullable": true }, "statusReasonCode": { "type": "string", "description": "Status Reason Code - [Optional]", "nullable": true } } }, "GetAvailableEmbossReasonListRequest": { "type": "object", "properties": { "shadowCardNumber": { "type": "string", "description": "Shadow Card Number - [Optional]", "nullable": true } } }, "GetAvailableEmbossReasonListResponse": { "type": "object", "properties": { "getAvailableEmbossReasonByCardStatusResult": { "type": "array", "items": { "$ref": "#/components/schemas/GetAvailableEmbossReasonByCardStatusResult" }, "description": "Get Available Emboss Reason By Card Status Result - [Optional]", "nullable": true } } }, "GetBasicCardInformationByPanRequest": { "type": "object", "properties": { "pan": { "type": "string", "description": "Pan - [Optional]", "nullable": true } } }, "GetBasicCardInformationByPanResponse": { "required": [ "customerNumber" ], "type": "object", "properties": { "bin": { "type": "string", "description": "Bin - [Optional]", "nullable": true }, "psn": { "type": "string", "description": "Psn - [Optional]", "nullable": true }, "cardType": { "type": "string", "description": "Card Type - [Optional]", "nullable": true }, "encryptedCardNumber": { "type": "string", "description": "Encrypted Card Number - [Optional]", "nullable": true }, "maskedCardNumber": { "type": "string", "description": "Masked Card Number - [Optional]", "nullable": true }, "hashCardNumber": { "type": "string", "description": "Hash Card Number - [Optional]", "nullable": true }, "shadowCardNumber": { "type": "string", "description": "Shadow Card Number - [Optional]", "nullable": true }, "customerNumber": { "type": "integer", "description": "Customer Number - [Optional]", "format": "int64" } } }, "GetBinDomesticByBinRequest": { "type": "object", "properties": { "bin": { "type": "string", "description": "Bin - [Optional]", "nullable": true } } }, "GetBinDomesticByBinResponse": { "required": [ "validFlag", "acqFlag", "bonusFlag", "businessFlag", "preAuthDebitFlag" ], "type": "object", "properties": { "validFlag": { "type": "boolean", "description": "Valid Flag - [Optional]" }, "binMinValue": { "type": "string", "description": "Bin Min Value - [Optional]", "nullable": true }, "binMaxValue": { "type": "string", "description": "Bin Max Value - [Optional]", "nullable": true }, "binDescription": { "type": "string", "description": "Bin Description - [Optional]", "nullable": true }, "processorBin": { "type": "string", "description": "Processor Bin - [Optional]", "nullable": true }, "issuerBankCode": { "type": "string", "description": "Issuer Bank Code - [Optional]", "nullable": true }, "cardType": { "type": "string", "description": "Card Type - [Optional]", "nullable": true }, "cardBrand": { "type": "string", "description": "Card Brand - [Optional]", "nullable": true }, "panLength": { "type": "integer", "description": "Pan Length - [Optional]", "format": "int32", "nullable": true }, "acqFlag": { "type": "boolean", "description": "Acq Flag - [Optional]" }, "rewardType": { "type": "string", "description": "Reward Type - [Optional]", "nullable": true }, "bonusFlag": { "type": "boolean", "description": "Bonus Flag - [Optional]" }, "businessFlag": { "type": "boolean", "description": "Business Flag - [Optional]" }, "preAuthDebitFlag": { "type": "boolean", "description": "Pre Auth Debit Flag - [Optional]" }, "authenticationType": { "type": "string", "description": "Authentication Type - [Optional]", "nullable": true }, "loyaltyProgram": { "type": "string", "description": "Loyalty Program - [Optional]", "nullable": true }, "binLength": { "type": "string", "description": "Bin Length - [Optional]", "nullable": true } } }, "GetCardByCardNumberRequest": { "type": "object", "properties": { "cardNumber": { "type": "string", "description": "Card Number - [Optional]", "nullable": true }, "panSequenceNumber": { "type": "string", "description": "Pan Sequence Number - [Optional]", "nullable": true } } }, "GetCardByCardNumberResponse": { "required": [ "customerNumber", "expiryDate", "mainCustomerNumber" ], "type": "object", "properties": { "hashCardNumber": { "type": "string", "description": "Hash Card Number - [Optional]", "nullable": true }, "encryptedCardNumber": { "type": "string", "description": "Encrypted Card Number - [Optional]", "nullable": true }, "maskedCardNumber": { "type": "string", "description": "Masked Card Number - [Optional]", "nullable": true }, "customerNumber": { "type": "integer", "description": "Customer Number - [Optional]", "format": "int64" }, "bin": { "type": "string", "description": "Bin - [Optional]", "nullable": true }, "shadowCardNumber": { "type": "string", "description": "Shadow Card Number - [Optional]", "nullable": true }, "expiryDate": { "type": "string", "description": "Expiry Date - [Optional]", "format": "date-time" }, "cardSeqNumber": { "type": "string", "description": "Card Seq Number - [Optional]", "nullable": true }, "statusCode": { "type": "string", "description": "Status Code - [Optional]", "nullable": true }, "statusReasonCode": { "type": "string", "description": "Status Reason Code - [Optional]", "nullable": true }, "cardNumber": { "type": "string", "description": "Card Number - [Optional]", "nullable": true }, "cardType": { "type": "string", "description": "Card Type - [Optional]", "nullable": true }, "productNumber": { "type": "string", "description": "Product Number - [Optional]", "nullable": true }, "cardRefNumber": { "type": "string", "description": "Card Ref Number - [Optional]", "nullable": true }, "maskedPanAlternative": { "type": "string", "description": "Masked Pan Alternative - [Optional]", "nullable": true }, "mainCardRefNumber": { "type": "string", "description": "Main Card Ref Number - [Optional]", "nullable": true }, "ownerSearchName": { "type": "string", "description": "Owner Search Name - [Optional]", "nullable": true }, "mainCustomerNumber": { "type": "integer", "description": "Main Customer Number - [Optional]", "format": "int64" } } }, "GetCardByShadowCardNumberRequest": { "type": "object", "properties": { "channel": { "type": "string", "description": "Channel - [Optional]", "nullable": true }, "shadowCardNumber": { "type": "string", "description": "Shadow Card Number - [Optional]", "nullable": true } } }, "GetCardByShadowCardNumberResponse": { "required": [ "customerNumber", "expiryDate", "mainCustomerNumber" ], "type": "object", "properties": { "hashCardNumber": { "type": "string", "description": "Hash Card Number - [Optional]", "nullable": true }, "encryptedCardNumber": { "type": "string", "description": "Encrypted Card Number - [Optional]", "nullable": true }, "maskedCardNumber": { "type": "string", "description": "Masked Card Number - [Optional]", "nullable": true }, "customerNumber": { "type": "integer", "description": "Customer Number - [Optional]", "format": "int64" }, "bin": { "type": "string", "description": "Bin - [Optional]", "nullable": true }, "shadowCardNumber": { "type": "string", "description": "Shadow Card Number - [Optional]", "nullable": true }, "expiryDate": { "type": "string", "description": "Expiry Date - [Optional]", "format": "date-time" }, "cardSeqNumber": { "type": "string", "description": "Card Seq Number - [Optional]", "nullable": true }, "statusCode": { "type": "string", "description": "Status Code - [Optional]", "nullable": true }, "statusReasonCode": { "type": "string", "description": "Status Reason Code - [Optional]", "nullable": true }, "cardNumber": { "type": "string", "description": "Card Number - [Optional]", "nullable": true }, "cardType": { "type": "string", "description": "Card Type - [Optional]", "nullable": true }, "productNumber": { "type": "string", "description": "Product Number - [Optional]", "nullable": true }, "cardRefNumber": { "type": "string", "description": "Card Ref Number - [Optional]", "nullable": true }, "maskedPanAlternative": { "type": "string", "description": "Masked Pan Alternative - [Optional]", "nullable": true }, "mainCardRefNumber": { "type": "string", "description": "Main Card Ref Number - [Optional]", "nullable": true }, "ownerSearchName": { "type": "string", "description": "Owner Search Name - [Optional]", "nullable": true }, "mainCustomerNumber": { "type": "integer", "description": "Main Customer Number - [Optional]", "format": "int64" }, "maskedPanSmart": { "type": "string", "description": "Masked Pan Smart - [Optional]", "nullable": true } } }, "GetCardDelinquencyInfoByCustomerNumberRequest": { "required": [ "mainCustomerNumber" ], "type": "object", "properties": { "mainCustomerNumber": { "type": "integer", "description": "Main Customer Number - [Optional]", "format": "int64" } } }, "GetCardDelinquencyInfoByCustomerNumberResponse": { "required": [ "digitalCardLimit", "customerLimit", "delinquencyDayCount", "statementRemainAmount", "delinquencyPeriod", "newDeficientPaymentCounter", "dayCoutAfterLimitIncrease", "dayCoutAfterLimitDecrease" ], "type": "object", "properties": { "digitalCardLimit": { "type": "number", "description": "Digital Card Limit - [Optional]", "format": "double" }, "customerLimit": { "type": "number", "description": "Customer Limit - [Optional]", "format": "double" }, "delinquencyStatus": { "type": "string", "description": "Delinquency Status - [Optional]", "nullable": true }, "delinquencyDayCount": { "type": "integer", "description": "Delinquency Day Count - [Optional]", "format": "int32" }, "statementRemainAmount": { "type": "number", "description": "Statement Remain Amount - [Optional]", "format": "double" }, "delinquencyPeriod": { "type": "integer", "description": "Delinquency Period - [Optional]", "format": "int32" }, "newDeficientPaymentCounter": { "type": "integer", "description": "New Deficient Payment Counter - [Optional]", "format": "int32" }, "dayCoutAfterLimitIncrease": { "type": "integer", "description": "Day Cout After Limit Increase - [Optional]", "format": "int32" }, "dayCoutAfterLimitDecrease": { "type": "integer", "description": "Day Cout After Limit Decrease - [Optional]", "format": "int32" } } }, "GetCardInfoByClearPanRequest": { "type": "object", "properties": { "clearPan": { "type": "string", "description": "Clear Pan - [Optional]", "nullable": true } } }, "GetCardInfoByClearPanResponse": { "required": [ "customerNumber", "expiryDate", "mainCustomerNumber" ], "type": "object", "properties": { "hashCardNumber": { "type": "string", "description": "Hash Card Number - [Optional]", "nullable": true }, "encryptedCardNumber": { "type": "string", "description": "Encrypted Card Number - [Optional]", "nullable": true }, "maskedCardNumber": { "type": "string", "description": "Masked Card Number - [Optional]", "nullable": true }, "customerNumber": { "type": "integer", "description": "Customer Number - [Optional]", "format": "int64" }, "bin": { "type": "string", "description": "Bin - [Optional]", "nullable": true }, "shadowCardNumber": { "type": "string", "description": "Shadow Card Number - [Optional]", "nullable": true }, "expiryDate": { "type": "string", "description": "Expiry Date - [Optional]", "format": "date-time" }, "cardSeqNumber": { "type": "string", "description": "Card Seq Number - [Optional]", "nullable": true }, "statusCode": { "type": "string", "description": "Status Code - [Optional]", "nullable": true }, "statusReasonCode": { "type": "string", "description": "Status Reason Code - [Optional]", "nullable": true }, "clearPan": { "type": "string", "description": "Clear Pan - [Optional]", "nullable": true }, "cardType": { "type": "string", "description": "Card Type - [Optional]", "nullable": true }, "productNumber": { "type": "string", "description": "Product Number - [Optional]", "nullable": true }, "cardRefNumber": { "type": "string", "description": "Card Ref Number - [Optional]", "nullable": true }, "maskedPanAlternative": { "type": "string", "description": "Masked Pan Alternative - [Optional]", "nullable": true }, "mainCardRefNumber": { "type": "string", "description": "Main Card Ref Number - [Optional]", "nullable": true }, "ownerSearchName": { "type": "string", "description": "Owner Search Name - [Optional]", "nullable": true }, "mainCustomerNumber": { "type": "integer", "description": "Main Customer Number - [Optional]", "format": "int64" } } }, "GetCardOperationLimitRequest": { "type": "object", "properties": { "channel": { "type": "string", "description": "Channel - [Optional]", "nullable": true }, "cardRefNumber": { "type": "string", "description": "Card Ref Number - [Optional]", "nullable": true }, "cardType": { "type": "string", "description": "Card Type - [Optional]", "nullable": true } } }, "GetCardOperationLimitResponse": { "type": "object", "properties": { "listOfOperationLimit": { "type": "array", "items": { "$ref": "#/components/schemas/OperationLimitItem" }, "description": "List Of Operation Limit - [Optional]", "nullable": true } } }, "GetCardStatementCutoffRequest": { "required": [ "insertDate" ], "type": "object", "properties": { "shadowCardNumber": { "type": "string", "description": "Shadow Card Number - [Optional]", "nullable": true }, "mainCardRefNumber": { "type": "string", "description": "Main Card Ref Number - [Optional]", "nullable": true }, "customerNumber": { "type": "integer", "description": "Customer Number - [Optional]", "format": "int64", "nullable": true }, "insertDate": { "type": "string", "description": "Insert Date - [Optional]", "format": "date-time" } } }, "GetCardStatementCutoffResponse": { "type": "object", "properties": { "listOfCardStatementCutoff": { "type": "array", "items": { "$ref": "#/components/schemas/CreditCardStatementCutoffItem" }, "description": "List Of Card Statement Cutoff - [Optional]", "nullable": true } } }, "GetCardTypeByBinRequest": { "type": "object", "properties": { "bin": { "type": "string", "description": "Bin - [Optional]", "nullable": true } } }, "GetCardTypeByBinResponse": { "required": [ "cardType" ], "type": "object", "properties": { "cardType": { "enum": [ 0, 1, 2, 3 ], "type": "integer", "description": "Card Type - [Optional]", "format": "int32", "x-enum-names": [ "None", "Credit", "Debit", "Prepaid" ] } } }, "GetClearPanByShadowRequest": { "type": "object", "properties": { "shadowCardNumber": { "type": "string", "description": "Shadow Card Number - [Optional]", "nullable": true } } }, "GetClearPanByShadowResponse": { "type": "object", "properties": { "clearPan": { "type": "string", "description": "Clear Pan - [Optional]", "nullable": true } } }, "GetCreditCardLogDataListByShadowCardNumberRequest": { "required": [ "customerNumber", "startDate", "endDate" ], "type": "object", "properties": { "shadowCardNumber": { "type": "string", "description": "Shadow Card Number - [Optional]", "nullable": true }, "logCode": { "type": "string", "description": "Log Code - [Optional]", "nullable": true }, "customerNumber": { "type": "integer", "description": "Customer Number - [Optional]", "format": "int64" }, "startDate": { "type": "string", "description": "Start Date - [Optional]", "format": "date-time" }, "endDate": { "type": "string", "description": "End Date - [Optional]", "format": "date-time" } } }, "GetCreditCardLogDataListByShadowCardNumberResponse": { "type": "object", "properties": { "cardLogDataList": { "type": "array", "items": { "$ref": "#/components/schemas/CreditCardLogData" }, "description": "Card Log Data List - [Optional]", "nullable": true } } }, "GetCreditTransactionListRequest": { "required": [ "transactiondatebegin", "transactiondateend" ], "type": "object", "properties": { "shadowCardNumber": { "type": "string", "description": "Shadow Card Number - [Optional]", "nullable": true }, "embossName": { "type": "string", "description": "Emboss Name - [Optional]", "nullable": true }, "maxAmount": { "type": "number", "description": "Max Amount - [Optional]", "format": "double", "nullable": true }, "minAmount": { "type": "number", "description": "Min Amount - [Optional]", "format": "double", "nullable": true }, "sourceNetwork": { "type": "string", "description": "Source Network - [Optional]", "nullable": true }, "transactiondatebegin": { "type": "string", "description": "Transactiondatebegin - [Optional]", "format": "date-time" }, "transactiondateend": { "type": "string", "description": "Transactiondateend - [Optional]", "format": "date-time" }, "trnCodeMatrixId": { "type": "string", "description": "Trn Code Matrix Id - [Optional]", "nullable": true }, "trnCode": { "type": "string", "description": "Trn Code - [Optional]", "nullable": true } } }, "GetCreditTransactionListResponse": { "type": "object", "properties": { "creditTransaction": { "type": "array", "items": { "$ref": "#/components/schemas/CreditTransactionList" }, "description": "Credit Transaction - [Optional]", "nullable": true } } }, "GetCustomerDetailRequest": { "required": [ "customerNumber", "getEmailDetail", "getAddressDetail", "getPhoneDetail", "getGsmDetail" ], "type": "object", "properties": { "channel": { "type": "string", "description": "Channel - [Optional]", "nullable": true }, "customerNumber": { "type": "integer", "description": "Customer Number - [Optional]", "format": "int64" }, "getEmailDetail": { "type": "boolean", "description": "Get Email Detail - [Optional]" }, "getAddressDetail": { "type": "boolean", "description": "Get Address Detail - [Optional]" }, "getPhoneDetail": { "type": "boolean", "description": "Get Phone Detail - [Optional]" }, "getGsmDetail": { "type": "boolean", "description": "Get Gsm Detail - [Optional]" }, "commCompanyCode": { "type": "string", "description": "Comm Company Code - [Optional]", "nullable": true } } }, "GetCustomerDetailResponse": { "type": "object", "properties": { "customer": { "allOf": [ { "$ref": "#/components/schemas/GetCustomerInfo" } ], "description": "Customer - [Optional]", "nullable": true } } }, "GetCustomerInfo": { "type": "object", "properties": { "masterInformation": { "allOf": [ { "$ref": "#/components/schemas/CustomerMaster" } ], "description": "Master Information - [Optional]", "nullable": true }, "firmInformation": { "allOf": [ { "$ref": "#/components/schemas/CustomerFirmInfo" } ], "description": "Firm Information - [Optional]", "nullable": true }, "personalInformation": { "allOf": [ { "$ref": "#/components/schemas/CustomerPersonalInfo" } ], "description": "Personal Information - [Optional]", "nullable": true }, "listOfAddress": { "type": "array", "items": { "$ref": "#/components/schemas/CustomerAddress" }, "description": "List Of Address - [Optional]", "nullable": true }, "listOfPhone": { "type": "array", "items": { "$ref": "#/components/schemas/CustomerPhone" }, "description": "List Of Phone - [Optional]", "nullable": true }, "listOfEmail": { "type": "array", "items": { "$ref": "#/components/schemas/CustomerEMail" }, "description": "List Of Email - [Optional]", "nullable": true }, "listOfGSM": { "type": "array", "items": { "$ref": "#/components/schemas/CustomerGsm" }, "description": "List Of G S M - [Optional]", "nullable": true } } }, "GetCustomerOperationLimitRequest": { "required": [ "customerNumber" ], "type": "object", "properties": { "channel": { "type": "string", "description": "Channel - [Optional]", "nullable": true }, "customerNumber": { "type": "integer", "description": "Customer Number - [Optional]", "format": "int64" } } }, "GetCustomerOperationLimitResponse": { "type": "object", "properties": { "listOfOperationLimit": { "type": "array", "items": { "$ref": "#/components/schemas/OperationLimitItem" }, "description": "List Of Operation Limit - [Optional]", "nullable": true } } }, "GetDbttransactionByCardrefCustomernumParam": { "type": "object", "properties": { "AuthStatus": { "type": "string", "description": "Auth Status - [Optional]", "nullable": true }, "CardRefNumber": { "type": "string", "description": "Card Ref Number - [Optional]", "nullable": true }, "CustomerNumber": { "type": "integer", "description": "Customer Number - [Optional]", "format": "int64", "nullable": true }, "EmbossName": { "type": "string", "description": "Emboss Name - [Optional]", "nullable": true }, "MaxAmount": { "type": "number", "description": "Max Amount - [Optional]", "format": "double", "nullable": true }, "MinAmount": { "type": "number", "description": "Min Amount - [Optional]", "format": "double", "nullable": true }, "ShadowCardNumber": { "type": "string", "description": "Shadow Card Number - [Optional]", "nullable": true }, "SourceNetwork": { "type": "string", "description": "Source Network - [Optional]", "nullable": true }, "Transactiondatebegin": { "type": "string", "description": "Transactiondatebegin - [Optional]", "format": "date-time", "nullable": true }, "Transactiondateend": { "type": "string", "description": "Transactiondateend - [Optional]", "format": "date-time", "nullable": true }, "TrnCodeMatrixId": { "type": "string", "description": "Trn Code Matrix Id - [Optional]", "nullable": true } } }, "GetDbttransactionByCardrefCustomernumRequest": { "type": "object", "properties": { "GetDbttransactionByCardrefCustomernumParam": { "allOf": [ { "$ref": "#/components/schemas/GetDbttransactionByCardrefCustomernumParam" } ], "description": "Get Dbttransaction By Cardref Customernum Param - [Optional]", "nullable": true } } }, "GetDbttransactionByCardrefCustomernumResponse": { "type": "object", "properties": { "GetDbttransactionByCardrefCustomernumResult": { "type": "array", "items": { "$ref": "#/components/schemas/GetDbttransactionByCardrefCustomernumResult" }, "description": "Get Dbttransaction By Cardref Customernum Result - [Optional]", "nullable": true } } }, "GetDbttransactionByCardrefCustomernumResult": { "required": [ "IsChipFlag" ], "type": "object", "properties": { "AcqRefNumber": { "type": "string", "description": "Acq Ref Number - [Optional]", "nullable": true }, "AuthorizationMatchStatus": { "type": "string", "description": "Authorization Match Status - [Optional]", "nullable": true }, "AuthorizationNumber": { "type": "string", "description": "Authorization Number - [Optional]", "nullable": true }, "BillingAmount": { "type": "number", "description": "Billing Amount - [Optional]", "format": "double", "nullable": true }, "BillingCurrency": { "type": "string", "description": "Billing Currency - [Optional]", "nullable": true }, "BkmUniqueMerchantId": { "type": "string", "description": "Bkm Unique Merchant Id - [Optional]", "nullable": true }, "CampaignCodeAcq": { "type": "string", "description": "Campaign Code Acq - [Optional]", "nullable": true }, "CampaignCodeIss": { "type": "string", "description": "Campaign Code Iss - [Optional]", "nullable": true }, "CardSeqNumber": { "type": "integer", "description": "Card Seq Number - [Optional]", "format": "int32", "nullable": true }, "ChannelTypeDescription": { "type": "string", "description": "Channel Type Description - [Optional]", "nullable": true }, "ClearingChannel": { "type": "string", "description": "Clearing Channel - [Optional]", "nullable": true }, "ClearingDate": { "type": "string", "description": "Clearing Date - [Optional]", "format": "date-time", "nullable": true }, "ClearingNumber": { "type": "integer", "description": "Clearing Number - [Optional]", "format": "int64", "nullable": true }, "CurrencyCodeDescription": { "type": "string", "description": "Currency Code Description - [Optional]", "nullable": true }, "CustomerNumber": { "type": "integer", "description": "Customer Number - [Optional]", "format": "int64", "nullable": true }, "DisplayAtChannels": { "type": "integer", "description": "Display At Channels - [Optional]", "format": "int32", "nullable": true }, "EarnedRewardBank": { "type": "number", "description": "Earned Reward Bank - [Optional]", "format": "double", "nullable": true }, "EarnedRewardCampaignAcq": { "type": "number", "description": "Earned Reward Campaign Acq - [Optional]", "format": "double", "nullable": true }, "EarnedRewardCampaignIss": { "type": "number", "description": "Earned Reward Campaign Iss - [Optional]", "format": "double", "nullable": true }, "EarnedRewardMerchant": { "type": "number", "description": "Earned Reward Merchant - [Optional]", "format": "double", "nullable": true }, "EmbossName": { "type": "string", "description": "Emboss Name - [Optional]", "nullable": true }, "EodDate": { "type": "string", "description": "Eod Date - [Optional]", "format": "date-time", "nullable": true }, "InvoiceNumber": { "type": "string", "description": "Invoice Number - [Optional]", "nullable": true }, "IsChipFlag": { "type": "boolean", "description": "Is Chip Flag - [Optional]" }, "LocalAmount": { "type": "number", "description": "Local Amount - [Optional]", "format": "double", "nullable": true }, "LocalCurrency": { "type": "string", "description": "Local Currency - [Optional]", "nullable": true }, "MainCardRefNumber": { "type": "string", "description": "Main Card Ref Number - [Optional]", "nullable": true }, "MainCustomerNumber": { "type": "integer", "description": "Main Customer Number - [Optional]", "format": "int64", "nullable": true }, "MaskedCardNumber": { "type": "string", "description": "Masked Card Number - [Optional]", "nullable": true }, "MatchStatusDescription": { "type": "string", "description": "Match Status Description - [Optional]", "nullable": true }, "MccDescription": { "type": "string", "description": "Mcc Description - [Optional]", "nullable": true }, "MerchantAmexId": { "type": "string", "description": "Merchant Amex Id - [Optional]", "nullable": true }, "MerchantCity": { "type": "string", "description": "Merchant City - [Optional]", "nullable": true }, "MerchantCountryCode": { "type": "string", "description": "Merchant Country Code - [Optional]", "nullable": true }, "MerchantName": { "type": "string", "description": "Merchant Name - [Optional]", "nullable": true }, "NetworkDescription": { "type": "string", "description": "Network Description - [Optional]", "nullable": true }, "OfflineFlag": { "type": "boolean", "description": "Offline Flag - [Optional]", "nullable": true }, "PanEntryMode": { "type": "string", "description": "Pan Entry Mode - [Optional]", "nullable": true }, "PinUsage": { "type": "string", "description": "Pin Usage - [Optional]", "nullable": true }, "Product": { "type": "string", "description": "Product - [Optional]", "nullable": true }, "RefUtid": { "type": "string", "description": "Ref Utid - [Optional]", "nullable": true }, "RequestDate": { "type": "string", "description": "Request Date - [Optional]", "format": "date-time", "nullable": true }, "RewardTypeDescription": { "type": "string", "description": "Reward Type Description - [Optional]", "nullable": true }, "Rrn": { "type": "string", "description": "Rrn - [Optional]", "nullable": true }, "SettlementAmount": { "type": "number", "description": "Settlement Amount - [Optional]", "format": "double", "nullable": true }, "SettlementCurrency": { "type": "string", "description": "Settlement Currency - [Optional]", "nullable": true }, "TerminalNumber": { "type": "string", "description": "Terminal Number - [Optional]", "nullable": true }, "TerminalType": { "type": "string", "description": "Terminal Type - [Optional]", "nullable": true }, "TrnAmount": { "type": "number", "description": "Trn Amount - [Optional]", "format": "double", "nullable": true }, "TrnCodeMatrixDesc": { "type": "string", "description": "Trn Code Matrix Desc - [Optional]", "nullable": true }, "TrnCurrency": { "type": "string", "description": "Trn Currency - [Optional]", "nullable": true }, "TrnDate": { "type": "string", "description": "Trn Date - [Optional]", "format": "date-time", "nullable": true }, "TrnDescription": { "type": "string", "description": "Trn Description - [Optional]", "nullable": true }, "TrnOrigin": { "type": "integer", "description": "Trn Origin - [Optional]", "format": "int32", "nullable": true }, "TrnStatusDescription": { "type": "string", "description": "Trn Status Description - [Optional]", "nullable": true }, "Utid": { "type": "string", "description": "Utid - [Optional]", "nullable": true } } }, "GetDebitCardForRewardByBankRequest": { "required": [ "customerNumber" ], "type": "object", "properties": { "channel": { "type": "string", "description": "Channel - [Optional]", "nullable": true }, "customerNumber": { "type": "integer", "description": "Customer Number - [Optional]", "format": "int64" } } }, "GetDebitCardForRewardByBankResponse": { "type": "object", "properties": { "accountNumber": { "type": "integer", "description": "Account Number - [Optional]", "format": "int64", "nullable": true }, "maskedCardNumber": { "type": "string", "description": "Masked Card Number - [Optional]", "nullable": true }, "shadowCardNumber": { "type": "string", "description": "Shadow Card Number - [Optional]", "nullable": true } } }, "GetDebitCardInfoRequest": { "type": "object", "properties": { "shadowCardNumber": { "type": "string", "description": "Shadow Card Number - [Optional]", "nullable": true } } }, "GetDebitCardInfoResponse": { "type": "object", "properties": { "cardInfo": { "allOf": [ { "$ref": "#/components/schemas/DebitCardModel" } ], "description": "Card Info - [Optional]", "nullable": true } } }, "GetDebitCardLogDataListByShadowCardNumberRequest": { "required": [ "customerNumber", "startDate", "endDate" ], "type": "object", "properties": { "shadowCardNumber": { "type": "string", "description": "Shadow Card Number - [Optional]", "nullable": true }, "logCode": { "type": "string", "description": "Log Code - [Optional]", "nullable": true }, "customerNumber": { "type": "integer", "description": "Customer Number - [Optional]", "format": "int64" }, "startDate": { "type": "string", "description": "Start Date - [Optional]", "format": "date-time" }, "endDate": { "type": "string", "description": "End Date - [Optional]", "format": "date-time" } } }, "GetDebitCardLogDataListByShadowCardNumberResponse": { "type": "object", "properties": { "cardLogDataList": { "type": "array", "items": { "$ref": "#/components/schemas/CardLogData" }, "description": "Card Log Data List - [Optional]", "nullable": true } } }, "GetDebitCardRestrictionRequest": { "type": "object", "properties": { "shadowCardNumber": { "type": "string", "description": "Shadow Card Number - [Optional]", "nullable": true } } }, "GetDebitCardRestrictionResponse": { "type": "object", "properties": { "cardRestrictionList": { "type": "array", "items": { "$ref": "#/components/schemas/CardRestriction" }, "description": "Card Restriction List - [Optional]", "nullable": true } } }, "GetDebitTransactionAllRequest": { "type": "object", "properties": { "shadowCardNumber": { "type": "string", "description": "Shadow Card Number - [Optional]", "nullable": true }, "beginDate": { "type": "string", "description": "Begin Date - [Optional]", "format": "date-time", "nullable": true }, "endDate": { "type": "string", "description": "End Date - [Optional]", "format": "date-time", "nullable": true }, "responseCode": { "type": "string", "description": "Response Code - [Optional]", "nullable": true }, "responseReasonCode": { "type": "string", "description": "Response Reason Code - [Optional]", "nullable": true }, "networkType": { "type": "string", "description": "Network Type - [Optional]", "nullable": true }, "trnCodeMatrixId": { "type": "string", "description": "Trn Code Matrix Id - [Optional]", "nullable": true }, "maxAmount": { "type": "number", "description": "Max Amount - [Optional]", "format": "double", "nullable": true }, "minAmount": { "type": "number", "description": "Min Amount - [Optional]", "format": "double", "nullable": true }, "authStatus": { "type": "string", "description": "Auth Status - [Optional]", "nullable": true } } }, "GetDebitTransactionAllResponse": { "type": "object", "properties": { "listOfTransaction": { "type": "array", "items": { "$ref": "#/components/schemas/GetDebitTransactionAllResponseItem" }, "description": "List Of Transaction - [Optional]", "nullable": true } } }, "GetDebitTransactionAllResponseItem": { "type": "object", "properties": { "terminalNumber": { "type": "string", "description": "Terminal Number - [Optional]", "nullable": true }, "authorizationNumber": { "type": "string", "description": "Authorization Number - [Optional]", "nullable": true }, "authorizationMatchStatus": { "type": "string", "description": "Authorization Match Status - [Optional]", "nullable": true }, "cardRefNumber": { "type": "string", "description": "Card Ref Number - [Optional]", "nullable": true }, "cardSeqNumber": { "type": "integer", "description": "Card Seq Number - [Optional]", "format": "int32", "nullable": true }, "channelTypeDescription": { "type": "string", "description": "Channel Type Description - [Optional]", "nullable": true }, "customerNumber": { "type": "integer", "description": "Customer Number - [Optional]", "format": "int64", "nullable": true }, "isChipFlag": { "type": "string", "description": "Is Chip Flag - [Optional]", "nullable": true }, "localAmount": { "type": "number", "description": "Local Amount - [Optional]", "format": "double", "nullable": true }, "localCurrencyDescription": { "type": "string", "description": "Local Currency Description - [Optional]", "nullable": true }, "mainCustomerNumber": { "type": "integer", "description": "Main Customer Number - [Optional]", "format": "int64", "nullable": true }, "maskedCardNumber": { "type": "string", "description": "Masked Card Number - [Optional]", "nullable": true }, "matchStatusDescription": { "type": "string", "description": "Match Status Description - [Optional]", "nullable": true }, "mccDescription": { "type": "string", "description": "Mcc Description - [Optional]", "nullable": true }, "merchantCountryCode": { "type": "string", "description": "Merchant Country Code - [Optional]", "nullable": true }, "merchantName": { "type": "string", "description": "Merchant Name - [Optional]", "nullable": true }, "networkTypeDescription": { "type": "string", "description": "Network Type Description - [Optional]", "nullable": true }, "offlineFlag": { "type": "boolean", "description": "Offline Flag - [Optional]", "nullable": true }, "panEntryMode": { "type": "string", "description": "Pan Entry Mode - [Optional]", "nullable": true }, "pinUsage": { "type": "string", "description": "Pin Usage - [Optional]", "nullable": true }, "responseCodeDescription": { "type": "string", "description": "Response Code Description - [Optional]", "nullable": true }, "responseReasonCodeDescription": { "type": "string", "description": "Response Reason Code Description - [Optional]", "nullable": true }, "rrn": { "type": "string", "description": "Rrn - [Optional]", "nullable": true }, "settlementAmount": { "type": "number", "description": "Settlement Amount - [Optional]", "format": "double", "nullable": true }, "settlementCurrencyDescription": { "type": "string", "description": "Settlement Currency Description - [Optional]", "nullable": true }, "terminalType": { "type": "string", "description": "Terminal Type - [Optional]", "nullable": true }, "transactionDate": { "type": "string", "description": "Transaction Date - [Optional]", "format": "date-time", "nullable": true }, "trnAmount": { "type": "number", "description": "Trn Amount - [Optional]", "format": "double", "nullable": true }, "trnCodeMatrixDescription": { "type": "string", "description": "Trn Code Matrix Description - [Optional]", "nullable": true }, "trnCurrencyDescription": { "type": "string", "description": "Trn Currency Description - [Optional]", "nullable": true }, "trnStatusDescription": { "type": "string", "description": "Trn Status Description - [Optional]", "nullable": true }, "utid": { "type": "string", "description": "Utid - [Optional]", "nullable": true }, "bkmUniqueMerchantId": { "type": "string", "description": "Bkm Unique Merchant Id - [Optional]", "nullable": true }, "trnDescription": { "type": "string", "description": "Trn Description - [Optional]", "nullable": true } } }, "GetDelinquencyInterestAmount": { "required": [ "rate", "delayAmountWithTax" ], "type": "object", "properties": { "currencyCode": { "type": "string", "description": "Currency Code - [Optional]", "nullable": true }, "mainCardRefNumber": { "type": "string", "description": "Main Card Ref Number - [Optional]", "nullable": true }, "rate": { "type": "number", "description": "Rate - [Optional]", "format": "double" }, "delayAmountWithTax": { "type": "number", "description": "Delay Amount With Tax - [Optional]", "format": "double" }, "delayType": { "type": "string", "description": "Delay Type - [Optional]", "nullable": true } } }, "GetDelinquencyInterestAmountRequest": { "type": "object", "properties": { "shadowCardNumber": { "type": "string", "description": "Shadow Card Number - [Optional]", "nullable": true } } }, "GetDisputeListRequest": { "required": [ "CaseNumber", "DisputeTransactionId", "CustomerNumber" ], "type": "object", "properties": { "CaseNumber": { "type": "integer", "description": "Case Number - [Optional]", "format": "int32" }, "DisputeTransactionId": { "type": "integer", "description": "Dispute Transaction Id - [Optional]", "format": "int64" }, "UTID": { "type": "string", "description": "U T I D - [Optional]", "nullable": true }, "CustomerNumber": { "type": "integer", "description": "Customer Number - [Optional]", "format": "int64" }, "ShadowCardNumber": { "type": "string", "description": "Shadow Card Number - [Optional]", "nullable": true }, "CardRefNumber": { "type": "string", "description": "Card Ref Number - [Optional]", "nullable": true }, "EncryptedCardNumber": { "type": "string", "description": "Encrypted Card Number - [Optional]", "nullable": true }, "CardNumber": { "type": "string", "description": "Card Number - [Optional]", "nullable": true } } }, "GetDisputeListResponse": { "type": "object", "properties": { "DisputeTransaction": { "type": "array", "items": { "$ref": "#/components/schemas/DisputeList" }, "description": "Dispute List - [Optional]", "nullable": true } } }, "GetDisputeReasonDefResponse": { "type": "object", "properties": { "DisputeReasonDefinitions": { "type": "array", "items": { "$ref": "#/components/schemas/DisputeReasonDefinitions" }, "description": "Dispute Reason Definitions - [Optional]", "nullable": true } } }, "GetEmbossReasonSubDefByValidFlagResponse": { "type": "object", "properties": { "embossReasonSubDefList": { "type": "array", "items": { "$ref": "#/components/schemas/EmbossReasonSubDef" }, "description": "Emboss Reason Sub Def List - [Optional]", "nullable": true } } }, "GetEncryptDataBlockRequest": { "type": "object", "properties": { "dataBlock": { "type": "string", "description": "Data Block - [Optional]", "nullable": true } } }, "GetEncryptDataBlockResponse": { "type": "object", "properties": { "encryptedDataBlock": { "type": "string", "description": "Encrypted Data Block - [Optional]", "nullable": true } } }, "GetMccGroupAllResponse": { "type": "object", "properties": { "listOfMccGroup": { "type": "array", "items": { "$ref": "#/components/schemas/MccGroup" }, "description": "List Of Mcc Group - [Optional]", "nullable": true } } }, "GetNetworkTypeDefByValidFlagResponse": { "type": "object", "properties": { "NetworkTypeDefList": { "type": "array", "items": { "$ref": "#/components/schemas/NetworkTypeDef" }, "description": "Network Type Def List - [Optional]", "nullable": true } } }, "GetPaymentAndCashadvanceInformationByCriterias": { "type": "object", "properties": { "channelType": { "type": "string", "description": "Channel Type - [Optional]", "nullable": true }, "channelTypeDescription": { "type": "string", "description": "Channel Type Description - [Optional]", "nullable": true }, "maskedCardNumber": { "type": "string", "description": "Masked Card Number - [Optional]", "nullable": true }, "paymentDate": { "type": "string", "description": "Payment Date - [Optional]", "format": "date-time", "nullable": true }, "productTransactionRefNo": { "type": "string", "description": "Product Transaction Ref No - [Optional]", "nullable": true }, "provisionNo": { "type": "string", "description": "Provision No - [Optional]", "nullable": true }, "shadowCardNumber": { "type": "string", "description": "Shadow Card Number - [Optional]", "nullable": true }, "statusCode": { "type": "string", "description": "Status Code - [Optional]", "nullable": true }, "statusCodeDescription": { "type": "string", "description": "Status Code Description - [Optional]", "nullable": true }, "trnAmount": { "type": "number", "description": "Trn Amount - [Optional]", "format": "double", "nullable": true }, "trnCode": { "type": "string", "description": "Trn Code - [Optional]", "nullable": true }, "trnCodeMatrixId": { "type": "string", "description": "Trn Code Matrix Id - [Optional]", "nullable": true }, "trnCurrencyCode": { "type": "string", "description": "Trn Currency Code - [Optional]", "nullable": true }, "trnDescription": { "type": "string", "description": "Trn Description - [Optional]", "nullable": true } } }, "GetPaymentAndCashadvanceInformationByCriteriasRequest": { "type": "object", "properties": { "channelType": { "type": "string", "description": "Channel Type - [Optional]", "nullable": true }, "customerNumber": { "type": "integer", "description": "Customer Number - [Optional]", "format": "int64", "nullable": true }, "beginDate": { "type": "string", "description": "Begin Date - [Optional]", "format": "date-time", "nullable": true }, "endDate": { "type": "string", "description": "End Date - [Optional]", "format": "date-time", "nullable": true }, "shadowCardNumber": { "type": "string", "description": "Shadow Card Number - [Optional]", "nullable": true }, "trnCodeMatrix": { "type": "string", "description": "Trn Code Matrix - [Optional]", "nullable": true }, "branchNo": { "type": "integer", "description": "Branch No - [Optional]", "format": "int64", "nullable": true } } }, "GetPaymentAndCashadvanceInformationByCriteriasResponse": { "type": "object", "properties": { "getPaymentAndCashadvanceInformationByCriterias": { "type": "array", "items": { "$ref": "#/components/schemas/GetPaymentAndCashadvanceInformationByCriterias" }, "description": "Get Payment And Cashadvance Information By Criterias - [Optional]", "nullable": true } } }, "GetPendingCardEmbossListRequest": { "type": "object", "properties": { "shadowCardNumber": { "type": "string", "description": "Shadow Card Number - [Optional]", "nullable": true } } }, "GetPendingCardEmbossListResponse": { "type": "object", "properties": { "cardSeqNumber": { "type": "integer", "description": "Card Seq Number - [Optional]", "format": "int32", "nullable": true }, "embossDate": { "type": "string", "description": "Emboss Date - [Optional]", "format": "date-time", "nullable": true }, "applicationDate": { "type": "string", "description": "Application Date - [Optional]", "format": "date-time", "nullable": true }, "embossReasonCode": { "type": "string", "description": "Emboss Reason Code - [Optional]", "nullable": true }, "embossReasonDescription": { "type": "string", "description": "Emboss Reason Description - [Optional]", "nullable": true }, "embossReasonSubCode": { "type": "string", "description": "Emboss Reason Sub Code - [Optional]", "nullable": true }, "embossReasonSubDesc": { "type": "string", "description": "Emboss Reason Sub Desc - [Optional]", "nullable": true }, "embossStatus": { "type": "string", "description": "Emboss Status - [Optional]", "nullable": true }, "maskedCardNumber": { "type": "string", "description": "Masked Card Number - [Optional]", "nullable": true }, "productTypeCode": { "type": "string", "description": "Product Type Code - [Optional]", "nullable": true }, "productTypeDescription": { "type": "string", "description": "Product Type Description - [Optional]", "nullable": true }, "shadowCardNumber": { "type": "string", "description": "Shadow Card Number - [Optional]", "nullable": true }, "validFlag": { "type": "boolean", "description": "Valid Flag - [Optional]", "nullable": true } } }, "GetProductByShadowCardNumberRequest": { "type": "object", "properties": { "shadowCardNumber": { "type": "string", "description": "Shadow Card Number - [Optional]", "nullable": true } } }, "GetProductByShadowCardNumberResponse": { "required": [ "cardType", "digitalAbility" ], "type": "object", "properties": { "cardType": { "enum": [ 0, 1, 2, 3 ], "type": "integer", "description": "Card Type - [Optional]", "format": "int32", "x-enum-names": [ "None", "Credit", "Debit", "Prepaid" ] }, "brand": { "type": "string", "description": "Brand - [Optional]", "nullable": true }, "productNumber": { "type": "string", "description": "Product Number - [Optional]", "nullable": true }, "productName": { "type": "string", "description": "Product Name - [Optional]", "nullable": true }, "productShortname": { "type": "string", "description": "Product Shortname - [Optional]", "nullable": true }, "digitalAbility": { "type": "boolean", "description": "Digital Ability - [Optional]" } } }, "GetResponseCodeDefByValidFlagResponse": { "type": "object", "properties": { "ResponseCodeDefList": { "type": "array", "items": { "$ref": "#/components/schemas/ResponseCodeDef" }, "description": "Response Code Def List - [Optional]", "nullable": true } } }, "GetResponseReasonCodeDefByValidFlagResponse": { "type": "object", "properties": { "ResponseReasonCodeDefList": { "type": "array", "items": { "$ref": "#/components/schemas/ResponseReasonCodeDef" }, "description": "Response Reason Code Def List - [Optional]", "nullable": true } } }, "GetSecureCardByPanRequest": { "type": "object", "properties": { "channel": { "type": "string", "description": "Channel - [Optional]", "nullable": true }, "pan": { "type": "string", "description": "Pan - [Optional]", "nullable": true } } }, "GetSecureCardByPanResponse": { "type": "object", "properties": { "encryptedCardNumber": { "type": "string", "description": "Encrypted Card Number - [Optional]", "nullable": true }, "hashCardNumber": { "type": "string", "description": "Hash Card Number - [Optional]", "nullable": true }, "firstEight": { "type": "string", "description": "First Eight - [Optional]", "nullable": true }, "firstSix": { "type": "string", "description": "First Six - [Optional]", "nullable": true }, "lastFour": { "type": "string", "description": "Last Four - [Optional]", "nullable": true }, "recordId": { "type": "integer", "description": "Record Id - [Optional]", "format": "int64", "nullable": true } } }, "GetTrnCodeDefByValidFlagResponse": { "type": "object", "properties": { "TrnCodeDefList": { "type": "array", "items": { "$ref": "#/components/schemas/TrnCodeDef" }, "description": "Trn Code Def List - [Optional]", "nullable": true } } }, "GetTrnCodeMatrixByValidFlagResponse": { "type": "object", "properties": { "TrnCodeMatrixList": { "type": "array", "items": { "$ref": "#/components/schemas/TrnCodeMatrix" }, "description": "Trn Code Matrix List - [Optional]", "nullable": true } } }, "GetTrnStatusAllResponse": { "type": "object", "properties": { "listOfTrnStatus": { "type": "array", "items": { "$ref": "#/components/schemas/TrnStatus" }, "description": "List Of Trn Status - [Optional]", "nullable": true } } }, "HealthCheckResponse": { "required": [ "date" ], "type": "object", "properties": { "result": { "type": "string", "description": "Result - [Optional]", "nullable": true }, "date": { "type": "string", "description": "Date - [Optional]", "format": "date-time" } } }, "HomePhone": { "type": "object", "properties": { "cc": { "type": "string", "description": "Cc - [Optional]", "nullable": true }, "subscriber": { "type": "string", "description": "Subscriber - [Optional]", "nullable": true } } }, "IsSetCardPinViaSMSControlRequest": { "type": "object", "properties": { "mobilePhoneNumber": { "type": "string", "description": "Mobile Phone Number - [Optional]", "nullable": true }, "cardNumberLastFourDigits": { "type": "string", "description": "Card Number Last Four Digits - [Optional]", "nullable": true } } }, "IsSetCardPinViaSMSControlResponse": { "required": [ "isHaveAnyCard", "customerNumber" ], "type": "object", "properties": { "isHaveAnyCard": { "type": "boolean", "description": "Is Have Any Card - [Optional]" }, "customerNumber": { "type": "integer", "description": "Customer Number - [Optional]", "format": "int64" }, "shadowCardNumber": { "type": "string", "description": "Shadow Card Number - [Optional]", "nullable": true } } }, "ListGetDelinquencyInterestAmountResponse": { "type": "object", "properties": { "listOfDelinquency": { "type": "array", "items": { "$ref": "#/components/schemas/GetDelinquencyInterestAmount" }, "description": "List Of Delinquency - [Optional]", "nullable": true } } }, "MccGroup": { "required": [ "validFlag", "useInApplicationFlag" ], "type": "object", "properties": { "validFlag": { "type": "boolean", "description": "Valid Flag - [Optional]" }, "institutionCode": { "type": "string", "description": "Institution Code - [Optional]", "nullable": true }, "mccGroupCode": { "type": "string", "description": "Mcc Group Code - [Optional]", "nullable": true }, "mccGroupDescription": { "type": "string", "description": "Mcc Group Description - [Optional]", "nullable": true }, "useInApplicationFlag": { "type": "boolean", "description": "Use In Application Flag - [Optional]" }, "qualificationIndicatorCode": { "type": "string", "description": "Qualification Indicator Code - [Optional]", "nullable": true }, "kk100hOrderNumber": { "type": "integer", "description": "Kk100h Order Number - [Optional]", "format": "int32", "nullable": true } } }, "MerchantData": { "type": "object", "properties": { "acquirerMerchantID": { "type": "string", "description": "Acquirer Merchant I D - [Optional]", "nullable": true }, "merchantRiskIndicator": { "allOf": [ { "$ref": "#/components/schemas/MerchantRiskIndicator" } ], "description": "Merchant Risk Indicator - [Optional]", "nullable": true }, "merchantCountryCode": { "type": "string", "description": "Merchant Country Code - [Optional]", "nullable": true }, "merchantName": { "type": "string", "description": "Merchant Name - [Optional]", "nullable": true }, "mcc": { "type": "string", "description": "Mcc - [Optional]", "nullable": true } } }, "MerchantRiskIndicator": { "type": "object", "properties": { "shipIndicator": { "type": "string", "description": "Ship Indicator - [Optional]", "nullable": true }, "deliveryTimeframe": { "type": "string", "description": "Delivery Time Frame - [Optional]", "nullable": true }, "deliveryEmailAddress": { "type": "string", "description": "Delivery Email Address - [Optional]", "nullable": true }, "reorderItemsInd": { "type": "string", "description": "Reorder Items Ind - [Optional]", "nullable": true }, "preOrderPurchaseInd": { "type": "string", "description": "Pre Order Purchase Ind - [Optional]", "nullable": true }, "preOrderDate": { "type": "string", "description": "Pre Order Date - [Optional]", "nullable": true }, "giftCardAmount": { "type": "string", "description": "Gift Card Amount - [Optional]", "nullable": true }, "giftCardCurr": { "type": "string", "description": "Gift Card Curr - [Optional]", "nullable": true }, "giftCardCount": { "type": "string", "description": "Gift Card Count - [Optional]", "nullable": true } } }, "MobileNo": { "type": "object", "properties": { "cc": { "type": "string", "description": "Cc - [Optional]", "nullable": true }, "subscriber": { "type": "string", "description": "Subscriber - [Optional]", "nullable": true } } }, "MobilePhone": { "type": "object", "properties": { "cc": { "type": "string", "description": "Cc - [Optional]", "nullable": true }, "subscriber": { "type": "string", "description": "Subscriber - [Optional]", "nullable": true } } }, "NetworkTypeDef": { "required": [ "insertDate", "validFlag" ], "type": "object", "properties": { "insertDate": { "type": "string", "description": "Insert Date - [Optional]", "format": "date-time" }, "insertUserId": { "type": "string", "description": "Insert User Id - [Optional]", "nullable": true }, "insertTokenId": { "type": "string", "description": "Insert Token Id - [Optional]", "nullable": true }, "updateDate": { "type": "string", "description": "Update Date - [Optional]", "format": "date-time", "nullable": true }, "updateUserId": { "type": "string", "description": "Update User Id - [Optional]", "nullable": true }, "updateTokenId": { "type": "string", "description": "Update Token Id - [Optional]", "nullable": true }, "validFlag": { "type": "boolean", "description": "Valid Flag - [Optional]" }, "networkType": { "type": "string", "description": "Network Type - [Optional]", "nullable": true }, "networkTypeDescription": { "type": "string", "description": "Network Type Description - [Optional]", "nullable": true } } }, "OperationLimitErrorItem": { "type": "object", "properties": { "errorCode": { "type": "string", "description": "Error Code - [Optional]", "nullable": true }, "errorText": { "type": "string", "description": "Error Text - [Optional]", "nullable": true } } }, "OperationLimitItem": { "type": "object", "properties": { "profileCode": { "type": "string", "description": "Profile Code - [Optional]", "nullable": true }, "profileDescription": { "type": "string", "description": "Profile Description - [Optional]", "nullable": true }, "keys": { "allOf": [ { "$ref": "#/components/schemas/OperationLimitItemKeys" } ], "description": "Keys - [Optional]", "nullable": true }, "perTrnAmount": { "type": "number", "description": "Per Trn Amount - [Optional]", "format": "double", "nullable": true }, "perTrnAmountLimitRatio": { "type": "number", "description": "Per Trn Amount Limit Ratio - [Optional]", "format": "double", "nullable": true }, "dailyTrnCount": { "type": "integer", "description": "Daily Trn Count - [Optional]", "format": "int32", "nullable": true }, "dailyTrnAmount": { "type": "number", "description": "Daily Trn Amount - [Optional]", "format": "double", "nullable": true }, "weeklyTrnCount": { "type": "integer", "description": "Weekly Trn Count - [Optional]", "format": "int32", "nullable": true }, "weeklyTrnAmount": { "type": "number", "description": "Weekly Trn Amount - [Optional]", "format": "double", "nullable": true }, "monthlyTrnCount": { "type": "integer", "description": "Monthly Trn Count - [Optional]", "format": "int32", "nullable": true }, "monthlyTrnAmount": { "type": "number", "description": "Monthly Trn Amount - [Optional]", "format": "double", "nullable": true }, "yearlyTrnCount": { "type": "integer", "description": "Yearly Trn Count - [Optional]", "format": "int32", "nullable": true }, "yearlyTrnAmount": { "type": "number", "description": "Yearly Trn Amount - [Optional]", "format": "double", "nullable": true }, "cardType": { "type": "string", "description": "Card Type - [Optional]", "nullable": true } } }, "OperationLimitItemKeys": { "type": "object", "properties": { "limitProfileDetailId": { "type": "integer", "description": "Limit Profile Detail Id - [Optional]", "format": "int64", "nullable": true }, "trnLimitationGroupCode": { "type": "string", "description": "Trn Limitation Group Code - [Optional]", "nullable": true }, "trnLimitationGroupDescription": { "type": "string", "description": "Trn Limitation Group Description - [Optional]", "nullable": true }, "trnMainLimitationGroupCode": { "type": "string", "description": "Trn Main Limitation Group Code - [Optional]", "nullable": true }, "trnMainLimitationGroupDescription": { "type": "string", "description": "Trn Main Limitation Group Description - [Optional]", "nullable": true }, "networkType": { "type": "string", "description": "Network Type - [Optional]", "nullable": true }, "networkDescription": { "type": "string", "description": "Network Description - [Optional]", "nullable": true }, "channelType": { "type": "string", "description": "Channel Type - [Optional]", "nullable": true }, "channelDescription": { "type": "string", "description": "Channel Description - [Optional]", "nullable": true }, "eventCode": { "type": "string", "description": "Event Code - [Optional]", "nullable": true }, "eventDescription": { "type": "string", "description": "Event Description - [Optional]", "nullable": true } } }, "RemoveCardOperationLimitRequest": { "type": "object", "properties": { "channel": { "type": "string", "description": "Channel - [Optional]", "nullable": true }, "cardRefNumber": { "type": "string", "description": "Card Ref Number - [Optional]", "nullable": true }, "listOfRemoveOperationLimitKeys": { "type": "array", "items": { "$ref": "#/components/schemas/RemoveOperationLimitItemKeys" }, "description": "List Of Remove Operation Limit Keys - [Optional]", "nullable": true }, "cardType": { "type": "string", "description": "Card Type - [Optional]", "nullable": true } } }, "RemoveCardOperationLimitResponse": { "type": "object", "properties": { "listOfResult": { "type": "array", "items": { "$ref": "#/components/schemas/RemoveCardOperationLimitResponseItem" }, "description": "List Of Result - [Optional]", "nullable": true } } }, "RemoveCardOperationLimitResponseItem": { "required": [ "actionType", "success" ], "type": "object", "properties": { "actionType": { "enum": [ 0, 1, 2, 3 ], "type": "integer", "description": "Action Type - [Optional]", "format": "int32", "x-enum-names": [ "None", "Insert", "Update", "Delete" ] }, "success": { "type": "boolean", "description": "Success - [Optional]" }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/OperationLimitErrorItem" }, "description": "Errors - [Optional]", "nullable": true }, "operationLimitKeys": { "allOf": [ { "$ref": "#/components/schemas/RemoveOperationLimitItemKeys" } ], "description": "Operation Limit Keys - [Optional]", "nullable": true } } }, "RemoveCustomerOperationLimitRequest": { "required": [ "customerNumber" ], "type": "object", "properties": { "channel": { "type": "string", "description": "Channel - [Optional]", "nullable": true }, "customerNumber": { "type": "integer", "description": "Customer Number - [Optional]", "format": "int64" }, "listOfRemoveOperationLimitKeys": { "type": "array", "items": { "$ref": "#/components/schemas/RemoveOperationLimitItemKeys" }, "description": "List Of Remove Operation Limit Keys - [Optional]", "nullable": true } } }, "RemoveCustomerOperationLimitResponse": { "type": "object", "properties": { "listOfResult": { "type": "array", "items": { "$ref": "#/components/schemas/RemoveCustomerOperationLimitResponseItem" }, "description": "List Of Result - [Optional]", "nullable": true } } }, "RemoveCustomerOperationLimitResponseItem": { "required": [ "actionType", "success" ], "type": "object", "properties": { "actionType": { "enum": [ 0, 1, 2, 3 ], "type": "integer", "description": "Action Type - [Optional]", "format": "int32", "x-enum-names": [ "None", "Insert", "Update", "Delete" ] }, "success": { "type": "boolean", "description": "Success - [Optional]" }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/OperationLimitErrorItem" }, "description": "Errors - [Optional]", "nullable": true }, "operationLimitKeys": { "allOf": [ { "$ref": "#/components/schemas/RemoveOperationLimitItemKeys" } ], "description": "Operation Limit Keys - [Optional]", "nullable": true } } }, "RemoveOperationLimitItemKeys": { "required": [ "operationLimitRecordId" ], "type": "object", "properties": { "operationLimitRecordId": { "type": "integer", "description": "Operation Limit Record Id - [Optional]", "format": "int64" } } }, "ReplaceDebitCardRequest": { "required": [ "deliveryBranchCode" ], "type": "object", "properties": { "channel": { "type": "string", "description": "Channel - [Optional]", "nullable": true }, "shadowCardNumber": { "type": "string", "description": "Shadow Card Number - [Optional]", "nullable": true }, "embossName": { "type": "string", "description": "Emboss Name - [Optional]", "nullable": true }, "deliveryType": { "type": "string", "description": "Delivery Type - [Optional]", "nullable": true }, "deliveryBranchCode": { "type": "integer", "description": "Delivery Branch Code - [Optional]", "format": "int32" }, "deliveryAddressType": { "type": "string", "description": "Delivery Address Type - [Optional]", "nullable": true }, "cardEmbossReason": { "type": "string", "description": "Card Emboss Reason - [Optional]", "nullable": true }, "cardEmbossSubReason": { "type": "string", "description": "Card Emboss Sub Reason - [Optional]", "nullable": true }, "renewType": { "type": "string", "description": "Renew Type - [Optional]", "nullable": true }, "productNumber": { "type": "string", "description": "Product Number - [Optional]", "nullable": true }, "digitalCard": { "type": "boolean", "description": "Digital Card - [Optional]", "nullable": true }, "permissions": { "allOf": [ { "$ref": "#/components/schemas/ReplaceDebitCardRequestPermissions" } ], "description": "Permissions - [Optional]", "nullable": true } } }, "ReplaceDebitCardRequestPermissions": { "type": "object", "properties": { "eCommercePermitted": { "type": "boolean", "description": "E Commerce Permitted - [Optional]", "nullable": true }, "mailOrderPermitted": { "type": "boolean", "description": "Mail Order Permitted - [Optional]", "nullable": true } } }, "ReplaceDebitCardResponse": { "required": [ "newCardGenerated", "productChanged" ], "type": "object", "properties": { "shadowCardNumber": { "type": "string", "description": "Shadow Card Number - [Optional]", "nullable": true }, "newCardGenerated": { "type": "boolean", "description": "New Card Generated - [Optional]" }, "productChanged": { "type": "boolean", "description": "Product Changed - [Optional]" }, "cardRefNumber": { "type": "string", "description": "Card Ref Number - [Optional]", "nullable": true }, "maskedCardNumber": { "type": "string", "description": "Masked Card Number - [Optional]", "nullable": true } } }, "ResponseCodeDef": { "required": [ "insertDate", "validFlag", "successFlag" ], "type": "object", "properties": { "insertDate": { "type": "string", "description": "Insert Date - [Optional]", "format": "date-time" }, "insertUserId": { "type": "string", "description": "Insert User Id - [Optional]", "nullable": true }, "insertTokenId": { "type": "string", "description": "Insert Token Id - [Optional]", "nullable": true }, "updateDate": { "type": "string", "description": "Update Date - [Optional]", "format": "date-time", "nullable": true }, "updateUserId": { "type": "string", "description": "Update User Id - [Optional]", "nullable": true }, "updateTokenId": { "type": "string", "description": "Update Token Id - [Optional]", "nullable": true }, "validFlag": { "type": "boolean", "description": "Valid Flag - [Optional]" }, "transactionDomain": { "type": "string", "description": "Transaction Domain - [Optional]", "nullable": true }, "responseCode": { "type": "string", "description": "Response Code - [Optional]", "nullable": true }, "responseCodeDescription": { "type": "string", "description": "Response Code Description - [Optional]", "nullable": true }, "successFlag": { "type": "boolean", "description": "Success Flag - [Optional]" } } }, "ResponseReasonCodeDef": { "required": [ "insertDate", "validFlag" ], "type": "object", "properties": { "insertDate": { "type": "string", "description": "Insert Date - [Optional]", "format": "date-time" }, "insertUserId": { "type": "string", "description": "Insert User Id - [Optional]", "nullable": true }, "insertTokenId": { "type": "string", "description": "Insert Token Id - [Optional]", "nullable": true }, "updateDate": { "type": "string", "description": "Update Date - [Optional]", "format": "date-time", "nullable": true }, "updateUserId": { "type": "string", "description": "Update User Id - [Optional]", "nullable": true }, "updateTokenId": { "type": "string", "description": "Update Token Id - [Optional]", "nullable": true }, "validFlag": { "type": "boolean", "description": "Valid Flag - [Optional]" }, "responseReasonCode": { "type": "string", "description": "Response Reason Code - [Optional]", "nullable": true }, "responseReasonDescription": { "type": "string", "description": "Response Reason Description - [Optional]", "nullable": true }, "descriptionLocal": { "type": "string", "description": "Description Local - [Optional]", "nullable": true } } }, "Result": { "type": "object", "properties": { "resultCode": { "type": "string", "description": "Result Code - [Optional]", "nullable": true }, "resultMsg": { "type": "string", "description": "Result Msg - [Optional]", "nullable": true }, "resultDetail": { "type": "string", "description": "Result Detail - [Optional]", "nullable": true } } }, "SetCardOperationLimitModel": { "required": [ "actionType", "success" ], "type": "object", "properties": { "actionType": { "enum": [ 0, 1, 2, 3 ], "type": "integer", "description": "Action Type - [Optional]", "format": "int32", "x-enum-names": [ "None", "Insert", "Update", "Delete" ] }, "success": { "type": "boolean", "description": "Success - [Optional]" }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/OperationLimitErrorItem" }, "description": "Errors - [Optional]", "nullable": true }, "operationLimit": { "allOf": [ { "$ref": "#/components/schemas/OperationLimitItem" } ], "description": "Operation Limit - [Optional]", "nullable": true } } }, "SetCardOperationLimitRequest": { "type": "object", "properties": { "channel": { "type": "string", "description": "Channel - [Optional]", "nullable": true }, "cardRefNumber": { "type": "string", "description": "Card Ref Number - [Optional]", "nullable": true }, "listOfOperationLimit": { "type": "array", "items": { "$ref": "#/components/schemas/OperationLimitItem" }, "description": "List Of Operation Limit - [Optional]", "nullable": true }, "cardType": { "type": "string", "description": "Card Type - [Optional]", "nullable": true } } }, "SetCardOperationLimitResponse": { "type": "object", "properties": { "listOfResult": { "type": "array", "items": { "$ref": "#/components/schemas/SetCardOperationLimitModel" }, "description": "List Of Result - [Optional]", "nullable": true } } }, "SetCardPinResponse": { "required": [ "success", "errorCode" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Success - [Optional]" }, "errorCode": { "type": "integer", "description": "Error Code - [Optional]", "format": "int32" }, "errorText": { "type": "string", "description": "Error Text - [Optional]", "nullable": true }, "encryptedPin": { "type": "string", "description": "encrypted Pin - [Optional]", "nullable": true } } }, "SetCardPinViaSMSRequest": { "type": "object", "properties": { "channel": { "type": "string", "description": "Channel - [Optional]", "nullable": true }, "mobilePhoneNumber": { "type": "string", "description": "Mobile Phone Number - [Optional]", "nullable": true }, "cardNumberLastFourDigits": { "type": "string", "description": "Card Number Last Four Digits - [Optional]", "nullable": true }, "clearPin": { "type": "string", "description": "Clear Pin - [Optional]", "nullable": true }, "bankKey": { "type": "string", "description": "Bank Key - [Optional]", "nullable": true } } }, "SetCardPinViaSMSResponse": { "required": [ "success", "errorCode", "customerNumber" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Success - [Optional]" }, "errorCode": { "type": "integer", "description": "Error Code - [Optional]", "format": "int32" }, "errorText": { "type": "string", "description": "Error Text - [Optional]", "nullable": true }, "customerNumber": { "type": "integer", "description": "Customer Number - [Optional]", "format": "int64" }, "shadowCardNumber": { "type": "string", "description": "Shadow Card Number - [Optional]", "nullable": true }, "cardRefNumber": { "type": "string", "description": "Card Ref Number - [Optional]", "nullable": true } } }, "SetCreditCardPinRequest": { "type": "object", "properties": { "channel": { "type": "string", "description": "Channel - [Optional]", "nullable": true }, "shadowCardNumber": { "type": "string", "description": "Shadow Card Number - [Optional]", "nullable": true }, "clearPin": { "type": "string", "description": "Clear Pin - [Optional]", "nullable": true } } }, "SetCustomerOperationLimitModel": { "required": [ "actionType", "success" ], "type": "object", "properties": { "actionType": { "enum": [ 0, 1, 2, 3 ], "type": "integer", "description": "Action Type - [Optional]", "format": "int32", "x-enum-names": [ "None", "Insert", "Update", "Delete" ] }, "success": { "type": "boolean", "description": "Success - [Optional]" }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/OperationLimitErrorItem" }, "description": "Errors - [Optional]", "nullable": true }, "operationLimit": { "allOf": [ { "$ref": "#/components/schemas/OperationLimitItem" } ], "description": "Operation Limit - [Optional]", "nullable": true } } }, "SetCustomerOperationLimitRequest": { "required": [ "customerNumber" ], "type": "object", "properties": { "channel": { "type": "string", "description": "Channel - [Optional]", "nullable": true }, "customerNumber": { "type": "integer", "description": "Customer Number - [Optional]", "format": "int64" }, "listOfOperationLimit": { "type": "array", "items": { "$ref": "#/components/schemas/OperationLimitItem" }, "description": "List Of Operation Limit - [Optional]", "nullable": true } } }, "SetCustomerOperationLimitResponse": { "type": "object", "properties": { "listOfResult": { "type": "array", "items": { "$ref": "#/components/schemas/SetCustomerOperationLimitModel" }, "description": "List Of Result - [Optional]", "nullable": true } } }, "SetStatementDocumentIdRequest": { "type": "object", "properties": { "listOfStatementDocument": { "type": "array", "items": { "$ref": "#/components/schemas/StatementDocumentItem" }, "description": "List Of Statement Document - [Optional]", "nullable": true } } }, "SetStatementDocumentOnlyResponse": { "required": [ "totalRowCount", "insertedRowCount", "updatedRowCount", "noActionRowCount" ], "type": "object", "properties": { "totalRowCount": { "type": "integer", "description": "Total Row Count - [Optional]", "format": "int32" }, "insertedRowCount": { "type": "integer", "description": "Inserted Row Count - [Optional]", "format": "int32" }, "updatedRowCount": { "type": "integer", "description": "Updated Row Count - [Optional]", "format": "int32" }, "noActionRowCount": { "type": "integer", "description": "No Action Row Count - [Optional]", "format": "int32" } } }, "StatementDocumentItem": { "required": [ "customerNumber", "statementDate", "documentId" ], "type": "object", "properties": { "maskedCardNumber": { "type": "string", "description": "Masked Card Number - [Optional]", "nullable": true }, "customerNumber": { "type": "integer", "description": "Customer Number - [Optional]", "format": "int64" }, "statementCurrencyCode": { "type": "string", "description": "Statement Currency Code - [Optional]", "nullable": true }, "statementDate": { "type": "string", "description": "Statement Date - [Optional]", "format": "date-time" }, "documentId": { "type": "integer", "description": "Document Id - [Optional]", "format": "int64" } } }, "ThreeDSRequestorAuthenticationInfo": { "type": "object", "properties": { "threeDSReqAuthMethod": { "type": "string", "description": "Three D S Req Authmethod - [Optional]", "nullable": true }, "threeDSReqAuthTimestamp": { "type": "string", "description": "Three D S Req Auth Timestamp - [Optional]", "nullable": true }, "threeDSReqAuthData": { "type": "string", "description": "Three D S Req Auth Data - [Optional]", "nullable": true } } }, "ThreeDSRequestorPriorAuthenticationInfo": { "type": "object", "properties": { "threeDSReqPriorAuthMethod": { "type": "string", "description": "Three D S Req Prior Authmethod - [Optional]", "nullable": true }, "threeDSReqPriorAuthTimestamp": { "type": "string", "description": "Three D S Req Prior Auth Timestamp - [Optional]", "nullable": true }, "threeDSReqPriorAuthData": { "type": "string", "description": "Three D S Req Prior Auth Data - [Optional]", "nullable": true }, "threeDSReqPriorRef": { "type": "string", "description": "Three D S Prior Ref - [Optional]", "nullable": true } } }, "TransactionData": { "type": "object", "properties": { "messageCategory": { "type": "string", "description": "Message Category - [Optional]", "nullable": true }, "threeDSRequestorAuthenticationInfo": { "allOf": [ { "$ref": "#/components/schemas/ThreeDSRequestorAuthenticationInfo" } ], "description": "Three D S Requestor Authentication Info - [Optional]", "nullable": true }, "threeDSRequestorPriorAuthenticationInfo": { "allOf": [ { "$ref": "#/components/schemas/ThreeDSRequestorPriorAuthenticationInfo" } ], "description": "Three D S Requestor Prior Authentication Info - [Optional]", "nullable": true }, "threeDSRequestorAuthenticationInd": { "type": "string", "description": "Three D S Requestor Authentication Ind - [Optional]", "nullable": true }, "threeDSRequestorChallengeInd": { "type": "string", "description": "Three D S Requestor Challenge Ind - [Optional]", "nullable": true }, "purchaseAmount": { "type": "string", "description": "Purchase Amount - [Optional]", "nullable": true }, "purchaseCurrency": { "type": "string", "description": "Purchase Currency - [Optional]", "nullable": true }, "purchaseExponent": { "type": "string", "description": "Purchase Exponent - [Optional]", "nullable": true }, "purchaseInstallData": { "type": "string", "description": "Purchase Install Data - [Optional]", "nullable": true }, "purchaseDate": { "type": "string", "description": "Purchase Date - [Optional]", "nullable": true }, "transType": { "type": "string", "description": "Trans Type - [Optional]", "nullable": true }, "recurringExpiry": { "type": "string", "description": "Recurring Expiry - [Optional]", "nullable": true } } }, "TrnCodeDef": { "required": [ "validFlag", "insertDate" ], "type": "object", "properties": { "validFlag": { "type": "boolean", "description": "Valid Flag - [Optional]" }, "insertDate": { "type": "string", "description": "Insert Date - [Optional]", "format": "date-time" }, "insertUserId": { "type": "string", "description": "Insert User Id - [Optional]", "nullable": true }, "insertTokenId": { "type": "string", "description": "Insert Token Id - [Optional]", "nullable": true }, "updateDate": { "type": "string", "description": "Update Date - [Optional]", "format": "date-time", "nullable": true }, "updateUserId": { "type": "string", "description": "Update User Id - [Optional]", "nullable": true }, "updateTokenId": { "type": "string", "description": "Update Token Id - [Optional]", "nullable": true }, "trnCode": { "type": "string", "description": "Trn Code - [Optional]", "nullable": true }, "trnCodeDescription": { "type": "string", "description": "Trn Code Description - [Optional]", "nullable": true } } }, "TrnCodeMatrix": { "required": [ "insertDate", "validFlag", "financialTrnFlag", "adjustmentTrnFlag", "reversalFlag", "refundFlag", "voidFlag", "adviceFlag", "offlineFlag", "recurringFlag", "autoBsmvFlag", "autoKkdfFlag", "cutOffCardPostingFlag", "acqRiskyTrnFlag", "cashFeeChargeFlag", "prepaidFlag", "discountFlag", "inflationFlag", "deferringFlag", "taxIncludeFlag" ], "type": "object", "properties": { "insertDate": { "type": "string", "description": "Insert Date - [Optional]", "format": "date-time" }, "insertUserId": { "type": "string", "description": "Insert User Id - [Optional]", "nullable": true }, "insertTokenId": { "type": "string", "description": "Insert Token Id - [Optional]", "nullable": true }, "updateDate": { "type": "string", "description": "Update Date - [Optional]", "format": "date-time", "nullable": true }, "updateUserId": { "type": "string", "description": "Update User Id - [Optional]", "nullable": true }, "updateTokenId": { "type": "string", "description": "Update Token Id - [Optional]", "nullable": true }, "validFlag": { "type": "boolean", "description": "Valid Flag - [Optional]" }, "trnCodeMatrixId": { "type": "string", "description": "Trn Code Matrix Id - [Optional]", "nullable": true }, "trnCode": { "type": "string", "description": "Trn Code - [Optional]", "nullable": true }, "trnCodeDetail": { "type": "string", "description": "Trn Code Detail - [Optional]", "nullable": true }, "trnCodeSpecial": { "type": "string", "description": "Trn Code Special - [Optional]", "nullable": true }, "trnInstallmentType": { "type": "string", "description": "Trn Installment Type - [Optional]", "nullable": true }, "trnDescription": { "type": "string", "description": "Trn Description - [Optional]", "nullable": true }, "onlineMessageType": { "type": "string", "description": "Online Message Type - [Optional]", "nullable": true }, "trnEffect": { "type": "string", "description": "Trn Effect - [Optional]", "nullable": true }, "trnEffectType": { "type": "string", "description": "Trn Effect Type - [Optional]", "nullable": true }, "financialTrnFlag": { "type": "boolean", "description": "Financial Trn Flag - [Optional]" }, "adjustmentTrnFlag": { "type": "boolean", "description": "Adjustment Trn Flag - [Optional]" }, "trnEffectedLimit": { "type": "string", "description": "Trn Effected Limit - [Optional]", "nullable": true }, "trnRewardAbility": { "type": "string", "description": "Trn Reward Ability - [Optional]", "nullable": true }, "reversalFlag": { "type": "boolean", "description": "Reversal Flag - [Optional]" }, "refundFlag": { "type": "boolean", "description": "Refund Flag - [Optional]" }, "voidFlag": { "type": "boolean", "description": "Void Flag - [Optional]" }, "adviceFlag": { "type": "boolean", "description": "Advice Flag - [Optional]" }, "offlineFlag": { "type": "boolean", "description": "Offline Flag - [Optional]" }, "recurringFlag": { "type": "boolean", "description": "Recurring Flag - [Optional]" }, "preauthorizationStatus": { "type": "string", "description": "Preauthorization Status - [Optional]", "nullable": true }, "processType": { "type": "string", "description": "Process Type - [Optional]", "nullable": true }, "autoBsmvFlag": { "type": "boolean", "description": "Auto Bsmv Flag - [Optional]" }, "autoKkdfFlag": { "type": "boolean", "description": "Auto Kkdf Flag - [Optional]" }, "rewardEffectedSegment": { "type": "string", "description": "Reward Effected Segment - [Optional]", "nullable": true }, "closingTrnCode": { "type": "string", "description": "Closing Trn Code - [Optional]", "nullable": true }, "closingTrnCodeDetail": { "type": "string", "description": "Closing Trn Code Detail - [Optional]", "nullable": true }, "trnGroupCode": { "type": "string", "description": "Trn Group Code - [Optional]", "nullable": true }, "trnCodeBucketGroupCode": { "type": "string", "description": "Trn Code Bucket Group Code - [Optional]", "nullable": true }, "cutOffCardPostingFlag": { "type": "boolean", "description": "Cut Off Card Posting Flag - [Optional]" }, "addValueDay": { "type": "integer", "description": "Add Value Day - [Optional]", "format": "int32", "nullable": true }, "trnRewardGroupCode": { "type": "string", "description": "Trn Reward Group Code - [Optional]", "nullable": true }, "acqCommissionTrnGroupCode": { "type": "string", "description": "Acq Commission Trn Group Code - [Optional]", "nullable": true }, "acqLoyaltyTrnGroupCode": { "type": "string", "description": "Acq Loyalty Trn Group Code - [Optional]", "nullable": true }, "acqAccTrnGroupCode": { "type": "string", "description": "Acq Acc Trn Group Code - [Optional]", "nullable": true }, "acqRiskyTrnFlag": { "type": "boolean", "description": "Acq Risky Trn Flag - [Optional]" }, "trnPermGroupCode": { "type": "string", "description": "Trn Perm Group Code - [Optional]", "nullable": true }, "cashFeeChargeFlag": { "type": "boolean", "description": "Cash Fee Charge Flag - [Optional]" }, "prepaidFlag": { "type": "boolean", "description": "Prepaid Flag - [Optional]" }, "discountFlag": { "type": "boolean", "description": "Discount Flag - [Optional]" }, "trnFeeGroupCode": { "type": "string", "description": "Trn Fee Group Code - [Optional]", "nullable": true }, "trnLimitationGroupCode": { "type": "string", "description": "Trn Limitation Group Code - [Optional]", "nullable": true }, "accountingGroupCode": { "type": "string", "description": "Accounting Group Code - [Optional]", "nullable": true }, "closingMatrixId": { "type": "string", "description": "Closing Matrix Id - [Optional]", "nullable": true }, "rewardEffectedSegmentGroup": { "type": "string", "description": "Reward Effected Segment Group - [Optional]", "nullable": true }, "installingMatrixId": { "type": "string", "description": "Installing Matrix Id - [Optional]", "nullable": true }, "inflationFlag": { "type": "boolean", "description": "Inflation Flag - [Optional]" }, "manualClosingMatrixId": { "type": "string", "description": "Manual Closing Matrix Id - [Optional]", "nullable": true }, "deferringFlag": { "type": "boolean", "description": "Deferring Flag - [Optional]" }, "taxIncludeFlag": { "type": "boolean", "description": "Tax Include Flag - [Optional]" } } }, "TrnStatus": { "required": [ "validFlag" ], "type": "object", "properties": { "validFlag": { "type": "boolean", "description": "Valid Flag - [Optional]" }, "trnStatusCode": { "type": "string", "description": "Trn Status Code - [Optional]", "nullable": true }, "trnStatusDescription": { "type": "string", "description": "Trn Status Description - [Optional]", "nullable": true } } }, "UpdateCustomerAddressData": { "required": [ "customerNumber", "recordId", "addressType", "addressText", "isDefault", "isCardAddress" ], "type": "object", "properties": { "updateAllData": { "type": "boolean", "description": "UpdateAllData", "nullable": true }, "customerNumber": { "type": "integer", "description": "Customer Number", "format": "int64" }, "recordId": { "type": "integer", "description": "RecordId", "format": "int64" }, "validFlag": { "type": "boolean", "description": "ValidFlag", "nullable": true }, "addressType": { "type": "string", "description": "Address Type" }, "addressText": { "type": "string", "description": "Full Address Text" }, "isDefault": { "type": "boolean", "description": "Default Address Indicator, true=Default, false=Not" }, "isCardAddress": { "type": "boolean", "description": "Card Address Indicator, true=Card Address, false=Not" }, "isConfirmed": { "type": "boolean", "description": "ApprovedCard Address Indicator, true=Approved Address, false=Not", "nullable": true }, "addressId": { "type": "integer", "description": "External System Relational Identifier, Correlation Identifier", "format": "int64", "nullable": true }, "countryId": { "type": "integer", "description": "Country Id, see Country_Def table", "format": "int32", "nullable": true }, "industrialZoneId": { "type": "integer", "description": "Industrial Zone Identifier", "format": "int32", "nullable": true }, "industrialZoneName": { "type": "string", "description": "Industrial Zone Name", "nullable": true }, "cityId": { "type": "integer", "description": "City Identifier, see City_Def table", "format": "int32", "nullable": true }, "cityName": { "type": "string", "description": "City Name, see City_Def table", "nullable": true }, "countyId": { "type": "integer", "description": "County Identifier, see County_Def table", "format": "int32", "nullable": true }, "countyName": { "type": "string", "description": "County Name, see County_Def table", "nullable": true }, "townId": { "type": "integer", "description": "Town Identifier, see Town_Def table", "format": "int32", "nullable": true }, "townName": { "type": "string", "description": "Town Name, see Town_Def table", "nullable": true }, "villageId": { "type": "integer", "description": "Village Identifier, see Village_Def table", "format": "int32", "nullable": true }, "villageName": { "type": "string", "description": "Village Name, see Village_Def table", "nullable": true }, "districtId": { "type": "integer", "description": "District Identifier, see District_Def table", "format": "int32", "nullable": true }, "districtName": { "type": "string", "description": "District Name, see District_Def table", "nullable": true }, "streetId": { "type": "integer", "description": "Street Identifier, see Street_Def table", "format": "int32", "nullable": true }, "streetName": { "type": "string", "description": "Street Name, see Street_Def table", "nullable": true }, "siteName": { "type": "string", "description": "Address Site Name", "nullable": true }, "buildingId": { "type": "integer", "description": "Building Identifier", "format": "int32", "nullable": true }, "buildingName": { "type": "string", "description": "Building Name", "nullable": true }, "buildingNumber": { "type": "string", "description": "Building Number", "nullable": true }, "buildingEntrance": { "type": "string", "description": "Building Entrance Number", "nullable": true }, "flatNumber": { "type": "integer", "description": "Flat Number", "format": "int32", "nullable": true }, "apartmentNumber": { "type": "string", "description": "Apartment Number", "nullable": true }, "stateId": { "type": "integer", "description": "State Identifier", "format": "int32", "nullable": true }, "stateName": { "type": "string", "description": "State Name", "nullable": true }, "zipCode": { "type": "string", "description": "Zip Code", "nullable": true }, "poBoxNumber": { "type": "string", "description": "Post Box Number", "nullable": true } } }, "UpdateCustomerCommunicationData": { "type": "object", "properties": { "listOfAddress": { "type": "array", "items": { "$ref": "#/components/schemas/UpdateCustomerAddressData" }, "description": "List Of Customer Address Data", "nullable": true }, "listOfGsm": { "type": "array", "items": { "$ref": "#/components/schemas/UpdateCustomerGsmData" }, "description": "List Of Customer Gsm Data", "nullable": true }, "listOfEmail": { "type": "array", "items": { "$ref": "#/components/schemas/UpdateCustomerEmailData" }, "description": "List Of Customer Email Data", "nullable": true }, "listOfPhone": { "type": "array", "items": { "$ref": "#/components/schemas/UpdateCustomerPhoneData" }, "description": "List Of Customer Phone Data", "nullable": true } } }, "UpdateCustomerData": { "required": [ "main", "preferences" ], "type": "object", "properties": { "main": { "allOf": [ { "$ref": "#/components/schemas/UpdateCustomerMainData" } ], "description": "Customer Creation Main Data Model" }, "persona": { "allOf": [ { "$ref": "#/components/schemas/UpdateCustomerPersonalData" } ], "description": "Customer Creation Persona Data Model", "nullable": true }, "corporate": { "allOf": [ { "$ref": "#/components/schemas/UpdateCustomerFirmData" } ], "description": "Customer Creation Corporate Data Model", "nullable": true }, "segment": { "allOf": [ { "$ref": "#/components/schemas/UpdateCustomerSegmentData" } ], "description": "Customer Creation Segment Data Model", "nullable": true }, "preferences": { "allOf": [ { "$ref": "#/components/schemas/UpdateCustomerPreferenceData" } ], "description": "Customer Creation Preferences Data Model" } } }, "UpdateCustomerEmailData": { "required": [ "customerNumber", "recordId" ], "type": "object", "properties": { "updateAllData": { "type": "boolean", "description": "UpdateAllData", "nullable": true }, "customerNumber": { "type": "integer", "description": "Customer Number", "format": "int64" }, "recordId": { "type": "integer", "description": "RecordId", "format": "int64" }, "validFlag": { "type": "boolean", "description": "ValidFlag", "nullable": true }, "eMailAddress": { "type": "string", "description": "Email Address", "nullable": true }, "isConfirmed": { "type": "boolean", "description": "Approved Email Address Indicator, true=Approved, false=Not", "nullable": true } } }, "UpdateCustomerFirmData": { "required": [ "firmName", "authorityCustomerNumber" ], "type": "object", "properties": { "firmNumber": { "type": "integer", "description": "Firm Number", "format": "int64", "nullable": true }, "taxNumber": { "type": "string", "description": "Tax Office Number", "nullable": true }, "taxOffice": { "type": "string", "description": "Tax Office", "nullable": true }, "firmName": { "type": "string", "description": "Firm Name" }, "embossFirmName": { "type": "string", "description": "Firm Name On Card", "nullable": true }, "authorityCustomerNumber": { "type": "integer", "description": "Firm Responsable Employee Customer Number", "format": "int64" }, "firmCustomerType": { "type": "string", "description": "Firm Customer Type", "nullable": true }, "tradeRegistrationNumber": { "type": "string", "description": "Trading Registration Number", "nullable": true }, "tradeRegistrationDate": { "type": "string", "description": "Trading Registration Date", "format": "date-time", "nullable": true }, "tradeRegistrationOffice": { "type": "string", "description": "Trading Registration Office", "nullable": true }, "foundationDate": { "type": "string", "description": "Corporate Foundation Date", "format": "date-time", "nullable": true }, "authorityName": { "type": "string", "description": "Corporate Responsable Employee Full Name", "nullable": true }, "authorityGsmNumber": { "type": "string", "description": "Corporate Responsable Employee Mobile Number", "nullable": true }, "authorityMailAddress": { "type": "string", "description": "Corporate Responsable Employee E-Mail Address", "nullable": true } } }, "UpdateCustomerGsmData": { "required": [ "recordId", "gsmCountryId", "gsmAreaCode", "gsmNumber" ], "type": "object", "properties": { "updateAllData": { "type": "boolean", "description": "UpdateAllData", "nullable": true }, "customerNumber": { "type": "integer", "description": "Customer Number", "format": "int64", "nullable": true }, "recordId": { "type": "integer", "description": "RecordId", "format": "int64" }, "validFlag": { "type": "boolean", "description": "ValidFlag", "nullable": true }, "gsmCountryId": { "type": "integer", "description": "Gsm Country Identifier, see Country_Def table", "format": "int32" }, "gsmAreaCode": { "type": "integer", "description": "Gsm Area Code", "format": "int32" }, "gsmNumber": { "type": "string", "description": "Gsm Number" }, "phoneNumberText": { "type": "string", "description": "Full Gsm Number with country code and area code", "nullable": true }, "isConfirmed": { "type": "boolean", "description": "Approved Gsm Indicator, true=Approved Gsm, false=Not", "nullable": true }, "confirmDate": { "type": "string", "description": "Gsm Approve Date", "format": "date-time", "nullable": true }, "isContactNumber": { "type": "boolean", "description": "Contact Gsm Indicator, Primary GSM, true=Contact Gsm, false=Not", "nullable": true } } }, "UpdateCustomerMainData": { "required": [ "customerType" ], "type": "object", "properties": { "customerNumber": { "type": "integer", "description": "Customer Number, if null then Generate New Customer Number", "format": "int64", "nullable": true }, "externalCustomerNumber": { "type": "integer", "description": "External System Relational Identifier, if null then set Customer Number", "format": "int64", "nullable": true }, "customerType": { "type": "string", "description": "Customer Type, 1=Corporate, 2=Retail, 3=Employee, 4=Sole Proprietorship" }, "accountingCustomerType": { "type": "string", "description": "Accounting Customer Type", "nullable": true }, "creditCustomerType": { "type": "string", "description": "Credit Customer Type", "nullable": true }, "branchCode": { "type": "integer", "description": "Customer Branch Code, if null then set Zero", "format": "int32", "nullable": true }, "isLite": { "type": "boolean", "description": "Lite Customer Flag, if null then set Zero", "nullable": true }, "tenantId": { "type": "string", "description": "Lite Customer TenantId", "nullable": true }, "statusCode": { "type": "string", "description": "Customer Status Code", "nullable": true }, "blockedAccountFlag": { "type": "boolean", "description": "Customer Blocked Account Flag", "nullable": true }, "validFlag": { "type": "boolean", "description": "Customer ValidFlag Flag", "nullable": true } } }, "UpdateCustomerPersonalData": { "required": [ "name", "surname", "birthDate" ], "type": "object", "properties": { "name": { "type": "string", "description": "Customer Name" }, "middleName": { "type": "string", "description": "Customer Middle Name", "nullable": true }, "surname": { "type": "string", "description": "Customer Surname" }, "birthDate": { "type": "string", "description": "Customer Date Of Birth", "format": "date-time" }, "birthPlace": { "type": "string", "description": "Customer Place Of Birth", "nullable": true }, "fatherName": { "type": "string", "description": "Customer Father's Name", "nullable": true }, "motherName": { "type": "string", "description": "Customer Mother's Name", "nullable": true }, "maritalStatus": { "type": "string", "description": "Customer Marital Status Code", "nullable": true }, "educationStatus": { "type": "string", "description": "Educational Status Code", "nullable": true }, "nationality": { "type": "string", "description": "Nationality Code, see Nationality_Def Table", "nullable": true }, "identityType": { "type": "string", "description": "Identity Type Code, see Identity_Type_Def table", "nullable": true }, "identityNumber": { "type": "string", "description": "Identity Number", "nullable": true }, "residenceType": { "type": "string", "description": "Residence Type, I=Domestic Residence, D=Abroad Residence", "nullable": true }, "disabledFlag": { "type": "boolean", "description": "Disabled Indicator, true=disabled, false=Not", "nullable": true }, "title": { "type": "string", "description": "Customer Title", "nullable": true }, "gender": { "type": "string", "description": "Gender Type, E=Male, K=Female, X=Unknown", "nullable": true }, "occupation": { "type": "string", "description": "Occupation Type, see Occupation_Def table", "nullable": true }, "workplaceName": { "type": "string", "description": "Customer Workplace Name", "nullable": true }, "businessTitle": { "type": "string", "description": "Customer Business Title", "nullable": true } } }, "UpdateCustomerPhoneData": { "required": [ "customerNumber", "recordId", "phoneType" ], "type": "object", "properties": { "updateAllData": { "type": "boolean", "description": "UpdateAllData", "nullable": true }, "customerNumber": { "type": "integer", "description": "Customer Number", "format": "int64" }, "recordId": { "type": "integer", "description": "RecordId", "format": "int64" }, "validFlag": { "type": "boolean", "description": "ValidFlag", "nullable": true }, "phoneType": { "type": "string", "description": "Phone Type, see Phone_Type_Def table" }, "phoneCountryId": { "type": "integer", "description": "Phone Country Code, see Country_Def", "format": "int32", "nullable": true }, "phoneAreaCode": { "type": "string", "description": "Phone Area Code", "nullable": true }, "phoneNumber": { "type": "string", "description": "Phone Number", "nullable": true }, "phoneNumberText": { "type": "string", "description": "Full Phone Number Text", "nullable": true }, "isContactNumber": { "type": "boolean", "description": "Contact Phone Address Indicator, Primary Phone Address, true=Contact Phone, false=Not", "nullable": true } } }, "UpdateCustomerPreferenceData": { "type": "object", "properties": { "sendWarningLetterFlag": { "type": "boolean", "description": "Warning Letter Indicator, true=Send Warning Letter, false=Not", "nullable": true }, "communicationType": { "type": "string", "description": "Communication Language Preference, TR=Turkish, EN=English, see Comm_Language_Def table", "nullable": true }, "autoLimitIncreaseFlag": { "type": "boolean", "description": "Auto-Limit Increase Indicator, true=Auto-Limit Increase Enabled, false=Not", "nullable": true }, "statementPostingFlag": { "type": "boolean", "description": "Statement Send via Posting Indicator, true=Enabled, false=Not", "nullable": true }, "statementSmsSendFlag": { "type": "boolean", "description": "Statement Send via SMS Indicator, true=Enabled, false=Not", "nullable": true }, "statementEMailSendFlag": { "type": "boolean", "description": "Statement Send via E-Mail Indicator, true=Enabled, false=Not", "nullable": true }, "earnRewardFlag": { "type": "boolean", "description": "Customer Earned Loyalty Reward Indicator, true=Enabled, false=Not", "nullable": true }, "sensitiveDataPermissionFlag": { "type": "boolean", "description": "GDPR Consent Usage Approved Indicator, true=Enabled, false=Not", "nullable": true }, "customLimitationFlag": { "type": "boolean", "description": "Custom Limitation Enable Indicator, true=Enabled, false=Not", "nullable": true } } }, "UpdateCustomerRequest": { "required": [ "channel", "customer" ], "type": "object", "properties": { "channel": { "type": "string", "description": "Creation Transaction On Channel" }, "customer": { "allOf": [ { "$ref": "#/components/schemas/UpdateCustomerData" } ], "description": "Customer Create Data Model" }, "communications": { "allOf": [ { "$ref": "#/components/schemas/UpdateCustomerCommunicationData" } ], "description": "Customer Communication Data Model", "nullable": true } } }, "UpdateCustomerResponse": { "required": [ "customerNumber", "personId" ], "type": "object", "properties": { "customerNumber": { "type": "integer", "description": "Customer Number", "format": "int64" }, "personId": { "type": "integer", "description": "Person Id", "format": "int64" } } }, "UpdateCustomerSegmentData": { "type": "object", "properties": { "behavioralSegmentCode": { "type": "string", "description": "Customer Behavioral Segment Code", "nullable": true }, "valueSegmentCode": { "type": "string", "description": "Customer Value Segment Code", "nullable": true }, "valueSubSegmentCode": { "type": "string", "description": "Customer Value Sub-Segment Code", "nullable": true } } }, "VerifyCardPinResponse": { "required": [ "verified", "lastTryCount", "tryCountExceed" ], "type": "object", "properties": { "verified": { "type": "boolean", "description": "Verified - [Optional]" }, "lastTryCount": { "type": "integer", "description": "last Try Count - [Optional]", "format": "int32" }, "tryCountExceed": { "type": "boolean", "description": "try Count Exceed - [Optional]" }, "errorText": { "type": "string", "description": "Error Text - [Optional]", "nullable": true } } }, "VerifyCreditCardPinRequest": { "type": "object", "properties": { "channel": { "type": "string", "description": "Channel - [Optional]", "nullable": true }, "shadowCardNumber": { "type": "string", "description": "Shadow Card Number - [Optional]", "nullable": true }, "clearPin": { "type": "string", "description": "Clear Pin - [Optional]", "nullable": true } } }, "WorkPhone": { "type": "object", "properties": { "cc": { "type": "string", "description": "Cc - [Optional]", "nullable": true }, "subscriber": { "type": "string", "description": "Subscriber - [Optional]", "nullable": true } } } }, "responses": { "ActionNotFound": { "description": "Action Not Found" }, "BusinessFailure": { "description": "Business Failure", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "TechnicalFailure": { "description": "Technical Failure" } } }, "tags": [ { "name": "Card issuance and personalisation", "description": "Create individual, corporate and virtual cards, and check which products a customer is eligible to hold before you issue." }, { "name": "Card lifecycle", "description": "Move a card through its states after issuance — status changes, replacement, renewal, blocking and closure." }, { "name": "Customers", "description": "Read the customer behind the cards — portfolio summary, corporate relationships and total assets." }, { "name": "Account linking", "description": "Attach and detach the accounts a card draws on, and read back what a card is currently linked to." }, { "name": "Transactions", "description": "Read what happened on a card and correct it — transaction history, pending provisions, reversals and slip receipts." }, { "name": "Card and customer limits", "description": "Raise, lower and reverse the spending limit on a card or on the customer behind it. Every change returns a log id you can reverse with." }, { "name": "Operation limits", "description": "Cap what a card may do per transaction, per day, per week and per month, by channel and operation type." }, { "name": "Permissions and restrictions", "description": "Turn individual capabilities on and off for a card — e-commerce, international use, mail order and other miscellaneous options." }, { "name": "Collections and legal follow-up", "description": "Follow up arrears — delinquency state, collection detail and the legal process behind an unpaid balance." }, { "name": "Debt payment", "description": "Take a payment against card debt, check a card is eligible to be paid down, and cancel a payment that should not have run." }, { "name": "Statements and billing", "description": "Produce the statement a cardholder reads, and manage the period, delivery preference and address behind it." }, { "name": "PIN and card security", "description": "Set and change a PIN, manage the try counter, and generate or verify the card verification values." }, { "name": "Disputes and chargebacks", "description": "Open a dispute against a transaction, attach the evidence, and cancel a case that should not have been raised." }, { "name": "Campaigns and rewards", "description": "Read the reward and campaign periods a customer's cards qualify for." }, { "name": "Platform operations", "description": "Health checks and cache refresh. Called by your monitoring, not by a cardholder journey." }, { "name": "Reference data", "description": "Look up the reference data a card programme is configured against — products, codes and parameters." } ], "x-tagGroups": [ { "name": "Cards", "tags": [ "Card issuance and personalisation", "Card lifecycle" ] }, { "name": "Customers and accounts", "tags": [ "Customers", "Account linking" ] }, { "name": "Transactions", "tags": [ "Transactions" ] }, { "name": "Limits and controls", "tags": [ "Card and customer limits", "Operation limits", "Permissions and restrictions" ] }, { "name": "Billing and statements", "tags": [ "Collections and legal follow-up", "Debt payment", "Statements and billing" ] }, { "name": "Security", "tags": [ "PIN and card security" ] }, { "name": "Disputes", "tags": [ "Disputes and chargebacks" ] }, { "name": "Rewards", "tags": [ "Campaigns and rewards" ] }, { "name": "Platform", "tags": [ "Platform operations", "Reference data" ] } ] }