Mastercard Cards API

openapi: 3.2.0
info:
  title: Mastercard Card Issuance Cards API
  description: Card Issuance APIs enable clients to open new card accounts from anywhere and at any time, as per their convenience. MI Issuing supports the issuance of primary, supplementary, and add-on cards in digital and physical modes.
  contact:
    name: API Support
    url: https://developer.mastercard.com/support
    email: apisupport@mastercard.com
  version: 2.0.0
servers:
- description: Sandbox server
  url: https://sandbox.mi.api.mastercard.com/mi-issuing-sandbox/card-issuance/
- description: MEA MTF/UAT server
  url: https://mtf.mea.api.mastercard.com/mi-issuing/card-issuance/
- description: SA MTF/UAT server
  url: https://mtf.sa.api.mi.mastercard.com/mi-issuing/card-issuance/
- description: MEA Production server
  url: https://mea.api.mastercard.com/mi-issuing/card-issuance/
- description: SA Production server
  url: https://sa.api.mi.mastercard.com/mi-issuing/card-issuance/
tags:
- name: Cards
paths:
  /prepaid-cards:
    post:
      tags:
      - Cards
      summary: Mastercard **prepaid Card Issuance** - Issue Prepaid Card to Existing or New Client
      description: 'This API allows users to issue primary, add-on or supplementary physical/virtual card to existing or new client. It is applicable for prepaid products issued on MI platform. The Mastercard issuing system receives, validates, and processes the request. If the request is successful, the card will be generated, and card details like ''card number'', ''card Id'', ''card pack Id'', etc. will be sent in the response. <BR/> Note: More than one card information in the response indicates issuance of paired cards.'
      operationId: createPrepaidCard
      x-mastercard-api-encrypted: true
      parameters:
      - $ref: '#/components/parameters/BankCode'
      - $ref: '#/components/parameters/CorrelationID'
      - $ref: '#/components/parameters/Source'
      - $ref: '#/components/parameters/EndUserID'
      - $ref: '#/components/parameters/IdempotencyKey'
      requestBody:
        $ref: '#/components/requestBodies/PrepaidCardApplicationRequest'
      responses:
        '201':
          $ref: '#/components/responses/PrepaidCardProfileResponse'
        '400':
          $ref: '#/components/responses/BadPostRequestError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '403':
          $ref: '#/components/responses/ForbiddenError'
        '409':
          $ref: '#/components/responses/ConflictError'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /debit-cards:
    post:
      tags:
      - Cards
      summary: Mastercard **debit Card Issuance** - Issue Debit Card to Existing or New Client
      description: 'This API allows users to issue primary, add-on or supplementary debit card to existing/new client with the help of CBS system. The Mastercard issuing system receives, validates, and send the request to CBS for fulfilment. If the request is successful, then card will be generated, and card details like ''card number'', ''card Id'', ''card pack Id'', etc. will be sent in the response. <BR/> Note: More than one card information in the response indicates issuance of paired cards.'
      operationId: createDebitCard
      x-mastercard-api-encrypted: true
      parameters:
      - $ref: '#/components/parameters/BankCode'
      - $ref: '#/components/parameters/CorrelationID'
      - $ref: '#/components/parameters/Source'
      - $ref: '#/components/parameters/EndUserID'
      - $ref: '#/components/parameters/IdempotencyKey'
      requestBody:
        $ref: '#/components/requestBodies/DebitCardApplicationRequest'
      responses:
        '201':
          $ref: '#/components/responses/DebitCardProfileResponse'
        '400':
          $ref: '#/components/responses/BadPostRequestError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '403':
          $ref: '#/components/responses/ForbiddenError'
        '409':
          $ref: '#/components/responses/ConflictError'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
components:
  schemas:
    ConditionalPictureCode:
      type: string
      description: Picture Code. <BR/> **Conditional Mandatory**<font color='red'>* </font> field - Required while applying 'Picture Card' card for new primary client, if not configured at device plan level.
      minLength: 1
      maxLength: 16
      pattern: '[A-Z0-9](([_])?[A-Z0-9])+'
      example: FSFS_3122_13XV
    AccountNumber:
      type: string
      description: Account number linked to the card.
      minLength: 9
      maxLength: 24
      pattern: '[0-9]+'
      example: '2207131581270233863'
    NewCard:
      type: object
      required:
      - type
      - photoIndicator
      properties:
        numberless:
          type: boolean
          description: Indicates whether number should be printed on the physical card or not. <BR/> Not applicable while issuing existing non-personalized card.
          example: false
        instant:
          type: boolean
          description: Indicates whether instant card is required be generated or not. <BR/> It will be always considered as true in case of SVC/LVC card issuance irrespective of input value. <BR/>Not applicable while issuing existing non-personalized card.
          example: false
        embossedName:
          $ref: '#/components/schemas/EmbossedName'
        photoIndicator:
          $ref: '#/components/schemas/PhotoIndicator'
        photoCode:
          $ref: '#/components/schemas/ConditionalPhotoCode'
        pictureCode:
          $ref: '#/components/schemas/ConditionalPictureCode'
        deliveryMode:
          $ref: '#/components/schemas/DeliveryMode'
        deliveryDate:
          type: string
          format: date
          description: Date on which card is delivered or handed over to client. <br/> Format - It is expressed in ISO 8601 - `YYYY-MM-DD`
          example: '2022-01-26'
    LvcExpiryDateTime:
      type: string
      format: date-time
      description: Applicable only for 'LVC' card. The date/time after which the 'LVC' card should be considered as expired or invalid.<br/> <br/> The 'expiry' and 'expiry Date Time' fields are mutually exclusive. <br/>Expressed in ISO 8601 extended format. Must be <br/> YYYY-MM-DDThh:mm:ss[.sss](+|-)hh:mm where [.sss] is optional and can be 1 to 3 digits.
      minLength: 20
      maxLength: 29
      example: '2022-07-04T12:09:56.450-07:00'
    Person:
      allOf:
      - $ref: '#/components/schemas/BasePerson'
      type: object
      properties:
        kyc:
          $ref: '#/components/schemas/Kyc'
        sourceSystem:
          $ref: '#/components/schemas/SourceSystemClientMapping'
    CurrentAddress:
      allOf:
      - $ref: '#/components/schemas/Address'
      type: object
      properties:
        lodgingMode:
          $ref: '#/components/schemas/LodgingMode'
    NewApplication:
      type: object
      required:
      - type
      properties:
        formNumber:
          type: string
          description: Echo back the input application form number.
          minLength: 1
          maxLength: 10
          example: FRM0900029
        number:
          type: string
          description: System generated unique application number while on-boarding the client.
          maxLength: 12
          example: '200460102961'
    ErrorsInfo:
      required:
      - Errors
      type: object
      properties:
        Errors:
          $ref: '#/components/schemas/Errors'
    DebitClient:
      allOf:
      - $ref: '#/components/schemas/CbsCustomer'
      type: object
      properties:
        type:
          $ref: '#/components/schemas/ClientType'
        vip:
          type: boolean
          description: Indicates whether client is VIP person. false (Default) indicates Normal client and true indicates VIP client. <BR/> This field is required if configured as **Business Mandatory**<font color='red'>* </font>.
          default: false
          example: false
        riskCategory:
          $ref: '#/components/schemas/RiskCategory'
        cobrandNumber:
          $ref: '#/components/schemas/CobrandNumber'
    CbsCustomer:
      allOf:
      - $ref: '#/components/schemas/BasePerson'
      type: object
      properties:
        kyc:
          $ref: '#/components/schemas/Kyc'
    PhoneNumber2:
      type: string
      description: Single or Multiple or Range of contact numbers. for example, 8120556678/68/58. <BR/> This field is required if configured as **Business Mandatory**<font color='red'>* </font>.
      minLength: 4
      maxLength: 15
      pattern: ([0-9]+([0-9 -/ \\[\\]])*[0-9]+)*
      example: 04025870466/99
    DebitApplication:
      type: object
      description: Contains information about different types of debit cards
      required:
      - type
      properties:
        type:
          $ref: '#/components/schemas/OnboardingApplicationType'
    EducationQualification:
      type: string
      description: 'Educational Qualification. <br/> This field is required if configured as **Business Mandatory**<font color=''red''>* </font>. <br/> Valid values are configured on ''Card Management > Institution Parameter Setup > System Codes [ISSS15]''     screen for ''Type Id=EDUCATION''. <br/> **Few sample values: **  `SSC`, `HSC`, `Under Graduate`, `Graduate`, `Post Graduate`, `Professional`, `Others`, `PHD`, `Diploma`'
      example: Graduate
    FreshDebitCard:
      allOf:
      - $ref: '#/components/schemas/FreshCard'
      description: Debit Card Details. <BR/>card number or card id or card packId must exist while issuing existing non personalized card.
      type: object
      properties:
        nonPersonalized:
          type: boolean
          description: Indicates whether existing non-personalized card is being issued.
          example: false
        number:
          $ref: '#/components/schemas/CardNumber'
        id:
          $ref: '#/components/schemas/CardId'
        packId:
          $ref: '#/components/schemas/CardPackId'
    PrepaidCardApplication:
      allOf:
      - $ref: '#/components/schemas/BaseNewCardDetails'
      type: object
      properties:
        travel:
          $ref: '#/components/schemas/TravelDetails'
        initialLoad:
          $ref: '#/components/schemas/InitialLoad'
    EncodedName:
      type: string
      description: Applicable only for Physical Card. Encoded name of the client. The value can contain space. For example, John Smith. <BR/> This field is required if configured as **Business Mandatory**<font color='red'>* </font>.
      minLength: 1
      maxLength: 26
      pattern: '[^ ][^%<>\\[\\]^$]+[^ ]'
      example: JOHN SMITH
    ProgramCode:
      type: string
      description: Program code of a card
      minLength: 1
      maxLength: 10
      pattern: '[A-Z0-9](([_])?[A-Z0-9])+'
      example: LOANPR
    CardType:
      type: string
      description: 'The type indicates the card category. <br/> **Valid values: **

        * `EMV_CARD`

        * `MAGNETIC_STRIPE_CARD`

        * `STATIC_VIRTUAL_CARD`

        * `LIMITED_VALIDITY_VIRTUAL_CARD`

        * `NFC_PAYPASS`

        * `NFC_EMV_PAYPASS`

        * `NFC_MAG_STRIPE_PAYPASS`

        * `MOBILE`

        * `NFC_PAYWAVE`

        * `NFC_EMV_PAYWAVE`

        * `NFC_MAG_STRIPE_PAYWAVE`

        * `ATM_ADMIN_CARD`

        * `EXPRESSPAY_MAG_STRIPE`

        * `EXPRESSPAY_EMV`

        * `RUPAY_NFC_EMV`'
      example: EMV_CARD
    ProfessionType:
      type: string
      description: Profession Type. <BR/>This field is required if configured as **Business Mandatory**<font color='red'>* </font>. <br/> Valid values are configured on 'Card Management > Institution Parameter Setup > System Codes [ISSS15]'     screen for "Type Id=APPLICANT_PROF". <br/> **Few sample values :** `Architect`, `CA`, `Consultant`, `Doctor`, `Lawyer`, `Others`, `Proprietorship`, `Partnership`, `Pvt Ltd Co.`, `HUF`, `Manufacturer`, `Export/ Importer`, `Trader/Stockist`, `Retailer`, `Service Provider`, `Consultant Professional`, `Professional`, `Education`, `Bank/Financial Services`, `Agriculture`, `Salesman`, `Barangay Official`
      example: Others
    Address:
      type: object
      properties:
        line1:
          type: string
          description: Address line 1. If the any of the address line value is present but line 1 value is absent then blank value will be considered. <BR/> **Conditional Mandatory**<font color='red'>* </font> field - <BR/> Current Address line1 is required while creating new client. <BR/> Office or Permanent Address line1 is required if selected as preferred Mailing Address.
          minLength: 1
          maxLength: 150
          pattern: (([a-zA-Z0-9])+([\ .,&#:*()-])*)+
          example: House no. 45, second floor
        line2:
          type: string
          description: Address line 2. If the any of the address line value is present but line 2 value is absent then blank value will be considered. <BR/> This field is required if configured as **Business Mandatory**<font color='red'>* </font>.
          minLength: 1
          maxLength: 150
          pattern: (([a-zA-Z0-9])+([\ .,&#:*()-])*)+
          example: Apartment no. 567, Pashan
        line3:
          type: string
          description: Address line 3. If the any of the address line value is present but line 3 value is absent then blank value will be considered. <BR/> This field is required if configured as **Business Mandatory**<font color='red'>* </font>.
          minLength: 1
          maxLength: 150
          pattern: (([a-zA-Z0-9])+([\ .,&#:*()-])*)+
          example: Pashan Sus Road
        line4:
          type: string
          description: Address line 4. If the any of the address line value is present but line 4 value is absent then blank value will be considered. <BR/> This field is required if configured as **Business Mandatory**<font color='red'>* </font>.
          minLength: 1
          maxLength: 150
          pattern: (([a-zA-Z0-9])+([\ .,&#:*()-])*)+
          example: Near NIV Office
        city:
          type: string
          description: City (free text). <BR/> This field will be ignored and populated internally if given country is same as institution country, and city is configured to be auto populated in Card Management > Institution Parameter Setup by selecting the option 'Validate Domestic Postal Code [Y]' or 'Do Not Validate Domestic Postal Code-Auto populate [D]'.
          minLength: 1
          maxLength: 50
          pattern: '[^ ][a-zA-Z0-9 ]+[^ ]'
          example: PUN
        state:
          type: string
          description: 'State. <BR/> This field is required if configured as **Business Mandatory**<font color=''red''>* </font>

            * If zip flag is configured at Institution level by selecting the ''Domestic Postal Code Mandatory'' check box, then the state code must be present in the request, as per the state master configured in the system.

            * Otherwise, if the zip flag is not configured at institution level, then regardless of the applicant''s state code, this field is a free text.

            * This field will be ignored and populated internally if given country is same as institution country,     and state is configured to be auto populated in ''Card Management > Institution Parameter Setup''     by selecting the option ''Validate Domestic Postal Code [Y]'' or ''Do Not Validate Domestic Postal Code-Auto populate [D]''.'
          minLength: 1
          maxLength: 50
          pattern: '[^ ]+([a-zA-Z0-9 ]+[^ ]+)*'
          example: MH
        country:
          description: 'Country Code. Expressed as a 2-letter (Alpha-2) country code as defined in ISO 3166. <BR/> **Conditional Mandatory**<font color=''red''>* </font> field - <BR/>

            * Current Address country is required while creating new client. <BR/>

            * Office or Permanent Address country is required if selected as preferred Mailing Address.'
          type: string
          minLength: 2
          maxLength: 2
          pattern: '[A-Z]+'
          example: IN
        zipCode:
          type: string
          description: 'Zip Code. <BR/> **Conditional Mandatory**<font color=''red''>* </font> field - <BR/>

            * Required if given country is same as ''institution country'', and ''zip code'' is configured as mandatory     in ''Card Management > Institution Parameter Setup'' by selecting the ''Validate Domestic Postal Code [Y]''. <BR/>

            * Office or ''permanent address zip code'' is required if selected as preferred ''mailing address''.'
          minLength: 1
          maxLength: 10
          pattern: '[^ ][a-zA-Z0-9 ]+[^ ]'
          example: '411021'
    CustomField:
      type: object
      properties:
        name:
          type: string
          description: 'Custom field name like: `clientDateField1`, `clientDataField1`, `clientNumberField1`, `cardDateField1`, `cardDataField1`, `cardNumberField1`, `accountDateField1`, `accountDataField1`, `accountNumberField1`. <BR/> Only 5 fields of each type are supported like clientDateField2, clientDateField3, clientDateField4, clientDateField5. <BR/> This field is required if configured as **Business Mandatory**<font color=''red''>* </font>.'
          pattern: ((client|account|card)(Date|Data|Number)Field[1-5]?)
          example: clientDateField1
        value:
          type: string
          description: 'Custom field value.

            * In case of date value, it must be expressed in ISO 8601 format - YYYY-MM-DD. For example, 2022-01-16

            * In case of data, it could be a free text that may contain alphanumeric letters or special characters mentioned in the pattern field.

            * In case of number value, it is recommended to provide a number having maximum 12 digits before decimal and up to 5 digits after decimal. For example: 999999999999.99999'
          minLength: 1
          maxLength: 100
          pattern: '[a-zA-Z0-9 ,&.''-]+'
          example: '2022-01-16'
    RegisteredContacts:
      type: object
      properties:
        email:
          $ref: '#/components/schemas/Email'
        mobile:
          $ref: '#/components/schemas/Mobile'
        fax:
          type: string
          description: Fax Number. <BR/> This field is required if configured as **Business Mandatory**<font color='red'>* </font>.
          pattern: '[+]?[/A-Za-z0-9-]+'
          minLength: 1
          maxLength: 80
          example: +42342/453-5
    OccupationType:
      type: string
      description: Occupation type of the employee. <BR/>This field is required if configured as **Business Mandatory**<font color='red'>* </font>. <br/> Valid values are configured on 'Card Management > Institution Parameter Setup > System Codes [ISSS15]'     screen for 'Type Id=OCCUPATION'. <br/> **Few sample values :** `Service`, `Professional`, `Business`, `Retired`, `Household`, `Student`, `Others`
      example: Service
    Occupation:
      type: object
      properties:
        employerName:
          type: string
          description: Employer Name. <BR/>This field is required if configured as **Business Mandatory**<font color='red'>* </font>.
          minLength: 1
          maxLength: 40
          pattern: '[a-zA-Z0-9]+'
          example: Mastercard
        employerType:
          $ref: '#/components/schemas/EmployerType'
        department:
          type: string
          description: Department of client. <BR/>This field is required if configured as **Business Mandatory**<font color='red'>* </font>.
          minLength: 1
          maxLength: 50
          pattern: '[a-zA-Z0-9.&_''"]+'
          example: IT
        employeeId:
          type: string
          description: Employee ID of client. <BR/>This field is required if configured as **Business Mandatory**<font color='red'>* </font>.
          minLength: 1
          maxLength: 20
          pattern: '[a-zA-Z0-9]+'
          example: E03982
        type:
          $ref: '#/components/schemas/OccupationType'
        professionType:
          $ref: '#/components/schemas/ProfessionType'
        designation:
          $ref: '#/components/schemas/Designation'
        employmentStatus:
          $ref: '#/components/schemas/EmploymentStatus'
        joiningDate:
          type: string
          format: date
          description: Joining date of current job. <BR/>This field is required if configured as **Business Mandatory**<font color='red'>* </font>. <br/> Format - It is expressed in ISO 8601 - `YYYY-MM-DD`
          example: '2010-01-19'
        employmentDuration:
          type: integer
          format: int32
          minimum: 0
          maximum: 99
          description: Duration (in years) of employment with current employer. <BR/>This field is required if configured as **Business Mandatory**<font color='red'>* </font>.
          example: 2
        netAnnualIncome:
          type: integer
          format: int64
          minimum: 0
          maximum: 999999999999
          description: Annual income of client. <BR/>This field is required if configured as **Business Mandatory**<font color='red'>* </font>.
          example: 100000
    PhotoIndicator:
      type: string
      description: 'Indicates whether picture or photo should be printed on the card or default template to be applied. <br/> In case of LVC card request, valid value is only `NORMAL`. <br/> **Valid values: **

        * `NORMAL` - Normal card

        * `PHOTO` - Photo card

        * `PICTURE` - Picture card'
      example: PICTURE
    EmbossedName:
      type: string
      description: Embossed name of the client. <br/> **Conditional Mandatory**<font color='red'>* </font> field - Required while creating new client.
      minLength: 2
      maxLength: 26
      pattern: ([^ ])(?!.*[-]{2})([a-zA-Z.' ]+)([^ ])
      example: JOHN SMITH
    DebitCardProfile:
      type: object
      properties:
        branchCode:
          type: string
          description: Echo back the branchCode.
          example: '0316'
        client:
          $ref: '#/components/schemas/NewClient'
        cards:
          type: array
          description: List of cards.
          items:
            $ref: '#/components/schemas/NewCardDetails'
          example: []
        accounts:
          type: array
          description: List of accounts linked to the card returned
          items:
            $ref: '#/components/schemas/BaseAccount'
          example: []
    CbsAccountType:
      type: string
      description: 'Bank ISO Account Type in CBS. <br/> **Conditional Mandatory**<font color=''red''>* </font> field - Required while linking new debit account. Possible values configured in CSR portal on "Card Management > Institution Parameter Setup >  Account Type [ISSS12]" screen. CBS Host account type must be configured to match with ISO account types like 10, 20. <br/> **Possible values:** <br/>

        * `DEFAULT` - Default Account

        * `SAVINGS` - Savings Account

        * `CHECKING` - Checking or Current Account

        * `CREDIT_CARD` - Credit Card Account

        * `CREDIT_LINE` - Credit Line Account

        * `CORPORATE` - Corporate Account

        * `UNIVERSAL` - Universal Account

        * `MONEY_MARKET_INVESTMENT` - Money Market Investment Account

        * `IRA_INVESTMENT` - Ira Investment Account

        * `STORED_VALUE` - Stored Value Account

        * `REVOLVING_LOAN` - Revolving Loan Account

        * `INSTALLMENT_LOAN` - Installment Loan Account

        * `REAL_ESTATE_LOAN` - Real Estate Loan Account'
      example: SAVINGS
    BaseNewCardDetails:
      allOf:
      - $ref: '#/components/schemas/RequestValidityTime'
      type: object
      required:
      - dataValidUntilTimestamp
      properties:
        application:
          $ref: '#/components/schemas/Application'
        branchCode:
          type: string
          description: 'Branch Code. <BR/> **Conditional Mandatory**<font color=''red''>* </font> field - Required for **Primary** card issuance to new client. <BR> <BR/> For the following application types, if the value is sent, then the branch code is changed for the client initiating the request along with the associated Primary, Supplementary and Add-On cards.: <BR/>

            * Primary Card - Existing Client (New Program) <BR/>

            * Supplementary Card - Existing Program <BR/> For the following application types, the value in the field should be empty or same as Primary client''s branch code. If the branch code is received and does not match with Primary client''s branch code, then the request is rejected: <BR/>

            * Add On for new Client <BR/>

            * Supplementary Existing Program for Corporate Card'
          minLength: 1
          maxLength: 6
          pattern: '[0-9]+'
          example: '0316'
        primary:
          $ref: '#/components/schemas/PrimaryCard'
        addOn:
          $ref: '#/components/schemas/AddOnClient'
        client:
          $ref: '#/components/schemas/Client'
        card:
          $ref: '#/components/schemas/FreshCard'
        account:
          $ref: '#/components/schemas/AccountPromoPlanCodes'
        customFields:
          $ref: '#/components/schemas/CustomFields'
    Errors:
      required:
      - Error
      type: object
      properties:
        Error:
          type: array
          description: Errors array wrapped in an error object
          items:
            $ref: '#/components/schemas/ErrorMessage'
          example: []
    EmploymentStatus:
      type: string
      description: Status of Employment. <BR/>This field is required if configured as **Business Mandatory**<font color='red'>* </font>. <br/> Valid values are configured on 'Card Management > Institution Parameter Setup > System Codes [ISSS15]'     screen for 'Type Id=EMPLOYMENT_STATUS'. <br/> **Few sample values :** `OTHER`, `PERMANENT`, `CONTRACTUAL`, `SELF EMPLOYED`, `RETIRED`, `HOME MAKER`, `STUDENT`, `BUSINESS`, `SALARIED`
      example: PERMANENT
    AlternateName:
      type: string
      description: Alternate name of the client.
      minLength: 1
      maxLength: 200
      pattern: '[^ ][^%<>\\[\\]^$]+[^ ]'
      example: Johny Smith
    ConditionalCardId:
      type: string
      description: Unique value to identify a card. <BR/> **Conditional Mandatory**<font color='red'>* </font> field - Primary clientCode or cardNumber or cardId must be present in the request while requesting card for existing primary client or new add-on client. Primary cardNumber or cardId must be present in the request while requesting 'ADD_ON' or 'SUPPLEMENTARY' card.
      minLength: 32
      maxLength: 32
      pattern: '[A-Z0-9]+'
      example: C24B56D71AA2E015E053F482A80ABD00
    BaseSearchCard:
      description: Base Search Card
      type: object
      properties:
        number:
          $ref: '#/components/schemas/CardNumber'
        id:
          $ref: '#/components/schemas/CardId'
        packId:
          $ref: '#/components/schemas/CardPackId'
        alias:
          $ref: '#/components/schemas/CardAlias'
        programCode:
          $ref: '#/components/schemas/ProgramCode'
        planCode:
          $ref: '#/components/schemas/CardPlanCode'
    ConditionalProgramCode:
      type: string
      description: Program code of a card. <BR/> **Conditional Mandatory**<font color='red'>* </font> field - Required while requesting for `PRIMARY` card.
      minLength: 1
      maxLength: 10
      pattern: '[A-Z0-9](([_])?[A-Z0-9])+'
      example: LOANPR
    CardRelationship:
      type: string
      example: PRIMARY
      description: 'An indicator at card level to describe type of client associated with the card. <br/> **Valid values: **

        * `PRIMARY` - Indicates primary card

        * `ADD_ON` - Indicates add-on card

        * `SUPPLEMENTARY` - Indicates supplementary card'
    Cvv:
      type: string
      description: Card verification value (CVV), card security code (CSC), card verification code (CVC), or card code verification (CCV) found on the back of a card that provides an additional measure of card security.
      minLength: 3
      maxLength: 5
      pattern: '[0-9]+'
      example: '345'
    LVCCard:
      description: LVC Card information
      type: object
      properties:
        perTransactionLimit:
          type: string
          description: It is the limit set for each transaction. <BR/> **Conditional Mandatory**<font color='red'>* </font> field - Required while requesting for LVC card.
          minLength: 1
          maxLength: 12
          pattern: '[0-9]+'
          example: '100000'
        totalTransactionLimit:
          type: string
          description: It is the maximum transaction limit configured for the client. <BR/> **Conditional Mandatory**<font color='red'>* </font> field - Required while requesting for LVC card.
          minLength: 1
          maxLength: 20
          pattern: '[0-9]+'
          example: '10000000'
        velocity:
          type: string
          description: Number of times the card can be used in a configured duration. <BR/> **Conditional Mandatory**<font color='red'>* </font> field - Required while requesting for LVC card.
          minLength: 1
          maxLength: 20
          pattern: '[0-9]+'
          example: '100000000'
        validity:
          type: string
          description: 'Card validity duration after which the card gets expired. <BR/> **Conditional Mandatory**<font color=''red''>* </font> field - Required while requesting for LVC card. <BR/> Must be expressed in ISO 8601 Durations format: <BR/> Format - P(n)Y(n)M(n)DT(n)H(n)M(n)S <BR/> <BR/> Where: <BR/>

            * (n) is replaced by the value for each of the date and time elements that follow the (n). <BR/>

            * P is the duration designator (referred to as "period"), and is always placed at the beginning of the duration. <BR/>

            * Y is the year designator that follows the value for the number of years. <BR/>

            * M is the month designator that follows the value for the number of months. <BR/>

            * W is the week designator that follows the value for the number of weeks. <BR/>

            * D is the day designator that follows the value for the number of days. <BR/>

            * T is the time designator that precedes the time components. <BR/>

            * H is the hour designator that follows the value for the number of hours. <BR/>

            * M is the minute designator that follows the value for the number of minutes. <BR/> * S is the second designator that follows the value for the number of seconds. <BR/> Maximum validity period: 3 Years'
          minLength: 3
          maxLength: 19
          pattern: ^P(?!$)([0-9]+Y)?([0-9]+M)?([0-9]+W)?([0-9]+D)?(T(?=[0-9])([0-9]+H)?([0-9]+M)?([0-9]+S)?)?$
          example: P3M4DT12H30M5S
    AccountPromoPlanCodes:
      type: object
      properties:
        promoPlanCodes:
          type: array
          minItems: 0
          maxItems: 3
          items:
            type: string
            minLength: 1
            maxLength: 10
            pattern: ^[A-Z0-9](([_])?[A-Z0-9])+$
            description: Promo plans to be assigned to the account. If provided, the value should be present in Account Promotion plan configuration in CSR portal. <BR/> Maximum number of promo plans should not exceed total number of account plans attached to the program (linked to this card) in CSR portal. <BR/> If the value of promo plan code is empty then promo plan will not be attached to the respective account plan.
            example: LOANPR
          example:
          - LOANPR
          - ''
          - LOANB
    ClientSearchInfo:
      type: object
      properties:
        code:
          $ref: '#/components/schemas/ClientCode'
        mobile:
          $ref: '#/components/schemas/Mobile'
    LodgingMode:
      type: string
      description: 'Lodging Mode. <br/> Valid values are configured on ''Card Management > Institution Parameter Setup > System Codes [ISSS15]''     screen for ''Type Id=RESIDENCE_STATUS''. <br/> **Few sample values: **  `Not reported`, `Financed`, `Owned`, `Rented`, `Company leased`, `PG`, `Office`, `Parental`'
      example: Owned
    ConditionalCardAlias:
      type: string
      description: Alias to be assigned to the newly issued card. <BR/> **Conditional Mandatory**<font color='red'>* </font> field - Required if the CNA functionality is turned on for the institution. <BR/> OR <BR/> <BR/> This field is required if configured as **Business Mandatory**<font color='red'>* </font>.
      pattern: '[A-Za-z0-9_!''()*+,-.]+'
      minLength: 1
      maxLength: 24
      example: '9055544422'

# --- truncated at 32 KB (80 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/mastercard/refs/heads/main/openapi/mastercard-cards-api-openapi.yml