{
"openapi": "3.0.4",
"info": {
"title": "Debit Digital Channels Integration",
"description": "Issue debit cards and link them to the accounts they draw on",
"contact": {
"name": "DgPays",
"url": "https://www.dgpays.com"
},
"license": {
"name": "License",
"url": "https://www.dgpays.com"
},
"version": "v8.3.5.36"
},
"servers": [
{
"url": "https://devcard.sim-ant.com/SandBox/IntegrationDigitalChannelDebit",
"description": "Sandbox — safe to call; nothing settles."
}
],
"paths": {
"/debit/api/getCustomerDebitCardListByTenantId": {
"post": {
"tags": [
"Card lifecycle"
],
"summary": "List tenant debit cards for a customer",
"description": "Returns the list of debit cards for a customer filtered by tenant. Retrieves card data via GetCustomerDebitCardListByTenant, enriches results with account balance information from Core Banking, and determines pending replace status based on renewal flags. Performs request validation and returns GetCustomerDebitCardListByTenantIdResponse containing customer debit card details.",
"operationId": "getCustomerDebitCardListByTenantId",
"requestBody": {
"description": "Get Customer Debit Card List By Tenant Id Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GetCustomerDebitCardListByTenantIdRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GetCustomerDebitCardListByTenantIdResponse"
}
}
}
},
"404": {
"$ref": "#/components/responses/ActionNotFound"
},
"400": {
"$ref": "#/components/responses/BusinessFailure"
},
"500": {
"$ref": "#/components/responses/TechnicalFailure"
}
}
}
},
"/debit/api/getCustomerDebitShadowCardsByTenantId": {
"post": {
"tags": [
"Card lifecycle"
],
"summary": "Service that lists Shadow and Masked card information based on the customer’s Tenant information",
"description": "Returns the list of debit shadow cards for a customer filtered by tenant. Retrieves shadow card information via GetCustomerDebitShadowCardsByTenant and returns card type, masked and shadow card numbers, product details, and card status information after request validation.",
"operationId": "getCustomerDebitShadowCardsByTenantId",
"requestBody": {
"description": "Get Customer Debit Shadow Cards By Tenant Id Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GetCustomerDebitShadowCardsByTenantIdRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GetCustomerDebitShadowCardsByTenantIdResponse"
}
}
}
},
"404": {
"$ref": "#/components/responses/ActionNotFound"
},
"400": {
"$ref": "#/components/responses/BusinessFailure"
},
"500": {
"$ref": "#/components/responses/TechnicalFailure"
}
}
}
},
"/debit/api/getDebitCardTransactionByUtid": {
"post": {
"tags": [
"Transactions"
],
"summary": "Service that lists Bank Card transaction details based on UTID",
"description": "Retrieves a debit card transaction by UTID. Resolves shadow card number and transaction date using UTID, queries debit transactions within a date range around the transaction date, and returns the matching transaction record. Includes an alternative implementation that directly fetches transactions by UTID.",
"operationId": "getDebitCardTransactionByUtid",
"requestBody": {
"description": "Get Debit Card Transaction By Utid Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GetDebitCardTransactionByUtidRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GetDebitTransactionAllResponseItem"
}
}
}
},
"404": {
"$ref": "#/components/responses/ActionNotFound"
},
"400": {
"$ref": "#/components/responses/BusinessFailure"
},
"500": {
"$ref": "#/components/responses/TechnicalFailure"
}
}
}
},
"/debit/api/getDebitCardTransactionByUtidNew": {
"post": {
"tags": [
"Transactions"
],
"summary": "Service that lists Bank Card transaction details based on UTID",
"description": "Retrieves a debit card transaction by UTID using the new transaction flow. Directly queries debit transactions by UTID and returns the matching transaction record.",
"operationId": "getDebitCardTransactionByUtidNew",
"requestBody": {
"description": "Get Debit Card Transaction By Utid Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GetDebitCardTransactionByUtidRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GetDebitTransactionAllResponseItem"
}
}
}
},
"404": {
"$ref": "#/components/responses/ActionNotFound"
},
"400": {
"$ref": "#/components/responses/BusinessFailure"
},
"500": {
"$ref": "#/components/responses/TechnicalFailure"
}
}
}
},
"/debit/api/changeCardStatus": {
"post": {
"tags": [
"Card lifecycle"
],
"summary": "Service that allows updating the status information of a card",
"description": "Changes the status of a debit card using status code, reason, and optional transaction information. Returns whether the card status is active after the change.",
"operationId": "changeCardStatus",
"requestBody": {
"description": "Change Card Status Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ChangeCardStatusRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ChangeCardStatusResponse"
}
}
}
},
"404": {
"$ref": "#/components/responses/ActionNotFound"
},
"400": {
"$ref": "#/components/responses/BusinessFailure"
},
"500": {
"$ref": "#/components/responses/TechnicalFailure"
}
}
}
},
"/debit/api/getApplicableProductsByCustomerNumber": {
"post": {
"tags": [
"Card issuance and personalisation"
],
"summary": "Service that lists the products a customer is eligible for, based on customer number",
"description": "Retrieves the list of card products applicable to a specific customer. Filters by main customer number and optional product group. Returns product details including name, number, brand, short name, digital capability, and tenant ID.",
"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"
}
}
}
},
"/debit/api/getCardList": {
"post": {
"tags": [
"Card lifecycle"
],
"summary": "Service that lists detailed card information",
"description": "Retrieves the list of debit cards based on multiple filters such as ShadowCardNumber, CustomerNumber, MainCustomerNumber, Barcode, AccountNumber, BranchCode, CustomerNameSurname, IdentificationNumber, and CourierStatus. Supports corporate cards, active cards, and digital card flags. Returns a list of DebitCardModel including card details, sensitive data when applicable, account information via ListCardAccountByShadowCardNumber, card status logs, delivery information, and PIN setup status. Uses _dcidRepository.GetSearchByCustomernumberCardnumber for searching, _dbtServiceProxy for account and permission operations, _customerServiceProxy for card and PAN retrieval, and GetSensitiveData for retrieving sensitive card data such as CVV2.",
"operationId": "getCardList",
"requestBody": {
"description": "Get Card List Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GetCardListRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GetCardListResponse"
}
}
}
},
"404": {
"$ref": "#/components/responses/ActionNotFound"
},
"400": {
"$ref": "#/components/responses/BusinessFailure"
},
"500": {
"$ref": "#/components/responses/TechnicalFailure"
}
}
}
},
"/debit/api/getCardListNew": {
"post": {
"tags": [
"Card lifecycle"
],
"summary": "Service that lists detailed card information",
"description": "Retrieves the list of debit cards based on multiple filters such as ShadowCardNumber, CustomerNumber, MainCustomerNumber, Barcode, AccountNumber, BranchCode, CustomerNameSurname, IdentificationNumber, and CourierStatus. Supports corporate cards, active cards, and digital card flags. Returns a list of DebitCardModel including card details, sensitive data when applicable, account information via ListCardAccountByShadowCardNumber, card status logs, delivery information, and PIN setup status. Uses _dcidRepository.GetSearchByCustomernumberCardnumber for searching, _dbtServiceProxy for account and permission operations, _customerServiceProxy for card and PAN retrieval, and GetSensitiveData for retrieving sensitive card data such as CVV2.",
"operationId": "getCardListNew",
"requestBody": {
"description": "Get Card List Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GetCardListRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GetCardListResponse"
}
}
}
},
"404": {
"$ref": "#/components/responses/ActionNotFound"
},
"400": {
"$ref": "#/components/responses/BusinessFailure"
},
"500": {
"$ref": "#/components/responses/TechnicalFailure"
}
}
}
},
"/debit/api/getCorporateCustomerInfoByIndividualCustomer": {
"post": {
"tags": [
"Customers"
],
"summary": "Service that lists corporate cards of a individual customer",
"description": "Retrieves corporate customer information for a given individual customer. Validates the request, fetches customer assets, and filters for corporate supplementary cards (ProductSegmentCode = \"T\"). Returns a GetCorporateCustomerInfoByIndividualCustomerResponse containing MainCustomerNumber, ShadowCardNumber, and MaskedCardNumber for each relevant card.",
"operationId": "getCorporateCustomerInfoByIndividualCustomer",
"requestBody": {
"description": "Get Corporate Customer Info By Individual Customer Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GetCorporateCustomerInfoByIndividualCustomerRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GetCorporateCustomerInfoByIndividualCustomerResponse"
}
}
}
},
"404": {
"$ref": "#/components/responses/ActionNotFound"
},
"400": {
"$ref": "#/components/responses/BusinessFailure"
},
"500": {
"$ref": "#/components/responses/TechnicalFailure"
}
}
}
},
"/debit/api/getCustomerAsset": {
"post": {
"tags": [
"Customers"
],
"summary": "Service that retrieves customer asset information",
"description": "Retrieves all debit card assets for a given customer. Fetches card details, sensitive data, account info, status, and delivery info. Uses _dcidRepository.GetCustomerAssetByCustomernumber for card data, _dbtServiceProxy.ListCardAccountByShadowCardNumber for account info, _coreBankingIntegrationOutdoor.GetAccountInformation for balances, and GetSensitiveData for sensitive card info (CVV2, PAN). Returns a GetCustomerAssetResponse containing a list of DebitCardModel with all relevant information.",
"operationId": "getCustomerAsset",
"requestBody": {
"description": "Get Customer Asset Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GetCustomerAssetRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GetCustomerAssetResponse"
}
}
}
},
"404": {
"$ref": "#/components/responses/ActionNotFound"
},
"400": {
"$ref": "#/components/responses/BusinessFailure"
},
"500": {
"$ref": "#/components/responses/TechnicalFailure"
}
}
}
},
"/debit/api/getCardInfo": {
"post": {
"tags": [
"Card lifecycle"
],
"summary": "Service that retrieves card information",
"description": "Retrieves detailed information for a debit card using either the CardNumber (PAN) or ShadowCardNumber.\r\n Includes card metadata (status, branch, product, owner, expiry, virtual/digital flags, embossing info, sensitive data) \r\n and the list of attached accounts with account balances, usable balances, IBAN, currency, account type/subtype, and error info if fetching fails. \r\n Uses _customerServiceProxy to map PAN to ShadowCardNumber, _dcidRepository for card search, and _coreBankingIntegrationOutdoor for account info.",
"operationId": "getCardInfo",
"requestBody": {
"description": "Get Card Info Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GetCardInfoRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GetCardInfoResponse"
}
}
}
},
"404": {
"$ref": "#/components/responses/ActionNotFound"
},
"400": {
"$ref": "#/components/responses/BusinessFailure"
},
"500": {
"$ref": "#/components/responses/TechnicalFailure"
}
}
}
},
"/debit/api/getCardTypeByBin": {
"post": {
"tags": [
"Reference data"
],
"summary": "Service that retrieves the card type based on the BIN number",
"description": "Determines the card type based on the provided BIN. Checks the cached BIN definitions and maps the CardType to a CardDomainType. Returns a GetCardTypeByBinResponse containing the CardType.",
"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"
}
}
}
},
"/debit/api/getAvailableECommerceLimit": {
"post": {
"tags": [
"Card and customer limits"
],
"summary": "Service that lists available e-commerce limit information",
"description": "Retrieves the available e-commerce limits for a specific debit card. Requires ShadowCardNumber and optional Date as input. Returns current available amount, transaction count, monthly usage, and network/channel details.",
"operationId": "getAvailableECommerceLimit",
"requestBody": {
"description": "Get Available E Commerce Limit Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GetAvailableECommerceLimitRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GetAvailableECommerceLimitResponse"
}
}
}
},
"404": {
"$ref": "#/components/responses/ActionNotFound"
},
"400": {
"$ref": "#/components/responses/BusinessFailure"
},
"500": {
"$ref": "#/components/responses/TechnicalFailure"
}
}
}
},
"/debit/api/replaceCard": {
"post": {
"tags": [
"Card lifecycle"
],
"summary": "Card renewal service",
"description": "Replaces an existing card with a new one. Accepts details such as card emboss reason, product number, delivery information, and optional permissions. Returns the new card information, including masked number, shadow card number, and any warnings.",
"operationId": "replaceCard",
"requestBody": {
"description": "Replace Card Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ReplaceCardRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ReplaceCardResponse"
}
}
}
},
"404": {
"$ref": "#/components/responses/ActionNotFound"
},
"400": {
"$ref": "#/components/responses/BusinessFailure"
},
"500": {
"$ref": "#/components/responses/TechnicalFailure"
}
}
}
},
"/debit/api/changeAndReplaceCard": {
"post": {
"tags": [
"Card lifecycle"
],
"summary": "Service that updates a card to a renewable status and performs card renewal",
"description": "Changes the status of a debit card and optionally replaces it with a new card, handling embossing, delivery, and permissions. Returns the updated status and replacement card details.",
"operationId": "changeAndReplaceCard",
"requestBody": {
"description": "Change And Replace Card Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ChangeAndReplaceCardRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ChangeAndReplaceCardResponse"
}
}
}
},
"404": {
"$ref": "#/components/responses/ActionNotFound"
},
"400": {
"$ref": "#/components/responses/BusinessFailure"
},
"500": {
"$ref": "#/components/responses/TechnicalFailure"
}
}
}
},
"/debit/api/createIndividualCard": {
"post": {
"tags": [
"Card issuance and personalisation"
],
"summary": "Service for creating a Individual Bank Card",
"description": "Creates an individual debit card for a customer, handling product selection, accounts, permissions, digital card flags, addresses, and miscellaneous options. Returns card references, masked and shadow card numbers, warnings, application ID if created asynchronously, and attached account list.\n\n**Part of:**\n\n- Journey 01 · Launching a new card product — step 2, Issue against accounts",
"operationId": "createIndividualCard",
"requestBody": {
"description": "Create Individual Card Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateIndividualCardRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateIndividualResponse"
}
}
}
},
"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": "debit",
"step": 2,
"title": "Issue against accounts"
}
]
}
},
"/debit/api/createIndividualSupplementaryCard": {
"post": {
"tags": [
"Card issuance and personalisation"
],
"description": "Create Individual Supplementary Card",
"operationId": "createIndividualSupplementaryCard",
"requestBody": {
"description": "Create Individual Supplementary Card Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateIndividualSupplementaryCardRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateIndividualSupplementaryCardResponse"
}
}
}
},
"404": {
"$ref": "#/components/responses/ActionNotFound"
},
"400": {
"$ref": "#/components/responses/BusinessFailure"
},
"500": {
"$ref": "#/components/responses/TechnicalFailure"
}
}
}
},
"/debit/api/createCorporateCard": {
"post": {
"tags": [
"Card issuance and personalisation"
],
"summary": "Service for creating a Corporate Bank Card",
"description": "Creates a corporate debit card for a customer, handling product selection, accounts, delivery options, permissions, and digital card flags. Returns card references, masked and shadow card numbers, warnings, and application ID if created asynchronously.",
"operationId": "createCorporateCard",
"requestBody": {
"description": "Create Corporate Card Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateCorporateCardRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateCorporateCardResponse"
}
}
}
},
"404": {
"$ref": "#/components/responses/ActionNotFound"
},
"400": {
"$ref": "#/components/responses/BusinessFailure"
},
"500": {
"$ref": "#/components/responses/TechnicalFailure"
}
}
}
},
"/debit/api/createDummyCorporateCard": {
"post": {
"tags": [
"Card issuance and personalisation"
],
"description": "Create Dummy Corporate Card",
"operationId": "createDummyCorporateCard",
"requestBody": {
"description": "Create Dummy Corporate Card Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateDummyCorporateCardRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateDummyCorporateCardResponse"
}
}
}
},
"404": {
"$ref": "#/components/responses/ActionNotFound"
},
"400": {
"$ref": "#/components/responses/BusinessFailure"
},
"500": {
"$ref": "#/components/responses/TechnicalFailure"
}
}
}
},
"/debit/api/createVirtualCard": {
"post": {
"tags": [
"Card issuance and personalisation"
],
"summary": "Service for creating a Virtual Card",
"description": "Creates a virtual debit card linked to an existing shadow card, handling accounts and Masterpass enrollment. Returns card references, masked and shadow card numbers, attached accounts, warnings, and sensitive card data including PAN, CVV, and expiry date.",
"operationId": "createVirtualCard",
"requestBody": {
"description": "Create Virtual Card Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateVirtualCardRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateVirtualCardResponse"
}
}
}
},
"404": {
"$ref": "#/components/responses/ActionNotFound"
},
"400": {
"$ref": "#/components/responses/BusinessFailure"
},
"500": {
"$ref": "#/components/responses/TechnicalFailure"
}
}
}
},
"/debit/api/setCardPin": {
"post": {
"tags": [
"PIN and card security"
],
"summary": "Service that generates a card PIN",
"description": "Sets or updates the PIN for a specific debit card. Accepts card reference number, channel, and new PIN details, and applies the changes to the card securely.",
"operationId": "setCardPin",
"requestBody": {
"description": "Set Card Pin Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SetCardPinRequest"
}
}
},
"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"
}
}
}
},
"/debit/api/changeCardPin": {
"post": {
"tags": [
"PIN and card security"
],
"summary": "Service that enables changing the card’s PIN",
"description": "Changes the PIN of a debit card using the current PIN and returns the status including encrypted PIN, success, and verification flags.",
"operationId": "changeCardPin",
"requestBody": {
"description": "Change Card Pin Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ChangeCardPinRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ChangeCardPinResponse"
}
}
}
},
"404": {
"$ref": "#/components/responses/ActionNotFound"
},
"400": {
"$ref": "#/components/responses/BusinessFailure"
},
"500": {
"$ref": "#/components/responses/TechnicalFailure"
}
}
}
},
"/debit/api/verifyCardPin": {
"post": {
"tags": [
"PIN and card security"
],
"summary": "Service that validates the accuracy of the card PIN",
"description": "Verifies the PIN of a card. Used to confirm cardholder authorization in debit channels.",
"operationId": "verifyCardPin",
"requestBody": {
"description": "Verify Card Pin Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VerifyCardPinRequest"
}
}
},
"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"
}
}
}
},
"/debit/api/verifyRsaPin": {
"post": {
"tags": [
"PIN and card security"
],
"summary": "Service that validates the card PIN using an encrypted PIN block",
"description": "Verifies the RSA PIN for a card. Ensures secure cardholder authorization using RSA PIN.",
"operationId": "verifyRsaPin",
"requestBody": {
"description": "Verify Secure Pin Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VerifySecurePinRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VerifySecurePinResponse"
}
}
}
},
"404": {
"$ref": "#/components/responses/ActionNotFound"
},
"400": {
"$ref": "#/components/responses/BusinessFailure"
},
"500": {
"$ref": "#/components/responses/TechnicalFailure"
}
}
}
},
"/debit/api/setRsaPin": {
"post": {
"tags": [
"PIN and card security"
],
"summary": "Service that generates the card PIN using an encrypted PIN block",
"description": "Sets the RSA PIN for a card. Used for secure PIN management in debit channels.",
"operationId": "setRsaPin",
"requestBody": {
"description": "Set Secure Pin Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SetSecurePinRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SetSecurePinResponse"
}
}
}
},
"404": {
"$ref": "#/components/responses/ActionNotFound"
},
"400": {
"$ref": "#/components/responses/BusinessFailure"
},
"500": {
"$ref": "#/components/responses/TechnicalFailure"
}
}
}
},
"/debit/api/changeRsaPin": {
"post": {
"tags": [
"PIN and card security"
],
"summary": "Service that changes the card’s PIN using an encrypted PIN block",
"description": "Changes the RSA PIN of a debit card using current and new encrypted PIN blocks. Returns encrypted PIN, success status, and response details.",
"operationId": "changeRsaPin",
"requestBody": {
"description": "Change Secure Pin Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ChangeSecurePinRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ChangeSecurePinResponse"
}
}
}
},
"404": {
"$ref": "#/components/responses/ActionNotFound"
},
"400": {
"$ref": "#/components/responses/BusinessFailure"
},
"500": {
"$ref": "#/components/responses/TechnicalFailure"
}
}
}
},
"/debit/api/increasePinTryCount": {
"post": {
"tags": [
"PIN and card security"
],
"summary": "Service that increases the PIN retry counter",
"description": "Increases the PIN try count for a given debit card. Accepts a ShadowCardNumber, Channel, and IncreaseCount to increment the attempt counter via the debit PIN service proxy.",
"operationId": "increasePinTryCount",
"requestBody": {
"description": "Increase Pin Try Count Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IncreasePinTryCountRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success"
},
"404": {
"$ref": "#/components/responses/ActionNotFound"
},
"400": {
"$ref": "#/components/responses/BusinessFailure"
},
"500": {
"$ref": "#/components/responses/TechnicalFailure"
}
}
}
},
"/debit/api/verifyRsaPinWithStaticSalt": {
"post": {
"tags": [
"PIN and card security"
],
"summary": "Service that validates the card PIN using an encrypted PIN block",
"description": "Verifies the RSA PIN with a static salt. Provides additional security for cardholder authentication using salted RSA PIN.",
"operationId": "verifyRsaPinWithStaticSalt",
"requestBody": {
"description": "Verify Rsa Pin With Static Salt Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VerifyRsaPinWithStaticSaltRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VerifyRsaPinWithStaticSaltResponse"
}
}
}
},
"404": {
"$ref": "#/components/responses/ActionNotFound"
},
"400": {
"$ref": "#/components/responses/BusinessFailure"
},
"500": {
"$ref": "#/components/responses/TechnicalFailure"
}
}
}
},
"/debit/api/verifyCVV": {
"post": {
"tags": [
"PIN and card security"
],
"summary": "CVV validation service",
"description": "Verifies the CVV of a card. Used for cardholder validation during transactions.",
"operationId": "verifyCVV",
"requestBody": {
"description": "Verify C V V Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VerifyCVVRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VerifyCVVResponse"
}
}
}
},
"404": {
"$ref": "#/components/responses/ActionNotFound"
},
"400": {
"$ref": "#/components/responses/BusinessFailure"
},
"500": {
"$ref": "#/components/responses/TechnicalFailure"
}
}
}
},
"/debit/api/verifyCVVPartial": {
"post": {
"tags": [
"PIN and card security"
],
"summary": "CVV validation service",
"description": "Partially verifies the CVV of a card. Used when partial CVV verification is required for transaction purposes.",
"operationId": "verifyCVVPartial",
"requestBody": {
"description": "Verify C V V Partial Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VerifyCVVPartialRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VerifyCVVPartialResponse"
}
}
}
},
"404": {
"$ref": "#/components/responses/ActionNotFound"
},
"400": {
"$ref": "#/components/responses/BusinessFailure"
},
"500": {
"$ref": "#/components/responses/TechnicalFailure"
}
}
}
},
"/debit/api/generateCVV": {
"post": {
"tags": [
"PIN and card security"
],
"summary": "CVV generation service",
"description": "Generates the CVV (Card Verification Value) for a given shadow card. Returns the verification value along with any error information. Uses the underlying debit PIN service.",
"operationId": "generateCVV",
"requestBody": {
"description": "Generate C V V Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GenerateCVVRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GenerateCVVResponse"
}
}
}
},
"404": {
"$ref": "#/components/responses/ActionNotFound"
},
"400": {
"$ref": "#/components/responses/BusinessFailure"
},
"500": {
"$ref": "#/components/responses/TechnicalFailure"
}
}
}
},
"/debit/api/attachCardAccount": {
"post": {
"tags": [
"Account linking"
],
"summary": "Service that links an account to a card",
"description": "Attaches a debit card to an account using details like IBAN, account number, branch, suffix, type, and alias. Returns the record ID of the attachment.\n\n**Part of:**\n\n- Journey 01 · Launching a new card product — step 3, Link more accounts",
"operationId": "attachCardAccount",
"requestBody": {
"description": "Attach Card Account Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AttachCardAccountRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AttachCardAccountResponse"
}
}
}
},
"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": "debit",
"step": 3,
"title": "Link more accounts"
}
]
}
},
"/debit/api/detachCardAccount": {
"post": {
"tags": [
"Account linking"
],
"description": "Detach Card Account",
"operationId": "detachCardAccount",
"requestBody": {
"description": "Detach Card Account Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DetachCardAccountRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DetachCardAccountResponse"
}
}
}
},
"404": {
"$ref": "#/components/responses/ActionNotFound"
},
"400": {
"$ref": "#/components/responses/BusinessFailure"
},
"500": {
"$ref": "#/components/responses/TechnicalFailure"
}
}
}
},
"/debit/api/detachCardAccountByAccountNumber": {
"post": {
"tags": [
"Account linking"
],
"description": "Detach Card Account By Account Number",
"operationId": "detachCardAccountByAccountNumber",
"requestBody": {
"description": "Detach Card Account By Account Number Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DetachCardAccountByAccountNumberRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DetachCardAccountByAccountNumberResponse"
}
}
}
},
"404": {
"$ref": "#/components/responses/ActionNotFound"
},
"400": {
"$ref": "#/components/responses/BusinessFailure"
},
"500": {
"$ref": "#/components/responses/TechnicalFailure"
}
}
}
},
"/debit/api/modifyCardAccount": {
"post": {
"tags": [
"Account linking"
],
"summary": "Service that updates the account linked to a card",
"description": "Modifies an existing card account linked to a shadow card. Updates account details including alias, branch, suffix, type, IBAN, FEC code, and order flag. Returns the updated record ID.",
"operationId": "modifyCardAccount",
"requestBody": {
"description": "Modify Card Account Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ModifyCardAccountRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ModifyCardAccountResponse"
}
}
}
},
"404": {
"$ref": "#/components/responses/ActionNotFound"
},
"400": {
"$ref": "#/components/responses/BusinessFailure"
},
"500": {
"$ref": "#/components/responses/TechnicalFailure"
}
}
}
},
"/debit/api/listCardAccountByAccountNumber": {
"post": {
"tags": [
"Account linking"
],
"summary": "Service that lists card account information based on account number",
"description": "Lists all card-linked accounts for a given account number. Returns details including account alias, branch, suffix, type, IBAN, FEC code, insert/update info, validity, and currency code.",
"operationId": "listCardAccountByAccountNumber",
"requestBody": {
"description": "List Card Account By Account Number Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ListCardAccountByAccountNumberRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ListCardAccountByAccountNumberResponse"
}
}
}
},
"404": {
"$ref": "#/components/responses/ActionNotFound"
},
"400": {
"$ref": "#/components/responses/BusinessFailure"
},
"500": {
"$ref": "#/components/responses/TechnicalFailure"
}
}
}
},
"/debit/api/listCardAccountByShadowCardNumber": {
"post": {
"tags": [
"Account linking"
],
"summary": "Service that lists card account information based on Shadow Card Number",
"description": "Lists all accounts linked to a specific shadow card number. Returns account details including alias, branch, suffix, type, IBAN, FEC code, insert/update info, validity, and currency code.",
"operationId": "listCardAccountByShadowCardNumber",
"requestBody": {
"description": "List Card Account By Shadow Card Number Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ListCardAccountByShadowCardNumberRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ListCardAccountByShadowCardNumberResponse"
}
}
}
},
"404": {
"$ref": "#/components/responses/ActionNotFound"
},
"400": {
"$ref": "#/components/responses/BusinessFailure"
},
"500": {
"$ref": "#/components/responses/TechnicalFailure"
}
}
}
},
"/debit/api/recreateCustomerCardAccounts": {
"post": {
"tags": [
"Account linking"
],
"summary": "Service that updates the account linked to a card",
"description": "Recreates all card accounts for a customer linked to a shadow card. Accepts a list of card accounts and replaces the existing ones, ensuring all accounts are valid. Used for batch updates or correcting account assignments.",
"operationId": "recreateCustomerCardAccounts",
"requestBody": {
"description": "Recreate Customer Card Accounts Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RecreateCustomerCardAccountsRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success"
},
"404": {
"$ref": "#/components/responses/ActionNotFound"
},
"400": {
"$ref": "#/components/responses/BusinessFailure"
},
"500": {
"$ref": "#/components/responses/TechnicalFailure"
}
}
}
},
"/debit/api/saveCardAccountCurrencyConversion": {
"post": {
"tags": [
"Account linking"
],
"description": "Save Card Account Currency Conversion",
"operationId": "saveCardAccountCurrencyConversion",
"requestBody": {
"description": "Save Card Account Currency Conversion Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SaveCardAccountCurrencyConversionRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SaveCardAccountCurrencyConversionResponse"
}
}
}
},
"404": {
"$ref": "#/components/responses/ActionNotFound"
},
"400": {
"$ref": "#/components/responses/BusinessFailure"
},
"500": {
"$ref": "#/components/responses/TechnicalFailure"
}
}
}
},
"/debit/api/getCardAccountCurrencyConversion": {
"post": {
"tags": [
"Account linking"
],
"description": "Get Card Account Currency Conversion",
"operationId": "getCardAccountCurrencyConversion",
"requestBody": {
"description": "Get Card Account Currency Conversion Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GetCardAccountCurrencyConversionRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GetCardAccountCurrencyConversionResponse"
}
}
}
},
"404": {
"$ref": "#/components/responses/ActionNotFound"
},
"400": {
"$ref": "#/components/responses/BusinessFailure"
},
"500": {
"$ref": "#/components/responses/TechnicalFailure"
}
}
}
},
"/debit/api/getCardPinOperationHistory": {
"post": {
"tags": [
"PIN and card security"
],
"summary": "Service that lists the card PIN transaction history",
"description": "Retrieves the PIN operation history for a debit card based on ShadowCardNumber. Returns a list of GetCardPinOperationHistory items including ChannelType, InsertDate, OperationResult, OperationResultDescription, OperationType, and OperationTypeDescription. Uses _dcidRepository.GetCardPinOperationHistory to fetch the data.",
"operationId": "getCardPinOperationHistory",
"requestBody": {
"description": "Get Card Pin Operation History Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GetCardPinOperationHistoryRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GetCardPinOperationHistoryResponse"
}
}
}
},
"404": {
"$ref": "#/components/responses/ActionNotFound"
},
"400": {
"$ref": "#/components/responses/BusinessFailure"
},
"500": {
"$ref": "#/components/responses/TechnicalFailure"
}
}
}
},
"/debit/api/getCardPermissions": {
"post": {
"tags": [
"Permissions and restrictions"
],
"summary": "Service that lists restrictions defined on a card",
"description": "Retrieves the permissions set on a debit card based on ShadowCardNumber. Returns a list of DebitCardPermissions including restriction codes, descriptions, permission indicators, channel, and security flags. Uses _dbtServiceProxy.GetCardPermissions for fetching data.",
"operationId": "getCardPermissions",
"requestBody": {
"description": "Get Card Permissions Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GetCardPermissionsRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GetCardPermissionsResponse"
}
}
}
},
"404": {
"$ref": "#/components/responses/ActionNotFound"
},
"400": {
"$ref": "#/components/responses/BusinessFailure"
},
"500": {
"$ref": "#/components/responses/TechnicalFailure"
}
}
}
},
"/debit/api/saveCardPermissions": {
"post": {
"tags": [
"Permissions and restrictions"
],
"summary": "Service that adds or removes restrictions on a card",
"description": "Saves or updates card permissions for a specific card. Accepts card reference number, shadow card number, channel, and a list of permission items with start/end dates and restriction codes. Returns the count of changed permissions and their record IDs.",
"operationId": "saveCardPermissions",
"requestBody": {
"description": "Save Card Permissions Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SaveCardPermissionsRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SaveCardPermissionsResponse"
}
}
}
},
"404": {
"$ref": "#/components/responses/ActionNotFound"
},
"400": {
"$ref": "#/components/responses/BusinessFailure"
},
"500": {
"$ref": "#/components/responses/TechnicalFailure"
}
}
}
},
"/debit/api/saveCardBnplPermission": {
"post": {
"tags": [
"Permissions and restrictions"
],
"description": "Saves or updates Buy Now Pay Later (BNPL) permissions for a card. Accepts card reference number, channel, and BNPL permission details to enable or disable BNPL features on the card.",
"operationId": "saveCardBnplPermission",
"requestBody": {
"description": "Save Card Bnpl Permission Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SaveCardBnplPermissionRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SaveCardBnplPermissionResponse"
}
}
}
},
"404": {
"$ref": "#/components/responses/ActionNotFound"
},
"400": {
"$ref": "#/components/responses/BusinessFailure"
},
"500": {
"$ref": "#/components/responses/TechnicalFailure"
}
}
}
},
"/debit/api/resetCvvCounter": {
"post": {
"tags": [
"PIN and card security"
],
"summary": "Service that resets the CVV retry counter on a card",
"description": "Resets the CVV attempt counter for a given shadow card. Accepts the channel and shadow card number as input. Used to allow further CVV attempts after limits are reached.",
"operationId": "resetCvvCounter",
"requestBody": {
"description": "Reset Cvv Counter Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ResetCvvCounterRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success"
},
"404": {
"$ref": "#/components/responses/ActionNotFound"
},
"400": {
"$ref": "#/components/responses/BusinessFailure"
},
"500": {
"$ref": "#/components/responses/TechnicalFailure"
}
}
}
},
"/debit/api/changeCardBranch": {
"post": {
"tags": [
"Branch management"
],
"summary": "Service that changes the branch associated with a card",
"description": "Changes the branch of a debit card or customer accounts, including transferring multiple customers between branches. Returns old and new branch information and affected card counts.",
"operationId": "changeCardBranch",
"requestBody": {
"description": "Change Card Branch Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ChangeCardBranchRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ChangeCardBranchResponse"
}
}
}
},
"404": {
"$ref": "#/components/responses/ActionNotFound"
},
"400": {
"$ref": "#/components/responses/BusinessFailure"
},
"500": {
"$ref": "#/components/responses/TechnicalFailure"
}
}
}
},
"/debit/api/changeCustomerBranch": {
"post": {
"tags": [
"Branch management"
],
"summary": "Service that changes the customer’s associated branch",
"description": "Changes the branch for a customer and updates all associated cards. Returns the number of changed cards, list of shadow card numbers, old branch, and new branch.",
"operationId": "changeCustomerBranch",
"requestBody": {
"description": "Change Customer Branch Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ChangeCustomerBranchRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ChangeCustomerBranchResponse"
}
}
}
},
"404": {
"$ref": "#/components/responses/ActionNotFound"
},
"400": {
"$ref": "#/components/responses/BusinessFailure"
},
"500": {
"$ref": "#/components/responses/TechnicalFailure"
}
}
}
},
"/debit/api/transferBranchCustomer": {
"post": {
"tags": [
"Branch management"
],
"summary": "Service that changes the customer’s associated branch",
"description": "Transfers a customer to a different branch. Updates the branch assignment for a customer in the debit channel system.",
"operationId": "transferBranchCustomer",
"requestBody": {
"description": "Transfer Branch Customer",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TransferBranchCustomer"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TransferBranchCustomerResponse"
}
}
}
},
"404": {
"$ref": "#/components/responses/ActionNotFound"
},
"400": {
"$ref": "#/components/responses/BusinessFailure"
},
"500": {
"$ref": "#/components/responses/TechnicalFailure"
}
}
}
},
"/debit/api/getPendingCardEmbossList": {
"post": {
"tags": [
"Card issuance and personalisation"
],
"summary": "Service that lists cards currently in the printing process",
"description": "Retrieves pending embossing information for a debit card using its shadow card number. Returns details including card sequence, emboss and application dates, reason codes and descriptions, emboss status, product type, masked card number, shadow card number, and validity 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"
}
}
}
},
"/debit/api/cancelCardEmbossByShadowCardNumber": {
"post": {
"tags": [
"Card issuance and personalisation"
],
"summary": "Service that cancels card issuance based on the Shadow Card Number",
"description": "Cancels the embossing of a debit card using the shadow card number and channel. Logs the operation and validates the request before processing.",
"operationId": "cancelCardEmbossByShadowCardNumber",
"requestBody": {
"description": "Cancel Card Emboss By Shadow Card Number Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CancelCardEmbossByShadowCardNumberRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success"
},
"404": {
"$ref": "#/components/responses/ActionNotFound"
},
"400": {
"$ref": "#/components/responses/BusinessFailure"
},
"500": {
"$ref": "#/components/responses/TechnicalFailure"
}
}
}
},
"/debit/api/getCardLimitationParameterData": {
"post": {
"tags": [
"Operation limits"
],
"summary": "Service that lists parameter-based limit values defined on a card",
"description": "Retrieves the card limitation parameters for a debit card identified by ShadowCardNumber. Returns a list of CardLimitParameterData including daily, weekly, monthly, yearly transaction amounts and counts, per transaction amount limits, ratios, No-CVM consecutive transaction limits, profile code/description, and channel/network/event keys. Data is fetched from _dbtServiceProxy.GetCardLimitationParameterData.",
"operationId": "getCardLimitationParameterData",
"requestBody": {
"description": "Get Card Limitation Parameter Data Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GetCardLimitationParameterDataRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GetCardLimitationParameterDataResponse"
}
}
}
},
"404": {
"$ref": "#/components/responses/ActionNotFound"
},
"400": {
"$ref": "#/components/responses/BusinessFailure"
},
"500": {
"$ref": "#/components/responses/TechnicalFailure"
}
}
}
},
"/debit/api/getCardOperationLimit": {
"post": {
"tags": [
"Operation limits"
],
"summary": "Service that lists customized limits or parameter-based limit details defined on a card",
"description": "Retrieves the operation limits for a debit card based on the CardRefNumber and Channel. Returns a list of GetCardOperationLimitResponseItem containing transaction limits by daily, weekly, monthly, and yearly amounts and counts, along with limit profile and event details. Uses _dbtServiceProxy.GetCardOperationLimit to fetch the 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"
}
}
}
},
"/debit/api/setCardOperationLimit": {
"post": {
"tags": [
"Operation limits"
],
"summary": "Service that customizes the transaction limit of a card",
"description": "Sets or updates operation limits for a specific debit card. Accepts card reference number, channel, and a list of operation limit items including daily, weekly, monthly, and yearly limits, per-transaction limits, and profile details. Returns the result of each operation with success status, errors, and updated operation limit data.",
"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"
}
}
}
},
"/debit/api/removeCardOperationLimit": {
"post": {
"tags": [
"Operation limits"
],
"summary": "Service that removes customized limits defined for a card",
"description": "Removes specific operation limits for a card. Accepts a list of operation limit keys and deletes them from the system, returning the result status and any associated errors.",
"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"
}
}
}
},
"/debit/api/getDebitTransactionAll": {
"post": {
"tags": [
"Transactions"
],
"summary": "Service that lists all transactions related to a card",
"description": "Retrieves all debit card transactions for a given ShadowCardNumber and date range. Combines authorization and posted transaction records, merges unmatched authorizations, filters reward transactions, calculates total amount, and returns ordered transaction details including amounts, merchant info, status, rewards, and digital slip data. Also supports UTID-based retrieval via an alternative method.\n\n**Part of:**\n\n- Journey 01 · Launching a new card product — step 4, Activate, PIN, transact",
"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"
}
},
"x-everest-journeys": [
{
"journey": "launch",
"journeyName": "Launching a new card product",
"n": "01",
"section": "debit",
"step": 4,
"title": "Activate, PIN, transact"
}
]
}
},
"/debit/api/isCustomerConvertToRipper": {
"post": {
"tags": [
"Customers"
],
"summary": "Service that returns whether the customer is flagged as risky",
"description": "Checks whether a customer has any cards in the system. Accepts a CustomerNumber and returns flags indicating whether the customer has Credit, Debit, or Prepaid cards.",
"operationId": "isCustomerConvertToRipper",
"requestBody": {
"description": "Is Customer Convert To Ripper Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IsCustomerConvertToRipperRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IsCustomerConvertToRipperResponse"
}
}
}
},
"404": {
"$ref": "#/components/responses/ActionNotFound"
},
"400": {
"$ref": "#/components/responses/BusinessFailure"
},
"500": {
"$ref": "#/components/responses/TechnicalFailure"
}
}
}
},
"/debit/api/isCardFoundIn": {
"post": {
"tags": [
"Card lifecycle"
],
"summary": "Service that checks the existence of a card based on the open card number",
"description": "Checks whether a specific card exists in the system. Accepts a CardNumber and returns a flag (IsFound) along with the ServiceDomainId indicating where the card was found.",
"operationId": "isCardFoundIn",
"requestBody": {
"description": "Is Card Found In Ripper Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IsCardFoundInRipperRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IsCardFoundInRipperResponse"
}
}
}
},
"404": {
"$ref": "#/components/responses/ActionNotFound"
},
"400": {
"$ref": "#/components/responses/BusinessFailure"
},
"500": {
"$ref": "#/components/responses/TechnicalFailure"
}
}
}
},
"/debit/api/createNoNameCardApplication": {
"post": {
"tags": [
"No-name cards"
],
"summary": "Service for creating a No Name card application",
"description": "Creates a no-name debit card application, auto-selecting product and branch if not provided, handling accounts, permissions, and digital card flags. Returns the application ID.",
"operationId": "createNoNameCardApplication",
"requestBody": {
"description": "Create No Name Card Application Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateNoNameCardApplicationRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateNoNameCardApplicationResponse"
}
}
}
},
"404": {
"$ref": "#/components/responses/ActionNotFound"
},
"400": {
"$ref": "#/components/responses/BusinessFailure"
},
"500": {
"$ref": "#/components/responses/TechnicalFailure"
}
}
}
},
"/debit/api/cancelNoNameCardApplication": {
"post": {
"tags": [
"No-name cards"
],
"summary": "Service that cancels a No Name card application",
"description": "Cancels a no-name debit card application using channel, application ID, correlation ID, and reason for cancellation.",
"operationId": "cancelNoNameCardApplication",
"requestBody": {
"description": "Cancel No Name Card Application Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CancelNoNameCardApplicationRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success"
},
"404": {
"$ref": "#/components/responses/ActionNotFound"
},
"400": {
"$ref": "#/components/responses/BusinessFailure"
},
"500": {
"$ref": "#/components/responses/TechnicalFailure"
}
}
}
},
"/debit/api/updateNoNameCardApplication": {
"post": {
"tags": [
"No-name cards"
],
"summary": "Service that updates a No Name card application",
"description": "Updates a no-name card application. Allows modification of pending applications without customer name.",
"operationId": "updateNoNameCardApplication",
"requestBody": {
"description": "Update No Name Card Application Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateNoNameCardApplicationRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success"
},
"404": {
"$ref": "#/components/responses/ActionNotFound"
},
"400": {
"$ref": "#/components/responses/BusinessFailure"
},
"500": {
"$ref": "#/components/responses/TechnicalFailure"
}
}
}
},
"/debit/api/updateTransactionForBNPL": {
"post": {
"tags": [
"Transactions"
],
"description": "Updates installment information for BNPL (Buy Now Pay Later) transactions. Updates corresponding transaction records for Installment Count, Installment Parameter, and Installment Profit Rate to synchronize with core banking system.",
"operationId": "updateTransactionForBNPL",
"requestBody": {
"description": "Update Transaction For B N P L Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateTransactionForBNPLRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateTransactionForBNPLResponse"
}
}
}
},
"404": {
"$ref": "#/components/responses/ActionNotFound"
},
"400": {
"$ref": "#/components/responses/BusinessFailure"
},
"500": {
"$ref": "#/components/responses/TechnicalFailure"
}
}
}
},
"/debit/api/activateNoNameCard": {
"post": {
"tags": [
"No-name cards"
],
"summary": "Service that activates a No Name card",
"description": "Activates a no-name debit card for a customer based on channel, last four digits, and barcode. Returns a shadow card number for tracking.",
"operationId": "activateNoNameCard",
"requestBody": {
"description": "Activate No Name Card Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActivateNoNameCardRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActivateNoNameCardResponse"
}
}
}
},
"404": {
"$ref": "#/components/responses/ActionNotFound"
},
"400": {
"$ref": "#/components/responses/BusinessFailure"
},
"500": {
"$ref": "#/components/responses/TechnicalFailure"
}
}
}
},
"/debit/api/createCardUsingNoNameApplication": {
"post": {
"tags": [
"No-name cards"
],
"summary": "Service that creates a card via No Name Application",
"description": "Creates a debit card based on a no-name card application, handling accounts and permissions. Returns card references, masked and shadow card numbers, warnings, and sensitive card data if available.",
"operationId": "createCardUsingNoNameApplication",
"requestBody": {
"description": "Create Card Using No Name Application Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateCardUsingNoNameApplicationRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateCardUsingNoNameApplicationResponse"
}
}
}
},
"404": {
"$ref": "#/components/responses/ActionNotFound"
},
"400": {
"$ref": "#/components/responses/BusinessFailure"
},
"500": {
"$ref": "#/components/responses/TechnicalFailure"
}
}
}
},
"/debit/api/createAndProcessNoNameCardApplication": {
"post": {
"tags": [
"No-name cards"
],
"summary": "Service that receives a No Name card application and creates the card",
"description": "Creates and processes a no-name debit card application, handling accounts, permissions, and digital card flags. Returns application ID, card references, masked and shadow card numbers, and sensitive card data if applicable.",
"operationId": "createAndProcessNoNameCardApplication",
"requestBody": {
"description": "Create And Process No Name Card Application Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateAndProcessNoNameCardApplicationRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateAndProcessNoNameCardApplicationResponse"
}
}
}
},
"404": {
"$ref": "#/components/responses/ActionNotFound"
},
"400": {
"$ref": "#/components/responses/BusinessFailure"
},
"500": {
"$ref": "#/components/responses/TechnicalFailure"
}
}
}
},
"/debit/api/replaceNoNameCard": {
"post": {
"tags": [
"No-name cards"
],
"summary": "No Name Card renewal service",
"description": "Replaces a no-name card. Determines if the card is digital; if so, calls ReplaceCard, otherwise initiates a ReplaceNoNameCardApplication. Returns application ID, card reference numbers, masked card number, new card generation status, product change status, and shadow card number.",
"operationId": "replaceNoNameCard",
"requestBody": {
"description": "Replace No Name Card Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ReplaceNoNameCardRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ReplaceNoNameCardResponse"
}
}
}
},
"404": {
"$ref": "#/components/responses/ActionNotFound"
},
"400": {
"$ref": "#/components/responses/BusinessFailure"
},
"500": {
"$ref": "#/components/responses/TechnicalFailure"
}
}
}
},
"/debit/api/replaceCardUsingNoNameApplication": {
"post": {
"tags": [
"No-name cards"
],
"summary": "Service that performs card renewal via No Name Application",
"description": "Replaces a card using a no-name application. Accepts channel, application ID, barcode, and customer number. Returns the new card details including card reference numbers, masked card number, shadow card number, record ID, warnings, and sensitive card data if available.",
"operationId": "replaceCardUsingNoNameApplication",
"requestBody": {
"description": "Replace Card Using No Name Application Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ReplaceCardUsingNoNameApplicationRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ReplaceCardUsingNoNameApplicationResponse"
}
}
}
},
"404": {
"$ref": "#/components/responses/ActionNotFound"
},
"400": {
"$ref": "#/components/responses/BusinessFailure"
},
"500": {
"$ref": "#/components/responses/TechnicalFailure"
}
}
}
},
"/debit/api/changeAndReplaceNoNameCard": {
"post": {
"tags": [
"No-name cards"
],
"summary": "Service that updates a No Name card to a renewable status and performs card renewal",
"description": "Changes the status of a no-name debit card and optionally replaces it or its application, handling digital and non-digital card scenarios. Returns updated status, new card details, and application ID if applicable.",
"operationId": "changeAndReplaceNoNameCard",
"requestBody": {
"description": "Change And Replace No Name Card Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ChangeAndReplaceNoNameCardRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ChangeAndReplaceNoNameCardResponse"
}
}
}
},
"404": {
"$ref": "#/components/responses/ActionNotFound"
},
"400": {
"$ref": "#/components/responses/BusinessFailure"
},
"500": {
"$ref": "#/components/responses/TechnicalFailure"
}
}
}
},
"/debit/api/getCustomerOperationLimit": {
"post": {
"tags": [
"Operation limits"
],
"summary": "Service that lists customized or parameter-based limit details defined for the customer",
"description": "Returns customer operation limits for debit cards. Retrieves operation limits via CustomerService, filters by CardType = D and CustomLimitationChangeFlag = true, and returns profile information with per-transaction and period-based limits.",
"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"
}
}
}
},
"/debit/api/setCustomerOperationLimit": {
"post": {
"tags": [
"Operation limits"
],
"summary": "Service that customizes the customer’s transaction limit",
"description": "Sets or updates operation limits for a customer. Accepts customer number, channel, and a list of operation limit definitions, applying them to the customer account.",
"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"
}
}
}
},
"/debit/api/removeCustomerOperationLimit": {
"post": {
"tags": [
"Operation limits"
],
"summary": "Service that removes customizable limits defined for a customer",
"description": "Removes specific operation limits for a customer. Accepts a list of operation limit keys and deletes them from the system, returning the result status and any associated errors.",
"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"
}
}
}
},
"/debit/api/getCustomerLimitationParameterData": {
"post": {
"tags": [
"Operation limits"
],
"summary": "Service that lists parameter-based limit values defined for the customer",
"description": "Returns customer limitation parameter data for debit cards. Retrieves limitation profiles via CustomerService, filters records by CardType = D, and returns profile, transaction limit ratios, period-based limits, and detailed limitation key information.",
"operationId": "getCustomerLimitationParameterData",
"requestBody": {
"description": "Get Customer Limitation Parameters Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GetCustomerLimitationParametersRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GetCustomerLimitationParametersResponse"
}
}
}
},
"404": {
"$ref": "#/components/responses/ActionNotFound"
},
"400": {
"$ref": "#/components/responses/BusinessFailure"
},
"500": {
"$ref": "#/components/responses/TechnicalFailure"
}
}
}
},
"/debit/api/getCardApplicationList": {
"post": {
"tags": [
"Card applications"
],
"summary": "Service that lists card applications",
"description": "Retrieves the list of card applications for a specific customer. Uses CustomerNumber and optional ApplicationId as input. For each application, includes account details (balance, usable balance, currency, branch, IBAN) and error information if fetching account balance fails.",
"operationId": "getCardApplicationList",
"requestBody": {
"description": "Get Card Application List Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GetCardApplicationListRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GetCardApplicationListResponse"
}
}
}
},
"404": {
"$ref": "#/components/responses/ActionNotFound"
},
"400": {
"$ref": "#/components/responses/BusinessFailure"
},
"500": {
"$ref": "#/components/responses/TechnicalFailure"
}
}
}
},
"/debit/api/getCustomerAssetsSummaryDebit": {
"post": {
"tags": [
"Customers"
],
"summary": "Service that lists customer card information",
"description": "Retrieves a summarized list of debit card assets for a customer. Fetches card details, status, and related accounts. Uses _dcidRepository.GetCustomerAssetsSummaryDebit for card info, _dbtServiceProxy.ListCardAccountByShadowCardNumber for accounts, _coreBankingIntegrationOutdoor.GetAccountInformation for balances, and _cache for product and status descriptions. Filters out invalid or expired reissue cards and orders the list according to sort rules. Returns GetCustomerAssetsSummaryDebitResponse containing a list of GetCustomerAssetsSummaryDebitCardModel with card and account info.",
"operationId": "getCustomerAssetsSummaryDebit",
"requestBody": {
"description": "Get Customer Assets Summary Debit Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GetCustomerAssetsSummaryDebitRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GetCustomerAssetsSummaryDebitResponse"
}
}
}
},
"404": {
"$ref": "#/components/responses/ActionNotFound"
},
"400": {
"$ref": "#/components/responses/BusinessFailure"
},
"500": {
"$ref": "#/components/responses/TechnicalFailure"
}
}
}
},
"/debit/api/getDebitCustomerLisfOfBranch": {
"post": {
"tags": [
"Branch management"
],
"summary": "Service that lists customer numbers by branch",
"description": "Retrieves the list of debit customers for a given branch. Uses channel information and branch code to return customer OID list.",
"operationId": "getDebitCustomerLisfOfBranch",
"requestBody": {
"description": "Get Debit Customer Lisf Of Branch Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GetDebitCustomerLisfOfBranchRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GetDebitCustomerListOfBranchResponse"
}
}
}
},
"404": {
"$ref": "#/components/responses/ActionNotFound"
},
"400": {
"$ref": "#/components/responses/BusinessFailure"
},
"500": {
"$ref": "#/components/responses/TechnicalFailure"
}
}
}
},
"/debit/api/changeCardMiscOption": {
"post": {
"tags": [
"Permissions and restrictions"
],
"summary": "Service that updates Digital Slip delivery preferences",
"description": "Changes miscellaneous options of a debit card, supporting individual or all cards for a customer, and returns the list of log record IDs.",
"operationId": "changeCardMiscOption",
"requestBody": {
"description": "Change Card Misc Option Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ChangeCardMiscOptionRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CardMiscOptionResponse"
}
}
}
},
"404": {
"$ref": "#/components/responses/ActionNotFound"
},
"400": {
"$ref": "#/components/responses/BusinessFailure"
},
"500": {
"$ref": "#/components/responses/TechnicalFailure"
}
}
}
},
"/debit/api/getCardMiscOption": {
"post": {
"tags": [
"Permissions and restrictions"
],
"summary": "Service that lists Digital Slip preferences",
"description": "Retrieves miscellaneous options for debit cards based on filters such as OptionType, CustomerNumber, MainCardRefNumber, CardRefNumber, and flags for all main cards or all cards. Returns a list of CardMiscOptionData containing the option type, option value, customer number, main card reference, and card reference. Uses _dbtServiceProxy.GetCardMiscOption for fetching the data.",
"operationId": "getCardMiscOption",
"requestBody": {
"description": "Get Card Misc Option Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GetCardMiscOptionRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GetCardMiscOptionResponse"
}
}
}
},
"404": {
"$ref": "#/components/responses/ActionNotFound"
},
"400": {
"$ref": "#/components/responses/BusinessFailure"
},
"500": {
"$ref": "#/components/responses/TechnicalFailure"
}
}
}
},
"/debit/api/getDigitalSlipReceipt": {
"post": {
"tags": [
"Transactions"
],
"summary": "Service that lists Digital Slip preferences based on a given UTID",
"description": "Retrieves the digital slip (receipt) for a debit card transaction using UTID. Returns transaction details including amounts, currency, card info, authorization, terminal and merchant information, ICC data, and reference UTID if available.",
"operationId": "getDigitalSlipReceipt",
"requestBody": {
"description": "Get Digital Slip Receipt Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GetDigitalSlipReceiptRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GetDigitalSlipReceiptResponse"
}
}
}
},
"404": {
"$ref": "#/components/responses/ActionNotFound"
},
"400": {
"$ref": "#/components/responses/BusinessFailure"
},
"500": {
"$ref": "#/components/responses/TechnicalFailure"
}
}
}
},
"/debit/api/getDebitApplicationIdByFromShadowCardNumber": {
"post": {
"tags": [
"Card applications"
],
"summary": "Service that returns the application information for a card based on its Shadow Card Number",
"description": "Retrieves debit card replacement application information using the source shadow card number. Fetches card master data, then queries replacement application records. Returns application ID derived from correlation ID or record ID and the application date if available.",
"operationId": "getDebitApplicationIdByFromShadowCardNumber",
"requestBody": {
"description": "Get Debit Application Id By From Shadow Card Number Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GetDebitApplicationIdByFromShadowCardNumberRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GetDebitApplicationIdByFromShadowCardNumberResponse"
}
}
}
},
"404": {
"$ref": "#/components/responses/ActionNotFound"
},
"400": {
"$ref": "#/components/responses/BusinessFailure"
},
"500": {
"$ref": "#/components/responses/TechnicalFailure"
}
}
}
},
"/debit/api/submitCardApplicationExtStatus": {
"post": {
"tags": [
"Card applications"
],
"summary": "Service that changes the card application status",
"description": "Submits a card application and returns extended status information. Used to track application processing in debit channels.",
"operationId": "submitCardApplicationExtStatus",
"requestBody": {
"description": "Submit Card Application Ext Status Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SubmitCardApplicationExtStatusRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SubmitCardApplicationExtStatusResponse"
}
}
}
},
"404": {
"$ref": "#/components/responses/ActionNotFound"
},
"400": {
"$ref": "#/components/responses/BusinessFailure"
},
"500": {
"$ref": "#/components/responses/TechnicalFailure"
}
}
}
},
"/debit/api/addDebitCardLog": {
"post": {
"tags": [
"Card lifecycle"
],
"summary": "Service for adding Debit Card logs",
"description": "Adds a log entry for a debit card including details like old and new values, card reference, masked number, and validity flag.",
"operationId": "addDebitCardLog",
"requestBody": {
"description": "Add Debit Card Log Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AddDebitCardLogRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AddDebitCardLogResponse"
}
}
}
},
"404": {
"$ref": "#/components/responses/ActionNotFound"
},
"400": {
"$ref": "#/components/responses/BusinessFailure"
},
"500": {
"$ref": "#/components/responses/TechnicalFailure"
}
}
}
},
"/debit/api/getAuthorizationListByBegindateEnddate": {
"post": {
"tags": [
"Transactions"
],
"summary": "Service that lists authorization transactions within a given date range",
"description": "Retrieves the list of debit card authorizations for a given period. Requires start date and end date as input and returns the authorization transactions that occurred within that date range.",
"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"
}
}
}
},
"/debit/api/getDbttransactionByCardrefCustomernum": {
"post": {
"tags": [
"Transactions"
],
"summary": "Service that lists customer debit transactions based on request criteria",
"description": "Retrieves debit card transaction records based on card reference number and customer number. Calls DCID repository to fetch transaction data and returns the result without additional filtering or transformation.",
"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"
}
}
}
},
"/debit/api/healthCheck": {
"post": {
"tags": [
"Platform operations"
],
"summary": "Method that checks whether the service is operational",
"description": "Performs a basic health check of the DebitDigitalChannelsIntegration service. Returns a result status (OK) and the current server date/time.",
"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"
}
}
}
},
"/debit/api/refreshCache": {
"post": {
"tags": [
"Platform operations"
],
"summary": "Refresh Cache",
"description": "Refreshes all relevant cache entries including card products, parameters, BIN, card statuses, transaction code matrices, and organization info for the Debit Digital Channels Integration. Ensures up-to-date values for processing and validation.",
"operationId": "refreshCache",
"responses": {
"200": {
"description": "Success"
},
"404": {
"$ref": "#/components/responses/ActionNotFound"
},
"400": {
"$ref": "#/components/responses/BusinessFailure"
},
"500": {
"$ref": "#/components/responses/TechnicalFailure"
}
}
}
}
},
"components": {
"schemas": {
"ActivateNoNameCardRequest": {
"required": [
"customerNumber"
],
"type": "object",
"properties": {
"channel": {
"type": "string",
"description": "Channel - [Optional]",
"nullable": true
},
"customerNumber": {
"type": "integer",
"description": "Customer Number - [Optional]",
"format": "int64"
},
"lastFourDigit": {
"type": "string",
"description": "Last Four Digit - [Optional]",
"nullable": true
},
"barcode": {
"type": "string",
"description": "Barcode - [Optional]",
"nullable": true
}
}
},
"ActivateNoNameCardResponse": {
"type": "object",
"properties": {
"shadowCardNumber": {
"type": "string",
"description": "Shadow Card Number - [Optional]",
"nullable": true
}
}
},
"AddDebitCardLogRequest": {
"required": [
"customerNumber",
"validFlag"
],
"type": "object",
"properties": {
"channel": {
"type": "string",
"description": "Channel - [Optional]",
"nullable": true
},
"logCode": {
"type": "string",
"description": "Log Code - [Optional]",
"nullable": true
},
"cardLogDetail": {
"type": "string",
"description": "Card Log Detail - [Optional]",
"nullable": true
},
"shadowCardNumber": {
"type": "string",
"description": "Shadow Card Number - [Optional]",
"nullable": true
},
"cardRefNumber": {
"type": "string",
"description": "Card Ref Number - [Optional]",
"nullable": true
},
"maskedCardNumber": {
"type": "string",
"description": "Masked Card Number - [Optional]",
"nullable": true
},
"customerNumber": {
"type": "integer",
"description": "Customer Number - [Optional]",
"format": "int64"
},
"validFlag": {
"type": "boolean",
"description": "Valid Flag - [Optional]"
},
"oldValue": {
"type": "string",
"description": "Old Value - [Optional]",
"nullable": true
},
"newValue": {
"type": "string",
"description": "New Value - [Optional]",
"nullable": true
}
}
},
"AddDebitCardLogResponse": {
"required": [
"recordId"
],
"type": "object",
"properties": {
"recordId": {
"type": "integer",
"description": "Record Id - [Optional]",
"format": "int64"
}
}
},
"ApplicableProductFilter": {
"type": "object",
"properties": {
"productGroupCode": {
"type": "string",
"description": "Product Group Code - [Optional]",
"nullable": true
}
}
},
"AttachAccount": {
"required": [
"accountNumber",
"accountRecordId"
],
"type": "object",
"properties": {
"accountNumber": {
"type": "integer",
"description": "Account Number - [Optional]",
"format": "int64"
},
"accountRecordId": {
"type": "integer",
"description": "Account Record Id - [Optional]",
"format": "int64"
}
}
},
"AttachCardAccountRequest": {
"required": [
"fecCode",
"accountBranchId",
"accountSuffix",
"accountNumber",
"accountOrderFlag",
"fxAutoConversionFlag",
"accountOrder"
],
"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]"
},
"fxAutoConversionFlag": {
"type": "boolean",
"description": "Fx Auto Conversion Flag"
},
"channel": {
"type": "string",
"description": "Channel - [Optional]",
"nullable": true
},
"currencyCode": {
"type": "string",
"description": "Currency Code - [Optional]",
"nullable": true
},
"accountOrder": {
"type": "integer",
"description": "Account Order - [Optional]",
"format": "int32"
}
}
},
"AttachCardAccountResponse": {
"required": [
"recordId"
],
"type": "object",
"properties": {
"recordId": {
"type": "integer",
"description": "Record Id - [Optional]",
"format": "int64"
}
}
},
"CancelCardEmbossByShadowCardNumberRequest": {
"type": "object",
"properties": {
"shadowCardNumber": {
"type": "string",
"description": "Shadow Card Number - [Optional]",
"nullable": true
},
"channel": {
"type": "string",
"description": "Channel - [Optional]",
"nullable": true
}
}
},
"CancelNoNameCardApplicationRequest": {
"type": "object",
"properties": {
"channel": {
"type": "string",
"description": "Channel - [Optional]",
"nullable": true
},
"correlationId": {
"type": "string",
"description": "Correlation Id - [Optional]",
"nullable": true
},
"applicationId": {
"type": "integer",
"description": "Application Id - [Optional]",
"format": "int64",
"nullable": true
},
"cancelReasonCode": {
"type": "string",
"description": "Cancel Reason Code - [Optional]",
"nullable": true
},
"cancelReasonText": {
"type": "string",
"description": "Cancel Reason Text - [Optional]",
"nullable": true
}
}
},
"CardAccount": {
"required": [
"fecCode",
"accountBranchId",
"accountSuffix",
"accountNumber",
"recordId",
"validFlag",
"insertDate",
"accountOrder",
"fxAutoConversionFlag"
],
"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
},
"recordId": {
"type": "integer",
"description": "Record Id - [Optional]",
"format": "int64"
},
"accountAlias": {
"type": "string",
"description": "Account Alias - [Optional]",
"nullable": true
},
"validFlag": {
"type": "boolean",
"description": "Valid Flag - [Optional]"
},
"updateUserId": {
"type": "string",
"description": "Update User Id - [Optional]",
"nullable": true
},
"updateDate": {
"type": "string",
"description": "Update Date - [Optional]",
"format": "date-time",
"nullable": true
},
"insertTokenId": {
"type": "string",
"description": "Insert Token Id - [Optional]",
"nullable": true
},
"insertUserId": {
"type": "string",
"description": "Insert User Id - [Optional]",
"nullable": true
},
"insertDate": {
"type": "string",
"description": "Insert Date - [Optional]",
"format": "date-time"
},
"updateTokenId": {
"type": "string",
"description": "Update Token Id - [Optional]",
"nullable": true
},
"accountOrderFlag": {
"type": "boolean",
"description": "Account Order Flag - [Optional]",
"nullable": true
},
"iban": {
"type": "string",
"description": "Iban - [Optional]",
"nullable": true
},
"currencyCode": {
"type": "string",
"description": "Currency Code - [Optional]",
"nullable": true
},
"accountOrder": {
"type": "integer",
"description": "Account Order - [Optional]",
"format": "int32"
},
"fxAutoConversionFlag": {
"type": "boolean",
"description": "Fx Auto Conversion Flag"
}
}
},
"CardAccountInfo": {
"required": [
"accountNumber",
"accountBranchId",
"fecCode",
"balance",
"usableBalance"
],
"type": "object",
"properties": {
"accountNumber": {
"type": "integer",
"description": "Account Number - [Optional]",
"format": "int64"
},
"cardAccountType": {
"type": "string",
"description": "Card Account Type - [Optional]",
"nullable": true
},
"accountType": {
"type": "string",
"description": "Account Type - [Optional]",
"nullable": true
},
"accountSubType": {
"type": "string",
"description": "Account Sub 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"
},
"currencyCode": {
"type": "string",
"description": "Currency Code - [Optional]",
"nullable": true
},
"balance": {
"type": "number",
"description": "Balance - [Optional]",
"format": "double"
},
"usableBalance": {
"type": "number",
"description": "Usable Balance - [Optional]",
"format": "double"
},
"iBAN": {
"type": "string",
"description": "I B A N - [Optional]",
"nullable": true
},
"errorDescription": {
"type": "string",
"description": "Error Description - [Optional]",
"nullable": true
}
}
},
"CardLimitParameterData": {
"type": "object",
"properties": {
"shadowCardNumber": {
"type": "string",
"description": "Shadow Card Number - [Optional]",
"nullable": true
},
"customerLimitationFlag": {
"type": "boolean",
"description": "Customer Limitation Flag - [Optional]",
"nullable": true
},
"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
},
"noCvmConsecutiveTransactionCount": {
"type": "integer",
"description": "No Cvm Consecutive Transaction Count - [Optional]",
"format": "int32",
"nullable": true
},
"noCvmConsecutiveTransactionLimit": {
"type": "number",
"description": "No Cvm Consecutive Transaction Limit - [Optional]",
"format": "double",
"nullable": true
}
}
},
"CardMiscOptionData": {
"required": [
"customerNumber"
],
"type": "object",
"properties": {
"customerNumber": {
"type": "integer",
"description": "Customer Number - [Optional]",
"format": "int64"
},
"mainCardRefNumber": {
"type": "string",
"description": "Main Card Ref Number - [Optional]",
"nullable": true
},
"cardRefNumber": {
"type": "string",
"description": "Card Ref Number - [Optional]",
"nullable": true
},
"optionType": {
"type": "string",
"description": "Option Type - [Optional]",
"nullable": true
},
"optionValue": {
"type": "string",
"description": "Option Value - [Optional]",
"nullable": true
}
}
},
"CardMiscOptionResponse": {
"type": "object",
"properties": {
"listOfCardMiscOptionLogRecordId": {
"type": "array",
"items": {
"type": "integer",
"format": "int64"
},
"description": "List Of Card Misc Option Log Record Id - [Optional]",
"nullable": true
}
}
},
"ChangeAndReplaceCardPermissions": {
"required": [
"eCommercePermitted",
"mailOrderPermitted"
],
"type": "object",
"properties": {
"eCommercePermitted": {
"type": "boolean",
"description": "E Commerce Permitted - [Optional]"
},
"mailOrderPermitted": {
"type": "boolean",
"description": "Mail Order Permitted - [Optional]"
}
}
},
"ChangeAndReplaceCardRequest": {
"type": "object",
"properties": {
"channel": {
"type": "string",
"description": "Channel - [Optional]",
"nullable": true
},
"shadowCardNumber": {
"type": "string",
"description": "Shadow Card Number - [Optional]",
"nullable": true
},
"cardStatusCode": {
"type": "string",
"description": "Card Status Code - [Optional]",
"nullable": true
},
"cardStatusReasonCode": {
"type": "string",
"description": "Card Status Reason Code - [Optional]",
"nullable": true
},
"closeRequestDate": {
"type": "string",
"description": "Close Request Date - [Optional]",
"format": "date-time",
"nullable": true
},
"replaceInfo": {
"allOf": [
{
"$ref": "#/components/schemas/ReplaceCardRequestInfo"
}
],
"description": "Replace Info - [Optional]",
"nullable": true
}
}
},
"ChangeAndReplaceCardResponse": {
"required": [
"toStatusActive"
],
"type": "object",
"properties": {
"toStatusActive": {
"type": "boolean",
"description": "To Status Active - [Optional]"
},
"replaceResult": {
"allOf": [
{
"$ref": "#/components/schemas/ReplaceCardResponseInfo"
}
],
"description": "Replace Result - [Optional]",
"nullable": true
}
}
},
"ChangeAndReplaceNoNameCardReplaceModel": {
"type": "object",
"properties": {
"replaceReasonCode": {
"type": "string",
"description": "Replace Reason Code - [Optional]",
"nullable": true
},
"enrollMasterpass": {
"type": "boolean",
"description": "Enroll Masterpass - [Optional]",
"nullable": true
},
"permissions": {
"allOf": [
{
"$ref": "#/components/schemas/ReplaceNoNameCardPermissions"
}
],
"description": "Permissions - [Optional]",
"nullable": true
}
}
},
"ChangeAndReplaceNoNameCardRequest": {
"type": "object",
"properties": {
"channel": {
"type": "string",
"description": "Channel - [Optional]",
"nullable": true
},
"shadowCardNumber": {
"type": "string",
"description": "Shadow Card Number - [Optional]",
"nullable": true
},
"cardStatusCode": {
"type": "string",
"description": "Card Status Code - [Optional]",
"nullable": true
},
"cardStatusReasonCode": {
"type": "string",
"description": "Card Status Reason Code - [Optional]",
"nullable": true
},
"closeRequestDate": {
"type": "string",
"description": "Close Request Date - [Optional]",
"format": "date-time",
"nullable": true
},
"replaceInfo": {
"allOf": [
{
"$ref": "#/components/schemas/ChangeAndReplaceNoNameCardReplaceModel"
}
],
"description": "Replace Info - [Optional]",
"nullable": true
}
}
},
"ChangeAndReplaceNoNameCardResponse": {
"required": [
"toStatusActive"
],
"type": "object",
"properties": {
"toStatusActive": {
"type": "boolean",
"description": "To Status Active - [Optional]"
},
"applicationId": {
"type": "integer",
"description": "Application Id - [Optional]",
"format": "int64",
"nullable": true
},
"shadowCardNumber": {
"type": "string",
"description": "Shadow Card Number - [Optional]",
"nullable": true
},
"newCardGenerated": {
"type": "boolean",
"description": "New Card Generated - [Optional]",
"nullable": true
},
"productChanged": {
"type": "boolean",
"description": "Product Changed - [Optional]",
"nullable": true
},
"maskedCardNumber": {
"type": "string",
"description": "Masked Card Number - [Optional]",
"nullable": true
},
"cardRefNumber": {
"type": "string",
"description": "Card Ref Number - [Optional]",
"nullable": true
}
}
},
"ChangeCardBranchRequest": {
"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
}
}
},
"ChangeCardBranchResponse": {
"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"
}
}
},
"ChangeCardMiscOptionRequest": {
"required": [
"customerNumber",
"allMainCardFlag",
"allCardFlag"
],
"type": "object",
"properties": {
"channel": {
"type": "string",
"description": "Channel - [Optional]",
"nullable": true
},
"optionType": {
"type": "string",
"description": "Option Type - [Optional]",
"nullable": true
},
"optionValue": {
"type": "string",
"description": "Option Value - [Optional]",
"nullable": true
},
"customerNumber": {
"type": "integer",
"description": "Customer Number - [Optional]",
"format": "int64"
},
"mainCardRefNumber": {
"type": "string",
"description": "Main Card Ref Number - [Optional]",
"nullable": true
},
"cardRefNumber": {
"type": "string",
"description": "Card Ref Number - [Optional]",
"nullable": true
},
"allMainCardFlag": {
"type": "boolean",
"description": "All Main Card Flag - [Optional]"
},
"allCardFlag": {
"type": "boolean",
"description": "All Card Flag - [Optional]"
}
}
},
"ChangeCardPinRequest": {
"type": "object",
"properties": {
"channel": {
"type": "string",
"description": "Channel - [Optional]",
"nullable": true
},
"shadowCardNumber": {
"type": "string",
"description": "Shadow Card Number - [Optional]",
"nullable": true
},
"currentCardPin": {
"type": "string",
"description": "Current Card Pin - [Optional]",
"nullable": true
},
"newCardPin": {
"type": "string",
"description": "New Card Pin - [Optional]",
"nullable": true
}
}
},
"ChangeCardPinResponse": {
"required": [
"success",
"verified",
"changed"
],
"type": "object",
"properties": {
"encryptedPin": {
"type": "string",
"description": "Encrypted Pin - [Optional]",
"nullable": true
},
"success": {
"type": "boolean",
"description": "Success - [Optional]"
},
"verified": {
"type": "boolean",
"description": "Verified - [Optional]"
},
"changed": {
"type": "boolean",
"description": "Changed - [Optional]"
}
}
},
"ChangeCardStatusRequest": {
"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
},
"transactionId": {
"type": "string",
"description": "Transaction Id - [Optional]",
"nullable": true
},
"closeRequestDate": {
"type": "string",
"description": "Close Request Date - [Optional]",
"format": "date-time",
"nullable": true
}
}
},
"ChangeCardStatusResponse": {
"required": [
"toStatusActive"
],
"type": "object",
"properties": {
"toStatusActive": {
"type": "boolean",
"description": "To Status Active - [Optional]"
}
}
},
"ChangeCustomerBranchRequest": {
"required": [
"customerNumber",
"targetBranchCode"
],
"type": "object",
"properties": {
"customerNumber": {
"type": "integer",
"description": "Customer Number - [Optional]",
"format": "int64"
},
"targetBranchCode": {
"type": "integer",
"description": "Target Branch Code - [Optional]",
"format": "int32"
},
"channel": {
"type": "string",
"description": "Channel - [Optional]",
"nullable": true
}
}
},
"ChangeCustomerBranchResponse": {
"required": [
"oldBranch",
"newBranch",
"changedCardCount"
],
"type": "object",
"properties": {
"oldBranch": {
"type": "integer",
"description": "Old Branch - [Optional]",
"format": "int32"
},
"newBranch": {
"type": "integer",
"description": "New Branch - [Optional]",
"format": "int32"
},
"changedCardCount": {
"type": "integer",
"description": "Changed Card Count - [Optional]",
"format": "int32"
},
"listOfShadowCardNumbers": {
"type": "array",
"items": {
"type": "string"
},
"description": "List Of Shadow Card Numbers - [Optional]",
"nullable": true
}
}
},
"ChangeSecurePinRequest": {
"required": [
"operationDateOfCurrent",
"operationDateOfNew"
],
"type": "object",
"properties": {
"channel": {
"type": "string",
"description": "Channel - [Optional]",
"nullable": true
},
"shadowCardNumber": {
"type": "string",
"description": "Shadow Card Number - [Optional]",
"nullable": true
},
"currentEPB": {
"type": "string",
"description": "Current E P B - [Optional]",
"nullable": true
},
"newEPB": {
"type": "string",
"description": "New E P B - [Optional]",
"nullable": true
},
"operationDateOfCurrent": {
"type": "string",
"description": "Operation Date Of Current - [Optional]",
"format": "date-time"
},
"operationDateOfNew": {
"type": "string",
"description": "Operation Date Of New - [Optional]",
"format": "date-time"
}
}
},
"ChangeSecurePinResponse": {
"required": [
"success"
],
"type": "object",
"properties": {
"encryptedPin": {
"type": "string",
"description": "Encrypted Pin - [Optional]",
"nullable": true
},
"success": {
"type": "boolean",
"description": "Success - [Optional]"
},
"responseCode": {
"type": "integer",
"description": "Response Code - [Optional]",
"format": "int32",
"nullable": true
},
"responseDescription": {
"type": "string",
"description": "Response Description - [Optional]",
"nullable": true
}
}
},
"CreateAndProcessNoNameCardApplicationRequest": {
"required": [
"customerNumber",
"enrollMasterpass"
],
"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"
},
"branchCode": {
"type": "integer",
"description": "Branch Code - [Optional]",
"format": "int32",
"nullable": true
},
"permissions": {
"allOf": [
{
"$ref": "#/components/schemas/NoNameCardPermissions"
}
],
"description": "Permissions - [Optional]",
"nullable": true
},
"listOfAccount": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NoNameCardAccount"
},
"description": "List Of Account - [Optional]",
"nullable": true
},
"enrollMasterpass": {
"type": "boolean",
"description": "Enroll Masterpass - [Optional]"
},
"applicationContractId": {
"type": "string",
"description": "Application Contract Id - [Optional]",
"nullable": true
}
}
},
"CreateAndProcessNoNameCardApplicationResponse": {
"type": "object",
"properties": {
"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
},
"sensitiveCardData": {
"allOf": [
{
"$ref": "#/components/schemas/SensitiveCardData"
}
],
"description": "Sensitive Card Data - [Optional]",
"nullable": true
},
"applicationId": {
"type": "integer",
"description": "Application Id - [Optional]",
"format": "int64",
"nullable": true
}
}
},
"CreateCardMiscOption": {
"type": "object",
"properties": {
"optionType": {
"type": "string",
"description": "Option Type - [Optional]",
"nullable": true
},
"optionValue": {
"type": "string",
"description": "Option Value - [Optional]",
"nullable": true
}
}
},
"CreateCardUsingNoNameApplicationRequest": {
"required": [
"customerNumber"
],
"type": "object",
"properties": {
"channel": {
"type": "string",
"description": "Channel - [Optional]",
"nullable": true
},
"applicationId": {
"type": "integer",
"description": "Application Id - [Optional]",
"format": "int64",
"nullable": true
},
"correlationId": {
"type": "string",
"description": "Correlation Id - [Optional]",
"nullable": true
},
"customerNumber": {
"type": "integer",
"description": "Customer Number - [Optional]",
"format": "int64"
},
"barcode": {
"type": "string",
"description": "Barcode - [Optional]",
"nullable": true
},
"permissions": {
"allOf": [
{
"$ref": "#/components/schemas/NoNameCardPermissions"
}
],
"description": "Permissions - [Optional]",
"nullable": true
},
"listOfAccount": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NoNameCardAccount"
},
"description": "List Of Account - [Optional]",
"nullable": true
}
}
},
"CreateCardUsingNoNameApplicationResponse": {
"type": "object",
"properties": {
"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
},
"sensitiveCardData": {
"allOf": [
{
"$ref": "#/components/schemas/SensitiveCardData"
}
],
"description": "Sensitive Card Data - [Optional]",
"nullable": true
}
}
},
"CreateCorporateCardAccount": {
"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
},
"currencyCode": {
"type": "string",
"description": "Currency Code - [Optional]",
"nullable": true
},
"fxAutoConversionFlag": {
"type": "boolean",
"description": "Fx Auto Conversion Flag",
"nullable": true
}
}
},
"CreateCorporateCardPermissions": {
"required": [
"eCommercePermitted"
],
"type": "object",
"properties": {
"eCommercePermitted": {
"type": "boolean",
"description": "E Commerce Permitted - [Optional]"
}
}
},
"CreateCorporateCardRequest": {
"required": [
"customerNumber",
"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"
},
"shadowCardNumber": {
"type": "string",
"description": "Shadow Card Number",
"nullable": true
},
"nameOnCard": {
"type": "string",
"description": "Name On Card - [Optional]",
"nullable": true
},
"secondNameOnCard": {
"type": "string",
"description": "Second Name On Card",
"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
},
"permissions": {
"allOf": [
{
"$ref": "#/components/schemas/CreateCorporateCardPermissions"
}
],
"description": "Permissions - [Optional]",
"nullable": true
},
"listOfAccount": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CreateCorporateCardAccount"
},
"description": "List Of Account - [Optional]",
"nullable": true
},
"applicationDate": {
"type": "string",
"description": "Application Date - [Optional]",
"format": "date-time",
"nullable": true
},
"applicationContractId": {
"type": "string",
"description": "Application Contract Id - [Optional]",
"nullable": true
}
}
},
"CreateCorporateCardResponse": {
"type": "object",
"properties": {
"recordId": {
"type": "integer",
"description": "Record Id - [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
},
"mainShadowCardNumber": {
"type": "string",
"description": "Main 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
},
"applicationId": {
"type": "integer",
"description": "Application Id - [Optional]",
"format": "int64",
"nullable": true
}
}
},
"CreateDummyCorporateCardRequest": {
"required": [
"customerNumber",
"branchCode"
],
"type": "object",
"properties": {
"channel": {
"type": "string",
"description": "Channel",
"nullable": true
},
"customerNumber": {
"type": "integer",
"description": "Customer Number",
"format": "int64"
},
"productNumber": {
"type": "string",
"description": "Product Number",
"nullable": true
},
"cardDeliveryType": {
"type": "string",
"description": "Card Delivery Type",
"nullable": true
},
"cardSendAddressType": {
"type": "string",
"description": "Card Send Address Type",
"nullable": true
},
"cardDeliveryBranchCode": {
"type": "integer",
"description": "Card Delivery Branch Code",
"format": "int32",
"nullable": true
},
"branchCode": {
"type": "integer",
"description": "Branch Code",
"format": "int32"
},
"nameOnCard": {
"type": "string",
"description": "Name On Card",
"nullable": true
},
"applicationDate": {
"type": "string",
"description": "Application Date",
"format": "date-time",
"nullable": true
}
}
},
"CreateDummyCorporateCardResponse": {
"required": [
"cardMasterRecordId",
"secureCardMasterRecordId"
],
"type": "object",
"properties": {
"cardRefNumber": {
"type": "string",
"description": "Card Ref Number",
"nullable": true
},
"mainCardRefNumber": {
"type": "string",
"description": "Main Card Ref Number",
"nullable": true
},
"shadowCardNumber": {
"type": "string",
"description": "Shadow Card Number",
"nullable": true
},
"cardMasterRecordId": {
"type": "integer",
"description": "Card Master Record Id",
"format": "int64"
},
"secureCardMasterRecordId": {
"type": "integer",
"description": "Secure Card Master Record Id",
"format": "int64"
}
}
},
"CreateIndividualCardAccount": {
"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
},
"currencyCode": {
"type": "string",
"description": "Currency Code - [Optional]",
"nullable": true
},
"fxAutoConversionFlag": {
"type": "boolean",
"description": "Fx Auto Conversion Flag",
"nullable": true
}
}
},
"CreateIndividualCardPermissions": {
"required": [
"eCommercePermitted",
"mailOrderPermitted"
],
"type": "object",
"properties": {
"eCommercePermitted": {
"type": "boolean",
"description": "E Commerce Permitted - [Optional]"
},
"mailOrderPermitted": {
"type": "boolean",
"description": "Mail Order Permitted - [Optional]"
}
}
},
"CreateIndividualCardRequest": {
"required": [
"customerNumber",
"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"
},
"nameOnCard": {
"type": "string",
"description": "Name On Card - [Optional]",
"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
},
"cardDeliveryBranchCode": {
"type": "integer",
"description": "Card Delivery Branch Code - [Optional]",
"format": "int32",
"nullable": true
},
"cardSendAddressId": {
"type": "integer",
"description": "Card Send Address Id - [Optional]",
"format": "int64",
"nullable": true
},
"listOfAccount": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CreateIndividualCardAccount"
},
"description": "List Of Account - [Optional]",
"nullable": true
},
"permissions": {
"allOf": [
{
"$ref": "#/components/schemas/CreateIndividualCardPermissions"
}
],
"description": "Permissions - [Optional]",
"nullable": true
},
"cardMiscOption": {
"allOf": [
{
"$ref": "#/components/schemas/CreateCardMiscOption"
}
],
"description": "Card Misc Option - [Optional]",
"nullable": true
},
"enrollMasterpass": {
"type": "boolean",
"description": "Enroll Masterpass - [Optional]",
"nullable": true
},
"applicationDate": {
"type": "string",
"description": "Application Date - [Optional]",
"format": "date-time",
"nullable": true
},
"applicationContractId": {
"type": "string",
"description": "Application Contract Id - [Optional]",
"nullable": true
},
"contractType": {
"type": "string",
"description": "Contract Type - [Optional]",
"nullable": true
},
"contractVersionNumber": {
"type": "string",
"description": "Contract Version Number - [Optional]",
"nullable": true
}
}
},
"CreateIndividualResponse": {
"type": "object",
"properties": {
"recordId": {
"type": "integer",
"description": "Record Id - [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
},
"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
},
"applicationId": {
"type": "integer",
"description": "Application Id - [Optional]",
"format": "int64",
"nullable": true
},
"attachAccountList": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AttachAccount"
},
"description": "Attach Account List - [Optional]",
"nullable": true
}
}
},
"CreateIndividualSupplementaryCardRequest": {
"required": [
"customerNumber",
"branchCode"
],
"type": "object",
"properties": {
"channel": {
"type": "string",
"description": "Channel",
"nullable": true
},
"productNumber": {
"type": "string",
"description": "Product Number",
"nullable": true
},
"customerNumber": {
"type": "integer",
"description": "Customer Number",
"format": "int64"
},
"shadowCardNumber": {
"type": "string",
"description": "Shadow Card Number",
"nullable": true
},
"nameOnCard": {
"type": "string",
"description": "Name On Card",
"nullable": true
},
"branchCode": {
"type": "integer",
"description": "Branch Code",
"format": "int32"
},
"cardDeliveryType": {
"type": "string",
"description": "Card Delivery Type",
"nullable": true
},
"cardSendAddressType": {
"type": "string",
"description": "Card Send Address Type",
"nullable": true
},
"cardDeliveryBranchCode": {
"type": "integer",
"description": "Card Delivery Branch Code",
"format": "int32",
"nullable": true
},
"cardSendAddressId": {
"type": "integer",
"description": "Card Send Address Id",
"format": "int64",
"nullable": true
},
"listOfAccount": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CreateIndividualCardAccount"
},
"description": "List Of Account",
"nullable": true
},
"permissions": {
"allOf": [
{
"$ref": "#/components/schemas/CreateIndividualCardPermissions"
}
],
"description": "Permissions",
"nullable": true
},
"cardMiscOption": {
"allOf": [
{
"$ref": "#/components/schemas/CreateCardMiscOption"
}
],
"description": "Card Misc Option",
"nullable": true
},
"enrollMasterpass": {
"type": "boolean",
"description": "Enroll Masterpass",
"nullable": true
},
"applicationDate": {
"type": "string",
"description": "Application Date",
"format": "date-time",
"nullable": true
},
"applicationContractId": {
"type": "string",
"description": "Application Contract Id",
"nullable": true
},
"contractType": {
"type": "string",
"description": "Contract Type",
"nullable": true
},
"contractVersionNumber": {
"type": "string",
"description": "Contract Version Number",
"nullable": true
}
}
},
"CreateIndividualSupplementaryCardResponse": {
"type": "object",
"properties": {
"recordId": {
"type": "integer",
"description": "Record Id",
"format": "int64",
"nullable": true
},
"maskedCardNumber": {
"type": "string",
"description": "Masked Card Number",
"nullable": true
},
"shadowCardNumber": {
"type": "string",
"description": "Shadow Card Number",
"nullable": true
},
"cardRefNumber": {
"type": "string",
"description": "Card Ref Number",
"nullable": true
},
"mainCardRefNumber": {
"type": "string",
"description": "Main Card Ref Number",
"nullable": true
},
"warnings": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "Warnings",
"nullable": true
},
"applicationId": {
"type": "integer",
"description": "Application Id",
"format": "int64",
"nullable": true
},
"attachAccountList": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AttachAccount"
},
"description": "Attach Account List",
"nullable": true
}
}
},
"CreateNoNameCardApplicationRequest": {
"required": [
"digitalCard",
"customerNumber",
"enrollMasterpass"
],
"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"
},
"branchCode": {
"type": "integer",
"description": "Branch Code - [Optional]",
"format": "int32",
"nullable": true
},
"permissions": {
"allOf": [
{
"$ref": "#/components/schemas/NoNameCardPermissions"
}
],
"description": "Permissions - [Optional]",
"nullable": true
},
"listOfAccount": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NoNameCardAccount"
},
"description": "List Of Account - [Optional]",
"nullable": true
},
"correlationId": {
"type": "string",
"description": "Correlation Id - [Optional]",
"nullable": true
},
"enrollMasterpass": {
"type": "boolean",
"description": "Enroll Masterpass - [Optional]"
},
"applicationContractId": {
"type": "string",
"description": "Application Contract Id - [Optional]",
"nullable": true
}
}
},
"CreateNoNameCardApplicationResponse": {
"required": [
"applicationId"
],
"type": "object",
"properties": {
"applicationId": {
"type": "integer",
"description": "Application Id - [Optional]",
"format": "int64"
}
}
},
"CreateVirtualCardRequest": {
"type": "object",
"properties": {
"channel": {
"type": "string",
"description": "Channel - [Optional]",
"nullable": true
},
"shadowCardNumber": {
"type": "string",
"description": "Shadow Card Number - [Optional]",
"nullable": true
},
"enrollMasterpass": {
"type": "boolean",
"description": "Enroll Masterpass - [Optional]",
"nullable": true
},
"listOfAccount": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CreateIndividualCardAccount"
},
"description": "List Of Account - [Optional]",
"nullable": true
}
}
},
"CreateVirtualCardResponse": {
"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
},
"relatedCardRefNumber": {
"type": "string",
"description": "Related Card Ref Number - [Optional]",
"nullable": true
},
"warnings": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "Warnings - [Optional]",
"nullable": true
},
"sensitiveCardData": {
"allOf": [
{
"$ref": "#/components/schemas/SensitiveCardData"
}
],
"description": "Sensitive Card Data - [Optional]",
"nullable": true
},
"attachAccountList": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AttachAccount"
},
"description": "Attach Account List - [Optional]",
"nullable": true
}
}
},
"CustomerLimitationParameterData": {
"required": [
"customerNumber"
],
"type": "object",
"properties": {
"customerNumber": {
"type": "integer",
"description": "Customer Number - [Optional]",
"format": "int64"
},
"customerLimitationFlag": {
"type": "boolean",
"description": "Customer Limitation Flag - [Optional]",
"nullable": true
},
"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
}
}
},
"DebitCardModel": {
"required": [
"supplementaryCardFlag",
"cardRefCurrentCardFlag",
"branchCode",
"virtualFlag",
"emvFlag",
"magneticStripeFlag",
"contactlessFlag",
"rewardEarningFlag",
"provisionStatusFlag",
"digitalCardFlag",
"cvv2RetryCount",
"pinRetryCount",
"disabledFlag",
"pendingReplaceApplicationExists"
],
"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",
"nullable": true
},
"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
},
"productSegmentCode": {
"type": "string",
"description": "Product Segment Code - [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
},
"tenantId": {
"type": "string",
"description": "Tenant Id - [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
},
"firstTrnDate": {
"type": "string",
"description": "First Trn 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
},
"lastPinSetDate": {
"type": "string",
"description": "Last 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
},
"isFirstPinSet": {
"type": "string",
"description": "Is First Pin Set - [Optional]",
"nullable": true
},
"sendingBranchCode": {
"type": "string",
"description": "Sending Branch Code - [Optional]",
"nullable": true
},
"sendingAddressType": {
"type": "string",
"description": "Sending Address Type - [Optional]",
"nullable": true
},
"productGroupCode": {
"type": "string",
"description": "Product Group Code - [Optional]",
"nullable": true
},
"productGroupDescription": {
"type": "string",
"description": "Product Group Description - [Optional]",
"nullable": true
},
"fromMaskedCardNumber": {
"type": "string",
"description": "From Masked Card Number - [Optional]",
"nullable": true
},
"toMaskedCardNumber": {
"type": "string",
"description": "To Masked Card Number - [Optional]",
"nullable": true
},
"disabledFlag": {
"type": "boolean",
"description": "Disabled Flag - [Optional]"
},
"cardAccountInfoList": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CardAccountInfo"
},
"description": "Card Account Info List - [Optional]",
"nullable": true
},
"sensitiveData": {
"allOf": [
{
"$ref": "#/components/schemas/SensitiveData"
}
],
"description": "Sensitive Data - [Optional]",
"nullable": true
},
"pendingReplaceApplicationExists": {
"type": "boolean",
"description": "Pending Replace Application Exists - [Optional]"
},
"pinStatus": {
"type": "string",
"description": "Pin Status - [Optional]",
"nullable": true
},
"cardStatusChangeChannel": {
"type": "string",
"description": "Card Status Change Channel - [Optional]",
"nullable": true
},
"securityFlag": {
"type": "boolean",
"description": "Security Flag - [Optional]",
"nullable": true
},
"citizenshipNumber": {
"type": "string",
"description": "Citizenship Number - [Optional]",
"nullable": true
},
"taxNumber": {
"type": "string",
"description": "Tax Number - [Optional]",
"nullable": true
},
"customerNameSurname": {
"type": "string",
"description": "Customer Name Surname - [Optional]",
"nullable": true
},
"cardSeqNumber": {
"type": "integer",
"description": "Card Seq Number - [Optional]",
"format": "int32",
"nullable": true
},
"isDelivered": {
"type": "boolean",
"description": "Is Delivered - [Optional]",
"nullable": true
}
}
},
"DebitCardPermissions": {
"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
},
"channel": {
"type": "string",
"description": "Channel - [Optional]",
"nullable": true
},
"securityFlag": {
"type": "boolean",
"description": "Security Flag - [Optional]",
"nullable": true
}
}
},
"DebitCorporateCustomerInfo": {
"type": "object",
"properties": {
"mainCustomerNumber": {
"type": "string",
"description": "Main Customer Number - [Optional]",
"nullable": true
},
"shadowCardNumber": {
"type": "string",
"description": "Shadow Card Number - [Optional]",
"nullable": true
},
"maskedCardNumber": {
"type": "string",
"description": "Masked Card Number - [Optional]",
"nullable": true
}
}
},
"DetachCardAccountByAccountNumberRequest": {
"required": [
"accountNumber",
"accountSuffix"
],
"type": "object",
"properties": {
"shadowCardNumber": {
"type": "string",
"description": "Shadow Card Number",
"nullable": true
},
"accountNumber": {
"type": "integer",
"description": "Account Number",
"format": "int64"
},
"accountSuffix": {
"type": "integer",
"description": "Account Suffix",
"format": "int32"
},
"channel": {
"type": "string",
"description": "Channel",
"nullable": true
}
}
},
"DetachCardAccountByAccountNumberResponse": {
"type": "object",
"properties": {
"listOfRemovedRecordId": {
"type": "array",
"items": {
"type": "integer",
"format": "int64"
},
"description": "List Of Removed Record Id",
"nullable": true
}
}
},
"DetachCardAccountRequest": {
"required": [
"recordId"
],
"type": "object",
"properties": {
"recordId": {
"type": "integer",
"description": "Record Id",
"format": "int64"
},
"channel": {
"type": "string",
"description": "Channel",
"nullable": true
},
"shadowCardNumber": {
"type": "string",
"description": "Shadow Card Number",
"nullable": true
}
}
},
"DetachCardAccountResponse": {
"required": [
"recordId"
],
"type": "object",
"properties": {
"recordId": {
"type": "integer",
"description": "Record Id",
"format": "int64"
}
}
},
"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
}
}
},
"GenerateCVVRequest": {
"type": "object",
"properties": {
"channel": {
"type": "string",
"description": "Channel - [Optional]",
"nullable": true
},
"shadowCardNumber": {
"type": "string",
"description": "Shadow Card Number - [Optional]",
"nullable": true
}
}
},
"GenerateCVVResponse": {
"required": [
"hasError"
],
"type": "object",
"properties": {
"hasError": {
"type": "boolean",
"description": "Has Error - [Optional]"
},
"errorText": {
"type": "string",
"description": "Error Text - [Optional]",
"nullable": true
},
"verificationValue": {
"type": "string",
"description": "Verification Value - [Optional]",
"nullable": true
}
}
},
"GetApplicableProductsByCustomerNumberRequest": {
"required": [
"customerNumber"
],
"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
}
}
},
"GetApplicableProductsByCustomerNumberResponse": {
"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
}
}
},
"GetAuthorizationListByBegindateEnddateParam": {
"type": "object",
"properties": {
"AuthorizationMatchStatus": {
"type": "string",
"description": "Authorization Match Status - [Optional]",
"nullable": true
},
"BeginDate": {
"type": "string",
"description": "Begin Date - [Optional]",
"format": "date-time",
"nullable": true
},
"CardRefNumber": {
"type": "string",
"description": "Card Ref Number - [Optional]",
"nullable": true
},
"CustomerNumber": {
"type": "integer",
"description": "Customer Number - [Optional]",
"format": "int64",
"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
},
"Mcc": {
"type": "string",
"description": "Mcc - [Optional]",
"nullable": true
},
"MinAmount": {
"type": "number",
"description": "Min Amount - [Optional]",
"format": "double",
"nullable": true
},
"NetworkType": {
"type": "string",
"description": "Network Type - [Optional]",
"nullable": true
},
"NotSuccesfullResponse": {
"type": "string",
"description": "Not Succesfull Response - [Optional]",
"nullable": true
},
"ResponseCode": {
"type": "string",
"description": "Response Code - [Optional]",
"nullable": true
},
"ResponseReasonCode": {
"type": "string",
"description": "Response Reason Code - [Optional]",
"nullable": true
},
"Rrn": {
"type": "string",
"description": "Rrn - [Optional]",
"nullable": true
},
"ShadowCardNumber": {
"type": "string",
"description": "Shadow Card Number - [Optional]",
"nullable": true
},
"TrnCodeMatrixId": {
"type": "string",
"description": "Trn Code Matrix Id - [Optional]",
"nullable": true
},
"TrnStatus": {
"type": "string",
"description": "Trn Status - [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": {
"required": [
"OpenReceiptFormIsEnabledFlag"
],
"type": "object",
"properties": {
"AccountNumber": {
"type": "number",
"description": "Account Number - [Optional]",
"format": "double",
"nullable": true
},
"AcqInstitutionId": {
"type": "string",
"description": "Acq Institution Id - [Optional]",
"nullable": true
},
"AuthorizationMatchStatus": {
"type": "string",
"description": "Authorization Match Status - [Optional]",
"nullable": true
},
"AuthorizationNumber": {
"type": "string",
"description": "Authorization Number - [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
},
"ChannelType": {
"type": "string",
"description": "Channel Type - [Optional]",
"nullable": true
},
"ChannelTypeDescription": {
"type": "string",
"description": "Channel Type Description - [Optional]",
"nullable": true
},
"CommissionAmount": {
"type": "number",
"description": "Commission Amount - [Optional]",
"format": "double",
"nullable": true
},
"Customer": {
"type": "string",
"description": "Customer - [Optional]",
"nullable": true
},
"CustomerNumber": {
"type": "integer",
"description": "Customer Number - [Optional]",
"format": "int64",
"nullable": true
},
"DigitalSlipValue": {
"type": "string",
"description": "Digital Slip Value - [Optional]",
"nullable": true
},
"EarnedPoint": {
"type": "number",
"description": "Earned Point - [Optional]",
"format": "double",
"nullable": true
},
"FeeAmount": {
"type": "number",
"description": "Fee Amount - [Optional]",
"format": "double",
"nullable": true
},
"InstallmentCount": {
"type": "integer",
"description": "Installment Count",
"format": "int32",
"nullable": true
},
"InstallmentParameter": {
"type": "string",
"description": "Installment Parameter",
"nullable": true
},
"InstallmentProfitRate": {
"type": "number",
"description": "Installment Profit Rate",
"format": "double",
"nullable": true
},
"IsChipFlag": {
"type": "boolean",
"description": "Is Chip Flag - [Optional]",
"nullable": true
},
"LocalAmount": {
"type": "number",
"description": "Local Amount - [Optional]",
"format": "double",
"nullable": true
},
"LocalCurrencyCode": {
"type": "string",
"description": "Local Currency Code - [Optional]",
"nullable": true
},
"LocalCurrencyDescription": {
"type": "string",
"description": "Local Currency Description - [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
},
"Mcc": {
"type": "string",
"description": "Mcc - [Optional]",
"nullable": true
},
"MccDescription": {
"type": "string",
"description": "Mcc Description - [Optional]",
"nullable": true
},
"MccGroupCode": {
"type": "string",
"description": "Mcc Group Code - [Optional]",
"nullable": true
},
"MerchantCountryCode": {
"type": "string",
"description": "Merchant Country Code - [Optional]",
"nullable": true
},
"MerchantName": {
"type": "string",
"description": "Merchant Name - [Optional]",
"nullable": true
},
"MerchantNumber": {
"type": "string",
"description": "Merchant Number - [Optional]",
"nullable": true
},
"NetworkTypeDescription": {
"type": "string",
"description": "Network Type Description - [Optional]",
"nullable": true
},
"OfflineFlag": {
"type": "boolean",
"description": "Offline Flag - [Optional]",
"nullable": true
},
"OpenReceiptFormIsEnabledFlag": {
"type": "boolean",
"description": "Open Receipt Form Is Enabled Flag - [Optional]"
},
"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
},
"ProductDigitalFlag": {
"type": "boolean",
"description": "Product Digital Flag - [Optional]",
"nullable": true
},
"ProductName": {
"type": "string",
"description": "Product Name - [Optional]",
"nullable": true
},
"ProductVirtualFlag": {
"type": "boolean",
"description": "Product Virtual Flag - [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
},
"ShadowCardNumber": {
"type": "string",
"description": "Shadow Card Number - [Optional]",
"nullable": true
},
"SourceTab": {
"type": "string",
"description": "Source Tab - [Optional]",
"nullable": true
},
"SuccessCode": {
"type": "string",
"description": "Success Code - [Optional]",
"nullable": true
},
"SupplementaryCardFlag": {
"type": "boolean",
"description": "Supplementary Card Flag",
"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
},
"TrnCodeMatrixId": {
"type": "string",
"description": "Trn Code Matrix Id - [Optional]",
"nullable": true
},
"TrnCurrencyCode": {
"type": "string",
"description": "Trn Currency Code - [Optional]",
"nullable": true
},
"TrnCurrencyDescription": {
"type": "string",
"description": "Trn Currency Description - [Optional]",
"nullable": true
},
"TrnEffect": {
"type": "string",
"description": "Trn Effect - [Optional]",
"nullable": true
},
"TrnRewardAbility": {
"type": "string",
"description": "Trn Reward Ability - [Optional]",
"nullable": true
},
"TrnStatusCode": {
"type": "string",
"description": "Trn Status Code - [Optional]",
"nullable": true
},
"TrnStatusDescription": {
"type": "string",
"description": "Trn Status Description - [Optional]",
"nullable": true
},
"Utid": {
"type": "string",
"description": "Utid - [Optional]",
"nullable": true
}
}
},
"GetAvailableECommerceLimitRequest": {
"type": "object",
"properties": {
"shadowCardNumber": {
"type": "string",
"description": "Shadow Card Number - [Optional]",
"nullable": true
},
"date": {
"type": "string",
"description": "Date - [Optional]",
"format": "date-time",
"nullable": true
}
}
},
"GetAvailableECommerceLimitResponse": {
"type": "object",
"properties": {
"availableAmountLimit": {
"type": "number",
"description": "Available Amount Limit - [Optional]",
"format": "double",
"nullable": true
},
"availableCountLimit": {
"type": "integer",
"description": "Available Count Limit - [Optional]",
"format": "int32",
"nullable": true
},
"cardRefNumber": {
"type": "string",
"description": "Card Ref Number - [Optional]",
"nullable": true
},
"channelType": {
"type": "string",
"description": "Channel Type - [Optional]",
"nullable": true
},
"monthlyTrnAmount": {
"type": "number",
"description": "Monthly Trn Amount - [Optional]",
"format": "double",
"nullable": true
},
"monthlyTrnCount": {
"type": "integer",
"description": "Monthly Trn Count - [Optional]",
"format": "int32",
"nullable": true
},
"networkType": {
"type": "string",
"description": "Network Type - [Optional]",
"nullable": true
},
"shadowCardNumber": {
"type": "string",
"description": "Shadow Card Number - [Optional]",
"nullable": true
},
"trnAmountUsage": {
"type": "number",
"description": "Trn Amount Usage - [Optional]",
"format": "double",
"nullable": true
},
"trnCountUsage": {
"type": "integer",
"description": "Trn Count Usage - [Optional]",
"format": "int32",
"nullable": true
}
}
},
"GetCardAccountCurrencyConversionRequest": {
"type": "object",
"properties": {
"channel": {
"type": "string",
"description": "Channel",
"nullable": true
},
"shadowCardNumber": {
"type": "string",
"description": "Shadow Card Number",
"nullable": true
}
}
},
"GetCardAccountCurrencyConversionResponse": {
"required": [
"fxAutoConversionFlag"
],
"type": "object",
"properties": {
"shadowCardNumber": {
"type": "string",
"description": "Shadow Card Number",
"nullable": true
},
"accountNumber": {
"type": "integer",
"description": "Account Number",
"format": "int64",
"nullable": true
},
"fxAutoConversionFlag": {
"type": "boolean",
"description": "Fx Auto Conversion Flag"
}
}
},
"GetCardApplication": {
"required": [
"accountNumber",
"accountBranchId",
"fecCode",
"balance",
"usableBalance"
],
"type": "object",
"properties": {
"accountNumber": {
"type": "integer",
"description": "Account Number - [Optional]",
"format": "int64"
},
"cardAccountType": {
"type": "string",
"description": "Card Account Type - [Optional]",
"nullable": true
},
"accountType": {
"type": "string",
"description": "Account Type - [Optional]",
"nullable": true
},
"accountSubType": {
"type": "string",
"description": "Account Sub 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"
},
"currencyCode": {
"type": "string",
"description": "Currency Code - [Optional]",
"nullable": true
},
"balance": {
"type": "number",
"description": "Balance - [Optional]",
"format": "double"
},
"usableBalance": {
"type": "number",
"description": "Usable Balance - [Optional]",
"format": "double"
},
"iBAN": {
"type": "string",
"description": "I B A N - [Optional]",
"nullable": true
},
"errorDescription": {
"type": "string",
"description": "Error Description - [Optional]",
"nullable": true
}
}
},
"GetCardApplicationListRequest": {
"type": "object",
"properties": {
"applicationId": {
"type": "integer",
"description": "Application Id - [Optional]",
"format": "int64",
"nullable": true
},
"customerNumber": {
"type": "integer",
"description": "Customer Number - [Optional]",
"format": "int64",
"nullable": true
}
}
},
"GetCardApplicationListResponse": {
"type": "object",
"properties": {
"getCardApplicationList": {
"type": "array",
"items": {
"$ref": "#/components/schemas/GetCardApplication"
},
"description": "Get Card Application List - [Optional]",
"nullable": true
}
}
},
"GetCardInfoRequest": {
"type": "object",
"properties": {
"shadowCardNumber": {
"type": "string",
"description": "Shadow Card Number - [Optional]",
"nullable": true
},
"cardNumber": {
"type": "string",
"description": "Card Number - [Optional]",
"nullable": true
}
}
},
"GetCardInfoResponse": {
"type": "object",
"properties": {
"cardInfo": {
"allOf": [
{
"$ref": "#/components/schemas/DebitCardModel"
}
],
"description": "Card Info - [Optional]",
"nullable": true
}
}
},
"GetCardLimitationParameterDataRequest": {
"type": "object",
"properties": {
"shadowCardNumber": {
"type": "string",
"description": "Shadow Card Number - [Optional]",
"nullable": true
}
}
},
"GetCardLimitationParameterDataResponse": {
"type": "object",
"properties": {
"cardLimitParameterDataList": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CardLimitParameterData"
},
"description": "Card Limit Parameter Data List - [Optional]",
"nullable": true
}
}
},
"GetCardListRequest": {
"required": [
"isCorporateAllCardList"
],
"type": "object",
"properties": {
"customerNumber": {
"type": "integer",
"description": "Customer Number - [Optional]",
"format": "int64",
"nullable": true
},
"mainCustomerNumber": {
"type": "integer",
"description": "Main Customer Number - [Optional]",
"format": "int64",
"nullable": true
},
"shadowCardNumber": {
"type": "string",
"description": "Shadow Card Number - [Optional]",
"nullable": true
},
"barcode": {
"type": "string",
"description": "Barcode - [Optional]",
"nullable": true
},
"accountNumber": {
"type": "integer",
"description": "Account Number - [Optional]",
"format": "int64",
"nullable": true
},
"cardNumber": {
"type": "string",
"description": "Card Number - [Optional]",
"nullable": true
},
"purpose": {
"type": "string",
"description": "Purpose - [Optional]",
"nullable": true
},
"channelCode": {
"type": "string",
"description": "Channel Code - [Optional]",
"nullable": true
},
"tenantId": {
"type": "string",
"description": "Tenant Id - [Optional]",
"nullable": true
},
"isCorporateAllCardList": {
"type": "boolean",
"description": "Is Corporate All Card List - [Optional]"
},
"branchCode": {
"type": "integer",
"description": "Branch Code - [Optional]",
"format": "int32",
"nullable": true
},
"customerNameSurname": {
"type": "string",
"description": "Customer Name Surname - [Optional]",
"nullable": true
},
"identificationNumber": {
"type": "string",
"description": "Identification Number - [Optional]",
"nullable": true
},
"courierStatus": {
"type": "string",
"description": "Courier Status - [Optional]",
"nullable": true
}
}
},
"GetCardListResponse": {
"type": "object",
"properties": {
"listOfCard": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DebitCardModel"
},
"description": "List Of Card - [Optional]",
"nullable": true
}
}
},
"GetCardMiscOptionRequest": {
"required": [
"customerNumber",
"allMainCardFlag",
"allCardFlag"
],
"type": "object",
"properties": {
"channel": {
"type": "string",
"description": "Channel - [Optional]",
"nullable": true
},
"optionType": {
"type": "string",
"description": "Option Type - [Optional]",
"nullable": true
},
"customerNumber": {
"type": "integer",
"description": "Customer Number - [Optional]",
"format": "int64"
},
"mainCardRefNumber": {
"type": "string",
"description": "Main Card Ref Number - [Optional]",
"nullable": true
},
"cardRefNumber": {
"type": "string",
"description": "Card Ref Number - [Optional]",
"nullable": true
},
"allMainCardFlag": {
"type": "boolean",
"description": "All Main Card Flag - [Optional]"
},
"allCardFlag": {
"type": "boolean",
"description": "All Card Flag - [Optional]"
}
}
},
"GetCardMiscOptionResponse": {
"type": "object",
"properties": {
"cardMiscOptionDataList": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CardMiscOptionData"
},
"description": "Card Misc Option Data List - [Optional]",
"nullable": true
}
}
},
"GetCardOperationLimitRequest": {
"type": "object",
"properties": {
"cardRefNumber": {
"type": "string",
"description": "Card Ref Number - [Optional]",
"nullable": true
},
"channel": {
"type": "string",
"description": "Channel - [Optional]",
"nullable": true
}
}
},
"GetCardOperationLimitResponse": {
"type": "object",
"properties": {
"listOfOperationLimit": {
"type": "array",
"items": {
"$ref": "#/components/schemas/GetCardOperationLimitResponseItem"
},
"description": "List Of Operation Limit - [Optional]",
"nullable": true
}
}
},
"GetCardOperationLimitResponseItem": {
"type": "object",
"properties": {
"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
}
}
},
"GetCardPermissionsRequest": {
"type": "object",
"properties": {
"shadowCardNumber": {
"type": "string",
"description": "Shadow Card Number - [Optional]",
"nullable": true
}
}
},
"GetCardPermissionsResponse": {
"type": "object",
"properties": {
"cardPermissionsList": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DebitCardPermissions"
},
"description": "Card Permissions List - [Optional]",
"nullable": true
}
}
},
"GetCardPinOperationHistory": {
"type": "object",
"properties": {
"channelType": {
"type": "string",
"description": "Channel Type - [Optional]",
"nullable": true
},
"insertDate": {
"type": "string",
"description": "Insert Date - [Optional]",
"format": "date-time",
"nullable": true
},
"operationResult": {
"type": "string",
"description": "Operation Result - [Optional]",
"nullable": true
},
"operationResultDescription": {
"type": "string",
"description": "Operation Result Description - [Optional]",
"nullable": true
},
"operationType": {
"type": "string",
"description": "Operation Type - [Optional]",
"nullable": true
},
"operationTypeDescription": {
"type": "string",
"description": "Operation Type Description - [Optional]",
"nullable": true
}
}
},
"GetCardPinOperationHistoryRequest": {
"type": "object",
"properties": {
"shadowCardNumber": {
"type": "string",
"description": "Shadow Card Number - [Optional]",
"nullable": true
}
}
},
"GetCardPinOperationHistoryResponse": {
"type": "object",
"properties": {
"getCardPinOperationHistoryList": {
"type": "array",
"items": {
"$ref": "#/components/schemas/GetCardPinOperationHistory"
},
"description": "Get Card Pin Operation History List - [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"
]
}
}
},
"GetCorporateCustomerInfoByIndividualCustomerRequest": {
"type": "object",
"properties": {
"customerNumber": {
"type": "integer",
"description": "Customer Number - [Optional]",
"format": "int64",
"nullable": true
},
"channel": {
"type": "string",
"description": "Channel - [Optional]",
"nullable": true
}
}
},
"GetCorporateCustomerInfoByIndividualCustomerResponse": {
"type": "object",
"properties": {
"listOfDebitCorporateCustomerInfo": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DebitCorporateCustomerInfo"
},
"description": "List Of Debit Corporate Customer Info - [Optional]",
"nullable": true
}
}
},
"GetCustomerAssetRequest": {
"required": [
"customerNumber"
],
"type": "object",
"properties": {
"customerNumber": {
"type": "integer",
"description": "Customer Number - [Optional]",
"format": "int64"
},
"purpose": {
"type": "string",
"description": "Purpose - [Optional]",
"nullable": true
},
"channelCode": {
"type": "string",
"description": "Channel Code - [Optional]",
"nullable": true
}
}
},
"GetCustomerAssetResponse": {
"type": "object",
"properties": {
"listOfCard": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DebitCardModel"
},
"description": "List Of Card - [Optional]",
"nullable": true
}
}
},
"GetCustomerAssetsSummaryDebitCardModel": {
"required": [
"supplementaryCardFlag",
"digitalCardFlag"
],
"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": "string",
"description": "Customer Number - [Optional]",
"nullable": true
},
"mainCustomerNumber": {
"type": "string",
"description": "Main Customer Number - [Optional]",
"nullable": true
},
"supplementaryCardFlag": {
"type": "boolean",
"description": "Supplementary Card Flag - [Optional]"
},
"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
},
"expiryDateStr": {
"type": "string",
"description": "Expiry Date Str - [Optional]",
"nullable": true
},
"digitalCardFlag": {
"type": "boolean",
"description": "Digital Card Flag - [Optional]"
},
"cardStatusCode": {
"type": "string",
"description": "Card Status Code - [Optional]",
"nullable": true
},
"cardStatusCodeDescription": {
"type": "string",
"description": "Card Status Code Description - [Optional]",
"nullable": true
},
"cardStatusReasonCode": {
"type": "string",
"description": "Card Status Reason Code - [Optional]",
"nullable": true
},
"cardStatusReasonCodeDescription": {
"type": "string",
"description": "Card Status Reason Code Description - [Optional]",
"nullable": true
},
"cardStatusChangeChannel": {
"type": "string",
"description": "Card Status Change Channel - [Optional]",
"nullable": true
},
"securityFlag": {
"type": "boolean",
"description": "Security Flag - [Optional]",
"nullable": true
},
"cardAccountInfoList": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CardAccountInfo"
},
"description": "Card Account Info List - [Optional]",
"nullable": true
}
}
},
"GetCustomerAssetsSummaryDebitRequest": {
"required": [
"customerNumber"
],
"type": "object",
"properties": {
"customerNumber": {
"type": "integer",
"description": "Customer Number - [Optional]",
"format": "int64"
},
"channelCode": {
"type": "string",
"description": "Channel Code - [Optional]",
"nullable": true
}
}
},
"GetCustomerAssetsSummaryDebitResponse": {
"type": "object",
"properties": {
"listOfCard": {
"type": "array",
"items": {
"$ref": "#/components/schemas/GetCustomerAssetsSummaryDebitCardModel"
},
"description": "List Of Card - [Optional]",
"nullable": true
}
}
},
"GetCustomerDebitCardListByTenantIdRequest": {
"type": "object",
"properties": {
"customerNumber": {
"type": "integer",
"description": "Customer Number - [Optional]",
"format": "int64",
"nullable": true
},
"tenantId": {
"type": "string",
"description": "Tenant Id - [Optional]",
"nullable": true
},
"channel": {
"type": "string",
"description": "Channel - [Optional]",
"nullable": true
}
}
},
"GetCustomerDebitCardListByTenantIdResponse": {
"type": "object",
"properties": {
"customerDebitCardList": {
"type": "array",
"items": {
"$ref": "#/components/schemas/GetCustomerDebitCardListByTenantIdResult"
},
"description": "Customer Debit Card List - [Optional]",
"nullable": true
}
}
},
"GetCustomerDebitCardListByTenantIdResult": {
"required": [
"usableBalance",
"pendingReplaceApplicationExists"
],
"type": "object",
"properties": {
"bin": {
"type": "string",
"description": "Bin - [Optional]",
"nullable": true
},
"keyDerivationIndex": {
"type": "integer",
"description": "Key Derivation Index - [Optional]",
"format": "int32",
"nullable": true
},
"encryptedCardNumber": {
"type": "string",
"description": "Encrypted Card Number - [Optional]",
"nullable": true
},
"toShadowCardNumber": {
"type": "string",
"description": "To Shadow Card Number - [Optional]",
"nullable": true
},
"accountNumber": {
"type": "integer",
"description": "Account Number - [Optional]",
"format": "int64",
"nullable": true
},
"barcode": {
"type": "string",
"description": "Barcode - [Optional]",
"nullable": true
},
"cardRenewStatus": {
"type": "string",
"description": "Card Renew Status - [Optional]",
"nullable": true
},
"cardRenewSubStatus": {
"type": "string",
"description": "Card Renew Sub Status - [Optional]",
"nullable": true
},
"cardStatusCode": {
"type": "string",
"description": "Card Status Code - [Optional]",
"nullable": true
},
"cardStatusCodeDesc": {
"type": "string",
"description": "Card Status Code Desc - [Optional]",
"nullable": true
},
"cardStatusReasonCode": {
"type": "string",
"description": "Card Status Reason Code - [Optional]",
"nullable": true
},
"cardStatusReasonCodeDesc": {
"type": "string",
"description": "Card Status Reason Code Desc - [Optional]",
"nullable": true
},
"customerNumber": {
"type": "integer",
"description": "Customer Number - [Optional]",
"format": "int64",
"nullable": true
},
"digitalCardFlag": {
"type": "boolean",
"description": "Digital Card Flag - [Optional]",
"nullable": true
},
"firstPinSetDate": {
"type": "string",
"description": "First Pin Set 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
},
"noNameFlag": {
"type": "boolean",
"description": "No Name Flag - [Optional]",
"nullable": true
},
"productNumber": {
"type": "string",
"description": "Product Number - [Optional]",
"nullable": true
},
"productShortName": {
"type": "string",
"description": "Product Short Name - [Optional]",
"nullable": true
},
"shadowCardNumber": {
"type": "string",
"description": "Shadow Card Number - [Optional]",
"nullable": true
},
"usableBalance": {
"type": "number",
"description": "Usable Balance - [Optional]",
"format": "double"
},
"currencyCode": {
"type": "string",
"description": "Currency Code - [Optional]",
"nullable": true
},
"pendingReplaceApplicationExists": {
"type": "boolean",
"description": "Pending Replace Application Exists - [Optional]"
},
"expiryDateStr": {
"type": "string",
"description": "Expiry Date Str - [Optional]",
"nullable": true
}
}
},
"GetCustomerDebitShadowCardsByTenantIdRequest": {
"type": "object",
"properties": {
"customerNumber": {
"type": "integer",
"description": "Customer Number - [Optional]",
"format": "int64",
"nullable": true
},
"tenantId": {
"type": "string",
"description": "Tenant Id - [Optional]",
"nullable": true
},
"channel": {
"type": "string",
"description": "Channel - [Optional]",
"nullable": true
}
}
},
"GetCustomerDebitShadowCardsByTenantIdResponse": {
"type": "object",
"properties": {
"customerDebitShadowCardList": {
"type": "array",
"items": {
"$ref": "#/components/schemas/GetCustomerDebitShadowCardsByTenantIdResult"
},
"description": "Customer Debit Shadow Card List - [Optional]",
"nullable": true
}
}
},
"GetCustomerDebitShadowCardsByTenantIdResult": {
"type": "object",
"properties": {
"cardType": {
"type": "string",
"description": "Card Type - [Optional]",
"nullable": true
},
"customerNumber": {
"type": "integer",
"description": "Customer 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
},
"productNumber": {
"type": "string",
"description": "Product Number - [Optional]",
"nullable": true
},
"productShortName": {
"type": "string",
"description": "Product Short Name - [Optional]",
"nullable": true
},
"cardStatusCode": {
"type": "string",
"description": "Card Status Code - [Optional]",
"nullable": true
},
"cardStatusCodeDesc": {
"type": "string",
"description": "Card Status Code Desc - [Optional]",
"nullable": true
},
"cardStatusReasonCode": {
"type": "string",
"description": "Card Status Reason Code - [Optional]",
"nullable": true
},
"cardStatusReasonCodeDesc": {
"type": "string",
"description": "Card Status Reason Code Desc - [Optional]",
"nullable": true
}
}
},
"GetCustomerLimitationParametersRequest": {
"required": [
"customerNumber"
],
"type": "object",
"properties": {
"customerNumber": {
"type": "integer",
"description": "Customer Number - [Optional]",
"format": "int64"
}
}
},
"GetCustomerLimitationParametersResponse": {
"type": "object",
"properties": {
"customerLimitationParameterDataList": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CustomerLimitationParameterData"
},
"description": "Customer Limitation Parameter Data List - [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": {
"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": {
"type": "object",
"properties": {
"AccountNumber": {
"type": "number",
"description": "Account Number - [Optional]",
"format": "double",
"nullable": true
},
"AcqInstitutionId": {
"type": "string",
"description": "Acq Institution Id - [Optional]",
"nullable": true
},
"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
},
"ChannelType": {
"type": "string",
"description": "Channel Type - [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
},
"DigitalSlipValue": {
"type": "string",
"description": "Digital Slip Value - [Optional]",
"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
},
"InstallmentCount": {
"type": "integer",
"description": "Installment Count",
"format": "int32",
"nullable": true
},
"InstallmentParameter": {
"type": "string",
"description": "Installment Parameter",
"nullable": true
},
"InstallmentProfitRate": {
"type": "number",
"description": "Installment Profit Rate",
"format": "double",
"nullable": true
},
"InvoiceNumber": {
"type": "string",
"description": "Invoice Number - [Optional]",
"nullable": true
},
"LocalAmount": {
"type": "number",
"description": "Local Amount - [Optional]",
"format": "double",
"nullable": true
},
"LocalCurrency": {
"type": "string",
"description": "Local Currency - [Optional]",
"nullable": true
},
"LocalCurrencyCode": {
"type": "string",
"description": "Local Currency Code - [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
},
"Mcc": {
"type": "string",
"description": "Mcc - [Optional]",
"nullable": true
},
"MccDescription": {
"type": "string",
"description": "Mcc Description - [Optional]",
"nullable": true
},
"MccGroupCode": {
"type": "string",
"description": "Mcc Group Code - [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
},
"MerchantNumber": {
"type": "string",
"description": "Merchant Number - [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
},
"ProductDigitalFlag": {
"type": "boolean",
"description": "Product Digital Flag - [Optional]",
"nullable": true
},
"ProductVirtualFlag": {
"type": "boolean",
"description": "Product Virtual Flag - [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
},
"ShadowCardNumber": {
"type": "string",
"description": "Shadow Card Number - [Optional]",
"nullable": true
},
"SupplementaryCardFlag": {
"type": "boolean",
"description": "Supplementary Card Flag",
"nullable": true
},
"TerminalNumber": {
"type": "string",
"description": "Terminal Number - [Optional]",
"nullable": true
},
"TerminalType": {
"type": "string",
"description": "Terminal Type - [Optional]",
"nullable": true
},
"TransactionDescription": {
"type": "string",
"description": "Transaction Description - [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
},
"TrnCodeMatrixId": {
"type": "string",
"description": "Trn Code Matrix Id - [Optional]",
"nullable": true
},
"TrnCurrency": {
"type": "string",
"description": "Trn Currency - [Optional]",
"nullable": true
},
"TrnCurrencyCode": {
"type": "string",
"description": "Trn Currency Code - [Optional]",
"nullable": true
},
"TrnDate": {
"type": "string",
"description": "Trn Date - [Optional]",
"format": "date-time",
"nullable": true
},
"TrnDescription": {
"type": "string",
"description": "Trn Description - [Optional]",
"nullable": true
},
"TrnEffect": {
"type": "string",
"description": "Trn Effect - [Optional]",
"nullable": true
},
"TrnOrigin": {
"type": "integer",
"description": "Trn Origin - [Optional]",
"format": "int32",
"nullable": true
},
"TrnRewardAbility": {
"type": "string",
"description": "Trn Reward Ability - [Optional]",
"nullable": true
},
"TrnStatus": {
"type": "string",
"description": "Trn Status - [Optional]",
"nullable": true
},
"Utid": {
"type": "string",
"description": "Utid - [Optional]",
"nullable": true
}
}
},
"GetDebitApplicationIdByFromShadowCardNumberRequest": {
"type": "object",
"properties": {
"shadowCardNumber": {
"type": "string",
"description": "Shadow Card Number - [Optional]",
"nullable": true
},
"channel": {
"type": "string",
"description": "Channel - [Optional]",
"nullable": true
}
}
},
"GetDebitApplicationIdByFromShadowCardNumberResponse": {
"type": "object",
"properties": {
"applicationId": {
"type": "string",
"description": "Application Id - [Optional]",
"nullable": true
},
"applicationDate": {
"type": "string",
"description": "Application Date - [Optional]",
"format": "date-time",
"nullable": true
}
}
},
"GetDebitCardTransactionByUtidRequest": {
"type": "object",
"properties": {
"utid": {
"type": "string",
"description": "Utid - [Optional]",
"nullable": true
}
}
},
"GetDebitCustomerLisfOfBranchRequest": {
"required": [
"branchCode"
],
"type": "object",
"properties": {
"branchCode": {
"type": "integer",
"description": "Branch Code - [Optional]",
"format": "int32"
},
"channel": {
"type": "string",
"description": "Channel - [Optional]",
"nullable": true
}
}
},
"GetDebitCustomerListOfBranchResponse": {
"type": "object",
"properties": {
"customerOid": {
"type": "array",
"items": {
"type": "integer",
"format": "int64"
},
"description": "Customer Oid - [Optional]",
"nullable": true
}
}
},
"GetDebitTransactionAllRequest": {
"required": [
"beginDate",
"endDate"
],
"type": "object",
"properties": {
"shadowCardNumber": {
"type": "string",
"description": "Shadow Card Number - [Optional]",
"nullable": true
},
"beginDate": {
"type": "string",
"description": "Begin Date - [Optional]",
"format": "date-time"
},
"endDate": {
"type": "string",
"description": "End Date - [Optional]",
"format": "date-time"
},
"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
}
}
},
"GetDebitTransactionAllResponse": {
"required": [
"totalAmount"
],
"type": "object",
"properties": {
"listOfTransaction": {
"type": "array",
"items": {
"$ref": "#/components/schemas/GetDebitTransactionAllResponseItem"
},
"description": "List Of Transaction - [Optional]",
"nullable": true
},
"totalAmount": {
"type": "number",
"description": "Total Amount - [Optional]",
"format": "double"
}
}
},
"GetDebitTransactionAllResponseItem": {
"required": [
"cardProductVirtualFlag",
"cardProductDigitalFlag"
],
"type": "object",
"properties": {
"sourceTab": {
"type": "string",
"description": "Source Tab - [Optional]",
"nullable": true
},
"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
},
"customer": {
"type": "string",
"description": "Customer - [Optional]",
"nullable": true
},
"customerNumber": {
"type": "integer",
"description": "Customer Number - [Optional]",
"format": "int64",
"nullable": true
},
"digitalSlipValue": {
"type": "string",
"description": "Digital Slip Value - [Optional]",
"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
},
"merchantNumber": {
"type": "string",
"description": "Merchant Number - [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
},
"trnStatusCode": {
"type": "string",
"description": "Trn Status Code - [Optional]",
"nullable": true
},
"trnStatusDescription": {
"type": "string",
"description": "Trn Status Description - [Optional]",
"nullable": true
},
"utid": {
"type": "string",
"description": "Utid - [Optional]",
"nullable": true
},
"trnEffect": {
"type": "string",
"description": "Trn Effect - [Optional]",
"nullable": true
},
"channelType": {
"type": "string",
"description": "Channel Type - [Optional]",
"nullable": true
},
"capitalRewardIndicator": {
"type": "string",
"description": "Capital Reward Indicator - [Optional]",
"nullable": true
},
"cardProductVirtualFlag": {
"type": "boolean",
"description": "Card Product Virtual Flag - [Optional]"
},
"trnCurrencyCode": {
"type": "string",
"description": "Trn Currency Code - [Optional]",
"nullable": true
},
"cardProductDigitalFlag": {
"type": "boolean",
"description": "Card Product Digital Flag - [Optional]"
},
"transactionDescription": {
"type": "string",
"description": "Transaction Description - [Optional]",
"nullable": true
},
"earnedPoint": {
"allOf": [
{
"$ref": "#/components/schemas/RewardItem"
}
],
"description": "Earned Point - [Optional]",
"nullable": true
},
"trnCodeMatrixId": {
"type": "string",
"description": "Trn Code Matrix Id - [Optional]",
"nullable": true
},
"shadowCardNumber": {
"type": "string",
"description": "Shadow Card Number - [Optional]",
"nullable": true
},
"mainCardRefNumber": {
"type": "string",
"description": "Main Card Ref Number - [Optional]",
"nullable": true
},
"mcc": {
"type": "string",
"description": "Mcc - [Optional]",
"nullable": true
},
"mccGroupCode": {
"type": "string",
"description": "Mcc Group Code - [Optional]",
"nullable": true
},
"localCurrencyCode": {
"type": "string",
"description": "Local Currency Code - [Optional]",
"nullable": true
},
"accountNumber": {
"type": "number",
"description": "Account Number - [Optional]",
"format": "double",
"nullable": true
},
"acqInstitutionId": {
"type": "string",
"description": "Acq Institution Id - [Optional]",
"nullable": true
},
"supplementaryCardFlag": {
"type": "boolean",
"description": "Supplementary Card Flag",
"nullable": true
}
}
},
"GetDigitalSlipReceiptRequest": {
"type": "object",
"properties": {
"channel": {
"type": "string",
"description": "Channel - [Optional]",
"nullable": true
},
"utid": {
"type": "string",
"description": "Utid - [Optional]",
"nullable": true
}
}
},
"GetDigitalSlipReceiptResponse": {
"type": "object",
"properties": {
"utid": {
"type": "string",
"description": "Utid - [Optional]",
"nullable": true
},
"refUtid": {
"type": "string",
"description": "Ref Utid - [Optional]",
"nullable": true
},
"trnCodeMatrixId": {
"type": "string",
"description": "Trn Code Matrix Id - [Optional]",
"nullable": true
},
"shadowCardNumber": {
"type": "string",
"description": "Shadow Card Number - [Optional]",
"nullable": true
},
"cardRefNumber": {
"type": "string",
"description": "Card Ref Number - [Optional]",
"nullable": true
},
"maskedCardNumber": {
"type": "string",
"description": "Masked Card Number - [Optional]",
"nullable": true
},
"trnAmount": {
"type": "number",
"description": "Trn Amount - [Optional]",
"format": "double",
"nullable": true
},
"trnCurrencyCode": {
"type": "string",
"description": "Trn Currency Code - [Optional]",
"nullable": true
},
"responseCode": {
"type": "string",
"description": "Response Code - [Optional]",
"nullable": true
},
"trnDatetime": {
"type": "string",
"description": "Trn Datetime - [Optional]",
"format": "date-time",
"nullable": true
},
"trnStatus": {
"type": "string",
"description": "Trn Status - [Optional]",
"nullable": true
},
"stan": {
"type": "integer",
"description": "Stan - [Optional]",
"format": "int32",
"nullable": true
},
"rrn": {
"type": "string",
"description": "Rrn - [Optional]",
"nullable": true
},
"authorizationNumber": {
"type": "string",
"description": "Authorization Number - [Optional]",
"nullable": true
},
"terminalNumber": {
"type": "string",
"description": "Terminal Number - [Optional]",
"nullable": true
},
"merchantNumber": {
"type": "string",
"description": "Merchant Number - [Optional]",
"nullable": true
},
"merchantName": {
"type": "string",
"description": "Merchant Name - [Optional]",
"nullable": true
},
"panEntryMode": {
"type": "string",
"description": "Pan Entry Mode - [Optional]",
"nullable": true
},
"iccData84": {
"type": "string",
"description": "Icc Data84 - [Optional]",
"nullable": true
},
"iccData9f26": {
"type": "string",
"description": "Icc Data9f26 - [Optional]",
"nullable": true
},
"cardSeqNumber": {
"type": "string",
"description": "Card Seq Number - [Optional]",
"nullable": true
},
"merchantAddress": {
"type": "string",
"description": "Merchant Address - [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
}
}
},
"HealthCheckResponse": {
"required": [
"date"
],
"type": "object",
"properties": {
"result": {
"type": "string",
"description": "Result - [Optional]",
"nullable": true
},
"date": {
"type": "string",
"description": "Date - [Optional]",
"format": "date-time"
}
}
},
"IncreasePinTryCountRequest": {
"required": [
"increaseCount"
],
"type": "object",
"properties": {
"channel": {
"type": "string",
"description": "Channel - [Optional]",
"nullable": true
},
"shadowCardNumber": {
"type": "string",
"description": "Shadow Card Number - [Optional]",
"nullable": true
},
"increaseCount": {
"type": "integer",
"description": "Increase Count - [Optional]",
"format": "int32"
}
}
},
"IsCardFoundInRipperRequest": {
"type": "object",
"properties": {
"cardNumber": {
"type": "string",
"description": "Card Number - [Optional]",
"nullable": true
}
}
},
"IsCardFoundInRipperResponse": {
"required": [
"isFound"
],
"type": "object",
"properties": {
"isFound": {
"type": "boolean",
"description": "Is Found - [Optional]"
},
"serviceDomainId": {
"type": "string",
"description": "Service Domain Id - [Optional]",
"nullable": true
}
}
},
"IsCustomerConvertToRipperRequest": {
"required": [
"customerNumber"
],
"type": "object",
"properties": {
"customerNumber": {
"type": "integer",
"description": "Customer Number - [Optional]",
"format": "int64"
}
}
},
"IsCustomerConvertToRipperResponse": {
"required": [
"haveAnyDebitCard",
"haveAnyCreditCard",
"haveAnyPrepaidCard"
],
"type": "object",
"properties": {
"haveAnyDebitCard": {
"type": "boolean",
"description": "Have Any Debit Card - [Optional]"
},
"haveAnyCreditCard": {
"type": "boolean",
"description": "Have Any Credit Card - [Optional]"
},
"haveAnyPrepaidCard": {
"type": "boolean",
"description": "Have Any Prepaid Card - [Optional]"
}
}
},
"KeyValuePair_2": {
"type": "object"
},
"ListCardAccountByAccountNumberRequest": {
"required": [
"accountNumber"
],
"type": "object",
"properties": {
"accountNumber": {
"type": "integer",
"description": "Account Number - [Optional]",
"format": "int64"
}
}
},
"ListCardAccountByAccountNumberResponse": {
"type": "object",
"properties": {
"listOfAccount": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CardAccount"
},
"description": "List Of Account - [Optional]",
"nullable": true
}
}
},
"ListCardAccountByShadowCardNumberRequest": {
"type": "object",
"properties": {
"shadowCardNumber": {
"type": "string",
"description": "Shadow Card Number - [Optional]",
"nullable": true
}
}
},
"ListCardAccountByShadowCardNumberResponse": {
"type": "object",
"properties": {
"listOfAccount": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CardAccount"
},
"description": "List Of Account - [Optional]",
"nullable": true
}
}
},
"ModifyCardAccountRequest": {
"required": [
"recordId",
"accountNumber",
"accountOrderFlag",
"accountOrder",
"fxAutoConversionFlag"
],
"type": "object",
"properties": {
"recordId": {
"type": "integer",
"description": "Record Id - [Optional]",
"format": "int64"
},
"accountType": {
"type": "string",
"description": "Account Type - [Optional]",
"nullable": true
},
"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
},
"accountOrderFlag": {
"type": "boolean",
"description": "Account Order Flag - [Optional]"
},
"channel": {
"type": "string",
"description": "Channel - [Optional]",
"nullable": true
},
"accountOrder": {
"type": "integer",
"description": "Account Order - [Optional]",
"format": "int32"
},
"fxAutoConversionFlag": {
"type": "boolean",
"description": "Fx Auto Conversion Flag"
}
}
},
"ModifyCardAccountResponse": {
"required": [
"recordId"
],
"type": "object",
"properties": {
"recordId": {
"type": "integer",
"description": "Record Id - [Optional]",
"format": "int64"
}
}
},
"NoNameCardAccount": {
"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
},
"currencyCode": {
"type": "string",
"description": "Currency Code",
"nullable": true
},
"fxAutoConversionFlag": {
"type": "boolean",
"description": "Fx Auto Conversion Flag",
"nullable": true
}
}
},
"NoNameCardPermissions": {
"type": "object",
"properties": {
"eCommercePermitted": {
"type": "boolean",
"description": "E Commerce Permitted - [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": {
"keys": {
"allOf": [
{
"$ref": "#/components/schemas/OperationLimitItemKeys"
}
],
"description": "Keys - [Optional]",
"nullable": true
},
"profileCode": {
"type": "string",
"description": "Profile Code - [Optional]",
"nullable": true
},
"profileDescription": {
"type": "string",
"description": "Profile Description - [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": {
"required": [
"customLimitationChangeFlag"
],
"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
},
"customLimitationChangeFlag": {
"type": "boolean",
"description": "Custom Limitation Change Flag - [Optional]"
}
}
},
"RecreateCustomerCardAccountsRequest": {
"type": "object",
"properties": {
"shadowCardNumber": {
"type": "string",
"description": "Shadow Card Number - [Optional]",
"nullable": true
},
"channel": {
"type": "string",
"description": "Channel - [Optional]",
"nullable": true
},
"cardAccountList": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CardAccount"
},
"description": "Card Account List - [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
}
}
},
"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]"
},
"operationLimitKeys": {
"allOf": [
{
"$ref": "#/components/schemas/RemoveOperationLimitItemKeys"
}
],
"description": "Operation Limit Keys - [Optional]",
"nullable": true
},
"errors": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OperationLimitErrorItem"
},
"description": "Errors - [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"
}
}
},
"ReplaceCardPermissions": {
"type": "object",
"properties": {
"eCommercePermitted": {
"type": "boolean",
"description": "E Commerce Permitted - [Optional]",
"nullable": true
},
"mailOrderPermitted": {
"type": "boolean",
"description": "Mail Order Permitted - [Optional]",
"nullable": true
}
}
},
"ReplaceCardRequest": {
"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
},
"productNumber": {
"type": "string",
"description": "Product Number - [Optional]",
"nullable": true
},
"cardSendAddressId": {
"type": "integer",
"description": "Card Send Address Id - [Optional]",
"format": "int64",
"nullable": true
},
"enrollMasterpass": {
"type": "boolean",
"description": "Enroll Masterpass - [Optional]",
"nullable": true
},
"permissions": {
"allOf": [
{
"$ref": "#/components/schemas/ReplaceCardPermissions"
}
],
"description": "Permissions - [Optional]",
"nullable": true
}
}
},
"ReplaceCardRequestInfo": {
"type": "object",
"properties": {
"deliveryType": {
"type": "string",
"description": "Delivery Type - [Optional]",
"nullable": true
},
"deliveryAddressType": {
"type": "string",
"description": "Delivery Address Type - [Optional]",
"nullable": true
},
"deliveryBranchCode": {
"type": "integer",
"description": "Delivery Branch Code - [Optional]",
"format": "int32",
"nullable": true
},
"embossName": {
"type": "string",
"description": "Emboss Name - [Optional]",
"nullable": true
},
"cardEmbossReason": {
"type": "string",
"description": "Card Emboss Reason - [Optional]",
"nullable": true
},
"cardEmbossSubReason": {
"type": "string",
"description": "Card Emboss Sub Reason - [Optional]",
"nullable": true
},
"productNumber": {
"type": "string",
"description": "Product Number - [Optional]",
"nullable": true
},
"permissions": {
"allOf": [
{
"$ref": "#/components/schemas/ChangeAndReplaceCardPermissions"
}
],
"description": "Permissions - [Optional]",
"nullable": true
},
"cardSendAddressId": {
"type": "integer",
"description": "Card Send Address Id - [Optional]",
"format": "int64",
"nullable": true
}
}
},
"ReplaceCardResponse": {
"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]"
},
"maskedCardNumber": {
"type": "string",
"description": "Masked Card Number - [Optional]",
"nullable": true
},
"cardRefNumber": {
"type": "string",
"description": "Card Ref Number - [Optional]",
"nullable": true
},
"warnings": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "Warnings - [Optional]",
"nullable": true
}
}
},
"ReplaceCardResponseInfo": {
"required": [
"newCardGenerated",
"productChanged",
"expiryDate"
],
"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]"
},
"expiryDate": {
"type": "string",
"description": "Expiry Date - [Optional]",
"format": "date-time"
},
"cardRefNumber": {
"type": "string",
"description": "Card Ref Number - [Optional]",
"nullable": true
},
"maskedCardNumber": {
"type": "string",
"description": "Masked Card Number - [Optional]",
"nullable": true
}
}
},
"ReplaceCardUsingNoNameApplicationRequest": {
"required": [
"customerNumber",
"applicationId"
],
"type": "object",
"properties": {
"barcode": {
"type": "string",
"description": "Barcode - [Optional]",
"nullable": true
},
"customerNumber": {
"type": "integer",
"description": "Customer Number - [Optional]",
"format": "int64"
},
"applicationId": {
"type": "integer",
"description": "Application Id - [Optional]",
"format": "int64"
},
"channel": {
"type": "string",
"description": "Channel - [Optional]",
"nullable": true
}
}
},
"ReplaceCardUsingNoNameApplicationResponse": {
"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
},
"sensitiveCardData": {
"allOf": [
{
"$ref": "#/components/schemas/SensitiveCardData"
}
],
"description": "Sensitive Card Data - [Optional]",
"nullable": true
}
}
},
"ReplaceNoNameCardPermissions": {
"type": "object",
"properties": {
"eCommercePermitted": {
"type": "boolean",
"description": "E Commerce Permitted - [Optional]",
"nullable": true
}
}
},
"ReplaceNoNameCardRequest": {
"type": "object",
"properties": {
"channel": {
"type": "string",
"description": "Channel - [Optional]",
"nullable": true
},
"shadowCardNumber": {
"type": "string",
"description": "Shadow Card Number - [Optional]",
"nullable": true
},
"replaceReasonCode": {
"type": "string",
"description": "Replace Reason Code - [Optional]",
"nullable": true
},
"enrollMasterpass": {
"type": "boolean",
"description": "Enroll Masterpass - [Optional]",
"nullable": true
},
"permissions": {
"allOf": [
{
"$ref": "#/components/schemas/ReplaceNoNameCardPermissions"
}
],
"description": "Permissions - [Optional]",
"nullable": true
}
}
},
"ReplaceNoNameCardResponse": {
"type": "object",
"properties": {
"applicationId": {
"type": "integer",
"description": "Application Id - [Optional]",
"format": "int64",
"nullable": true
},
"shadowCardNumber": {
"type": "string",
"description": "Shadow Card Number - [Optional]",
"nullable": true
},
"newCardGenerated": {
"type": "boolean",
"description": "New Card Generated - [Optional]",
"nullable": true
},
"productChanged": {
"type": "boolean",
"description": "Product Changed - [Optional]",
"nullable": true
},
"maskedCardNumber": {
"type": "string",
"description": "Masked Card Number - [Optional]",
"nullable": true
},
"cardRefNumber": {
"type": "string",
"description": "Card Ref Number - [Optional]",
"nullable": true
}
}
},
"ResetCvvCounterRequest": {
"type": "object",
"properties": {
"channel": {
"type": "string",
"description": "Channel - [Optional]",
"nullable": true
},
"shadowCardNumber": {
"type": "string",
"description": "Shadow Card Number - [Optional]",
"nullable": true
}
}
},
"RewardItem": {
"required": [
"amount"
],
"type": "object",
"properties": {
"amount": {
"type": "number",
"description": "Amount - [Optional]",
"format": "double"
},
"rewardType": {
"type": "string",
"description": "Reward Type - [Optional]",
"nullable": true
}
}
},
"SaveCardAccountCurrencyConversionRequest": {
"required": [
"accountNumber",
"fxAutoConversionFlag"
],
"type": "object",
"properties": {
"channel": {
"type": "string",
"description": "Channel",
"nullable": true
},
"shadowCardNumber": {
"type": "string",
"description": "Shadow Card Number",
"nullable": true
},
"accountNumber": {
"type": "integer",
"description": "Account Number",
"format": "int64"
},
"fxAutoConversionFlag": {
"type": "boolean",
"description": "Fx Auto Conversion Flag"
}
}
},
"SaveCardAccountCurrencyConversionResponse": {
"required": [
"accountNumber",
"fxAutoConversionFlag"
],
"type": "object",
"properties": {
"shadowCardNumber": {
"type": "string",
"description": "Shadow Card Number",
"nullable": true
},
"accountNumber": {
"type": "integer",
"description": "Account Number",
"format": "int64"
},
"fxAutoConversionFlag": {
"type": "boolean",
"description": "Fx Auto Conversion Flag"
}
}
},
"SaveCardBnplPermissionRequest": {
"required": [
"bnplFlag"
],
"type": "object",
"properties": {
"channel": {
"type": "string",
"description": "Channel - [Optional]",
"nullable": true
},
"cardRefNumber": {
"type": "string",
"description": "Card Ref Number - [Optional]",
"nullable": true
},
"bnplFlag": {
"type": "boolean",
"description": "Bnpl Flag - [Optional]"
}
}
},
"SaveCardBnplPermissionResponse": {
"required": [
"bnplFlag"
],
"type": "object",
"properties": {
"cardRefNumber": {
"type": "string",
"description": "Card Ref Number - [Optional]",
"nullable": true
},
"bnplFlag": {
"type": "boolean",
"description": "Bnpl Flag - [Optional]"
}
}
},
"SaveCardPermissionsRequest": {
"type": "object",
"properties": {
"channel": {
"type": "string",
"description": "Channel - [Optional]",
"nullable": true
},
"cardRefNumber": {
"type": "string",
"description": "Card Ref Number - [Optional]",
"nullable": true
},
"shadowCardNumber": {
"type": "string",
"description": "Shadow Card Number - [Optional]",
"nullable": true
},
"permissions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SaveCardPermissionsRequestItem"
},
"description": "Permissions - [Optional]",
"nullable": true
}
}
},
"SaveCardPermissionsRequestItem": {
"type": "object",
"properties": {
"restrictionCode": {
"type": "string",
"description": "Restriction Code - [Optional]",
"nullable": true
},
"permitted": {
"type": "boolean",
"description": "Permitted - [Optional]",
"nullable": true
},
"startDate": {
"type": "string",
"description": "Start Date - [Optional]",
"format": "date-time",
"nullable": true
},
"endDate": {
"type": "string",
"description": "End Date - [Optional]",
"format": "date-time",
"nullable": true
},
"transactionId": {
"type": "string",
"description": "Transaction Id - [Optional]",
"nullable": true
}
}
},
"SaveCardPermissionsResponse": {
"required": [
"changedCount"
],
"type": "object",
"properties": {
"changedCount": {
"type": "integer",
"description": "Changed Count - [Optional]",
"format": "int32"
},
"listOfRecordId": {
"type": "array",
"items": {
"type": "integer",
"format": "int64"
},
"description": "List Of Record Id - [Optional]",
"nullable": true
}
}
},
"SensitiveCardData": {
"type": "object",
"properties": {
"pan": {
"type": "string",
"description": "Pan - [Optional]",
"nullable": true
},
"expiryDateStr": {
"type": "string",
"description": "Expiry Date Str - [Optional]",
"nullable": true
},
"cvv": {
"type": "string",
"description": "Cvv - [Optional]",
"nullable": true
}
}
},
"SensitiveData": {
"type": "object",
"properties": {
"pan": {
"type": "string",
"description": "Pan - [Optional]",
"nullable": true
},
"cvv2": {
"type": "string",
"description": "Cvv2 - [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
}
}
},
"SetCardOperationLimitResponse": {
"type": "object",
"properties": {
"listOfResult": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SetCardOperationLimitResponseItem"
},
"description": "List Of Result - [Optional]",
"nullable": true
}
}
},
"SetCardOperationLimitResponseItem": {
"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
}
}
},
"SetCardPinRequest": {
"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
}
}
},
"SetCardPinResponse": {
"required": [
"success"
],
"type": "object",
"properties": {
"encryptedPin": {
"type": "string",
"description": "Encrypted Pin - [Optional]",
"nullable": true
},
"success": {
"type": "boolean",
"description": "Success - [Optional]"
}
}
},
"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/SetCustomerOperationLimitResponseItem"
},
"description": "List Of Result - [Optional]",
"nullable": true
}
}
},
"SetCustomerOperationLimitResponseItem": {
"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
}
}
},
"SetSecurePinRequest": {
"required": [
"operationDate"
],
"type": "object",
"properties": {
"channel": {
"type": "string",
"description": "Channel - [Optional]",
"nullable": true
},
"shadowCardNumber": {
"type": "string",
"description": "Shadow Card Number - [Optional]",
"nullable": true
},
"ePB": {
"type": "string",
"description": "E P B - [Optional]",
"nullable": true
},
"operationDate": {
"type": "string",
"description": "Operation Date - [Optional]",
"format": "date-time"
}
}
},
"SetSecurePinResponse": {
"required": [
"success"
],
"type": "object",
"properties": {
"encryptedPin": {
"type": "string",
"description": "Encrypted Pin - [Optional]",
"nullable": true
},
"success": {
"type": "boolean",
"description": "Success - [Optional]"
},
"responseCode": {
"type": "integer",
"description": "Response Code - [Optional]",
"format": "int32",
"nullable": true
},
"responseDescription": {
"type": "string",
"description": "Response Description - [Optional]",
"nullable": true
}
}
},
"SubmitCardApplicationExtStatusRequest": {
"required": [
"applicationId"
],
"type": "object",
"properties": {
"channel": {
"type": "string",
"description": "Channel - [Optional]",
"nullable": true
},
"applicationId": {
"type": "integer",
"description": "Application Id - [Optional]",
"format": "int64"
},
"externalStatusCode": {
"type": "string",
"description": "External Status Code - [Optional]",
"nullable": true
}
}
},
"SubmitCardApplicationExtStatusResponse": {
"required": [
"cardApplicationExtStatusHistoryRecordId"
],
"type": "object",
"properties": {
"cardApplicationExtStatusHistoryRecordId": {
"type": "integer",
"description": "Card Application Ext Status History Record Id - [Optional]",
"format": "int64"
}
}
},
"TransferBranchCustomer": {
"required": [
"currentBranchCode",
"targetBranchCode"
],
"type": "object",
"properties": {
"currentBranchCode": {
"type": "integer",
"description": "Current Branch Code - [Optional]",
"format": "int32"
},
"targetBranchCode": {
"type": "integer",
"description": "Target Branch Code - [Optional]",
"format": "int32"
},
"channel": {
"type": "string",
"description": "Channel - [Optional]",
"nullable": true
},
"listOfPersonId": {
"type": "array",
"items": {
"type": "integer",
"format": "int64"
},
"description": "List Of Person Id - [Optional]",
"nullable": true
}
}
},
"TransferBranchCustomerResponse": {
"required": [
"oldBranch",
"newBranch",
"changedCardCount"
],
"type": "object",
"properties": {
"oldBranch": {
"type": "integer",
"description": "Old Branch - [Optional]",
"format": "int32"
},
"newBranch": {
"type": "integer",
"description": "New Branch - [Optional]",
"format": "int32"
},
"changedCardCount": {
"type": "integer",
"description": "Changed Card Count - [Optional]",
"format": "int32"
},
"listOfShadowCardNumbers": {
"type": "array",
"items": {
"type": "string"
},
"description": "List Of Shadow Card Numbers - [Optional]",
"nullable": true
}
}
},
"UpdateNoNameCardApplicationRequest": {
"type": "object",
"properties": {
"channel": {
"type": "string",
"description": "Channel - [Optional]",
"nullable": true
},
"correlationId": {
"type": "string",
"description": "Correlation Id - [Optional]",
"nullable": true
},
"permissions": {
"allOf": [
{
"$ref": "#/components/schemas/NoNameCardPermissions"
}
],
"description": "Permissions - [Optional]",
"nullable": true
},
"listOfAccount": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NoNameCardAccount"
},
"description": "List Of Account - [Optional]",
"nullable": true
}
}
},
"UpdateTransactionForBNPLRequest": {
"type": "object",
"properties": {
"utid": {
"type": "string",
"description": "Utid",
"nullable": true
},
"installmentCount": {
"type": "integer",
"description": "Installment Count",
"format": "int32",
"nullable": true
},
"installmentParameter": {
"type": "string",
"description": "Installment Parameter",
"nullable": true
},
"installmentProfitRate": {
"type": "number",
"description": "Installment Profit Rate",
"format": "double",
"nullable": true
}
}
},
"UpdateTransactionForBNPLResponse": {
"required": [
"isSuccess"
],
"type": "object",
"properties": {
"isSuccess": {
"type": "boolean",
"description": "Is Success"
},
"errorMessage": {
"type": "string",
"description": "Error Message",
"nullable": true
}
}
},
"VerifyCVVPartialRequest": {
"type": "object",
"properties": {
"channel": {
"type": "string",
"description": "Channel - [Optional]",
"nullable": true
},
"shadowCardNumber": {
"type": "string",
"description": "Shadow Card Number - [Optional]",
"nullable": true
},
"digits": {
"type": "array",
"items": {
"$ref": "#/components/schemas/KeyValuePair_2"
},
"description": "Digits - [Optional]",
"nullable": true
}
}
},
"VerifyCVVPartialResponse": {
"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]"
}
}
},
"VerifyCVVRequest": {
"type": "object",
"properties": {
"channel": {
"type": "string",
"description": "Channel - [Optional]",
"nullable": true
},
"shadowCardNumber": {
"type": "string",
"description": "Shadow Card Number - [Optional]",
"nullable": true
},
"verificationValue": {
"type": "string",
"description": "Verification Value - [Optional]",
"nullable": true
}
}
},
"VerifyCVVResponse": {
"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]"
}
}
},
"VerifyCardPinRequest": {
"type": "object",
"properties": {
"channel": {
"type": "string",
"description": "Channel - [Optional]",
"nullable": true
},
"shadowCardNumber": {
"type": "string",
"description": "Shadow Card Number - [Optional]",
"nullable": true
},
"clearCardNumber": {
"type": "string",
"description": "Clear Card Number - [Optional]",
"nullable": true
},
"clearPin": {
"type": "string",
"description": "Clear Pin - [Optional]",
"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]"
}
}
},
"VerifyRsaPinWithStaticSaltRequest": {
"required": [
"operationDate"
],
"type": "object",
"properties": {
"channel": {
"type": "string",
"description": "Channel - [Optional]",
"nullable": true
},
"shadowCardNumber": {
"type": "string",
"description": "Shadow Card Number - [Optional]",
"nullable": true
},
"ePB": {
"type": "string",
"description": "E P B - [Optional]",
"nullable": true
},
"operationDate": {
"type": "string",
"description": "Operation Date - [Optional]",
"format": "date-time"
},
"staticSalt": {
"type": "string",
"description": "Static Salt - [Optional]",
"nullable": true
}
}
},
"VerifyRsaPinWithStaticSaltResponse": {
"required": [
"verified",
"lastTryCount",
"tryCountExceed",
"responseCode"
],
"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]"
},
"responseCode": {
"type": "integer",
"description": "Response Code - [Optional]",
"format": "int32"
},
"responseDescription": {
"type": "string",
"description": "Response Description - [Optional]",
"nullable": true
}
}
},
"VerifySecurePinRequest": {
"required": [
"operationDate"
],
"type": "object",
"properties": {
"channel": {
"type": "string",
"description": "Channel - [Optional]",
"nullable": true
},
"shadowCardNumber": {
"type": "string",
"description": "Shadow Card Number - [Optional]",
"nullable": true
},
"ePB": {
"type": "string",
"description": "E P B - [Optional]",
"nullable": true
},
"operationDate": {
"type": "string",
"description": "Operation Date - [Optional]",
"format": "date-time"
}
}
},
"VerifySecurePinResponse": {
"required": [
"verified",
"lastTryCount",
"tryCountExceed",
"responseCode"
],
"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]"
},
"responseCode": {
"type": "integer",
"description": "Response Code - [Optional]",
"format": "int32"
},
"responseDescription": {
"type": "string",
"description": "Response Description - [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 applications",
"description": "Track a card application from submission to the card being produced."
},
{
"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": "No-name cards",
"description": "Issue and activate pre-produced cards that carry no embossed name, then bind one to a customer at the point of sale."
},
{
"name": "Branch management",
"description": "Move a customer or a card between branches, and read the cards a branch holds."
},
{
"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": "PIN and card security",
"description": "Set and change a PIN, manage the try counter, and generate or verify the card verification values."
},
{
"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 applications",
"Card issuance and personalisation",
"Card lifecycle",
"No-name cards"
]
},
{
"name": "Customers and accounts",
"tags": [
"Branch management",
"Customers",
"Account linking"
]
},
{
"name": "Transactions",
"tags": [
"Transactions"
]
},
{
"name": "Limits and controls",
"tags": [
"Card and customer limits",
"Operation limits",
"Permissions and restrictions"
]
},
{
"name": "Security",
"tags": [
"PIN and card security"
]
},
{
"name": "Platform",
"tags": [
"Platform operations",
"Reference data"
]
}
]
}