Mastercard Debit API

swagger: '2.0'
info:
  title: Mastercard Bill Payment Validator Account Opening Debit API
  description: This service is provided on behalf of the Mastercard Remote Payment and Presentment (RPPS) Bill Payment Processing Network, which supports consumer to business "push" bill payments (i.e. those which are not funded by debit/credit card transactions) in the U.S.
  version: '1.0'
  x-artifactId: billpay-api
  contact:
    name: Bill Pay Development Support
    email: Bill_Pay_Development_Support@mastercard.com
host: sandbox.api.mastercard.com
basePath: /billpayAPI/v1
schemes:
- https
consumes:
- application/json
produces:
- application/json
tags:
- name: Debit
paths:
  /debit-cards:
    post:
      tags:
      - Debit
      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:
  responses:
    UnauthorizedError:
      description: Authentication information is missing or invalid.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorsInfo'
          examples:
            UnauthorizedExample:
              $ref: '#/components/examples/UnauthorizedExample'
      headers:
        X-MC-Correlation-ID:
          $ref: '#/components/headers/Response-Correlation-ID'
    BadPostRequestError:
      description: The request failed due to invalid or missing value. The value could be a header value, a query parameter value, or a request body property value.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorsInfo'
          examples:
            MissingRequiredFieldExample:
              $ref: '#/components/examples/MissingRequiredFieldExample'
            InvalidFieldValueExample:
              $ref: '#/components/examples/InvalidFieldValueExample'
            InvalidFieldFormatExample:
              $ref: '#/components/examples/InvalidFieldFormatExample'
            InvalidFieldLengthExample:
              $ref: '#/components/examples/InvalidFieldLengthExample'
            CryptographyErrorExample:
              $ref: '#/components/examples/CryptographyErrorExample'
      headers:
        X-MC-Correlation-ID:
          $ref: '#/components/headers/Response-Correlation-ID'
    ForbiddenError:
      description: Insufficient permissions for interacting with the resource.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorsInfo'
          examples:
            ForbiddenExample:
              $ref: '#/components/examples/ForbiddenExample'
      headers:
        X-MC-Correlation-ID:
          $ref: '#/components/headers/Response-Correlation-ID'
    ConflictError:
      description: A conflict happened when creating or updating the resource.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorsInfo'
          examples:
            ConflictExample:
              $ref: '#/components/examples/ConflictExample'
      headers:
        X-MC-Correlation-ID:
          $ref: '#/components/headers/Response-Correlation-ID'
    DebitCardProfileResponse:
      description: The debit card was successfully created/issued.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/DebitCardProfile'
      headers:
        X-MC-Correlation-ID:
          $ref: '#/components/headers/Response-Correlation-ID'
        X-MC-Idempotency-Key:
          $ref: '#/components/headers/Response-Idempotency-Key'
        X-MC-Original-Request-Correlation-ID:
          $ref: '#/components/headers/Response-Original-Correlation-ID'
  schemas:
    CbsCustomer:
      allOf:
      - $ref: '#/components/schemas/BasePerson'
      type: object
      properties:
        kyc:
          $ref: '#/components/schemas/Kyc'
    MaritalStatus:
      type: string
      description: 'Indicates Marital Status of the client. <br/> <br/> **Conditional Mandatory**<font color=''red''>* </font> field - Required while creating new client. <br/> Valid values are configured on ''Card Management > Institution Parameter Setup > System Codes [ISSS15]''     screen for ''Type Id=MARITAL_STATUS''. <br/> **Few sample values: **  `Single`, `Married`, `Divorcee`, `Widow/Widower`'
      example: Married
    DeliveryMode:
      type: string
      description: Client's preferred delivery mode. Application request with instant card true, delivery mode should be `Branch`. <br/> Valid values are configured on "Card Management > Institution Parameter Setup > System Codes [ISSS15]" screen for "Type Id=DELIVERY_MODE". <br/> **Few sample values:** `Branch`, `Payment system department`, `Mail`
      example: Branch
    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'
    NewCardDetails:
      allOf:
      - $ref: '#/components/schemas/BaseCardWithSecrets'
      type: object
      properties:
        embossedName:
          $ref: '#/components/schemas/EmbossedName'
    PermanentAddress:
      allOf:
      - $ref: '#/components/schemas/Address'
      type: object
      properties:
        permanentAddressFrom:
          type: string
          format: date
          description: Date since when the referenced address is defined as the permanent address.  <br/> Format - It is expressed in ISO 8601 - `YYYY-MM-DD`
          example: '2000-02-22'
    LegalDocument:
      description: Legal document that is required for KYC.
      type: object
      properties:
        id:
          type: string
          description: ID of legal document. <BR/> **Conditional Mandatory**<font color='red'>* </font> field - Required when legal document type is provided.
          minLength: 4
          maxLength: 25
          pattern: '[a-zA-Z0-9]+'
          example: P039238238
        type:
          $ref: '#/components/schemas/LegalDocumentType'
        placeOfIssuance:
          type: string
          description: Place of issuance of legal document <BR/> **Conditional Mandatory**<font color='red'>* </font> field - Required when legal document id is provided and configured in document checklist plan associated with program.
          minLength: 1
          maxLength: 100
          pattern: '[^%<>\\[\\]^$]+'
          example: Mumbai, India
        expiryDate:
          type: string
          format: date
          description: Date on which the legal document will expire. <BR/> **Conditional Mandatory**<font color='red'>* </font> field - Required when legal document id is provided and configured in document checklist plan associated with program. <br/> Format - It is expressed in ISO 8601 - `YYYY-MM-DD`
          example: '2050-05-16'
    Language:
      type: string
      description: 'Language preference. Language tags should be in the ''Language-Region'' format as described by Internet Engineering ''Task Force (IETF) BCP 47'' standard. <BR/> **Conditional Mandatory**<font color=''red''>* </font> field - Required while creating new client. <br/> **Valid values: **

        * `en-US` - English language

        * `ar-AE` - Arabic language

        * `th-TH` - Thai language'
      example: en-US
    DebitCardDetails:
      allOf:
      - $ref: '#/components/schemas/RequestValidityTime'
      type: object
      required:
      - dataValidUntilTimestamp
      properties:
        application:
          $ref: '#/components/schemas/DebitApplication'
        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/DebitClient'
        card:
          $ref: '#/components/schemas/FreshDebitCard'
        cbsAccount:
          $ref: '#/components/schemas/CbsAccount'
        account:
          $ref: '#/components/schemas/AccountPromoPlanCodes'
        customFields:
          $ref: '#/components/schemas/CustomFields'
    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'
    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: []
    PhoneNumber1:
      type: string
      description: Single or Multiple or Range of contact numbers. for example, 9120556677/88/98. <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: 02025870577/88
    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
    ConditionalPrimaryClientCode:
      type: string
      description: Unique code of the existing primary client. <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.
      minLength: 4
      maxLength: 24
      pattern: '[a-zA-Z0-9]+'
      example: 215812722194
    ErrorsInfo:
      required:
      - Errors
      type: object
      properties:
        Errors:
          $ref: '#/components/schemas/Errors'
    CardStatus:
      type: string
      description: 'The current status of the card. <br/> **Valid values: ** <br/>

        * `NORMAL` - Indicates normal card

        * `SUPERVISION` - Indicates supervision card

        * `CANCELLED` - Indicates cancelled card

        * `REPLACED` - Indicates replaced card

        * `LOST` - Indicates lost card

        * `STOLEN` - Indicates stolen card

        * `COUNTERFEIT` - Indicates counterfeit card

        * `RETURNED` - Indicates returned card

        * `PROGRAM_CHANGE_OR_UPGRADE` - Indicates program change card

        * `RETURNED_CARD_RENEWAL` - Indicates returned card renewal card

        * `NOT_ACTIVATED` - Indicates card is not activated

        * `EXPIRED` - Indicates expired card

        * `INACTIVE` - Indicates inactive card

        * `BLOCKED` - Indicates blocked card

        * `DISPATCHED` - Indicates card dispatched

        * `READY_FOR_SALE` - Indicates ready for sale card

        * `TRANSFERRED_TO_OTHER_BRANCH` - Indicates transferred to another branch card

        * `RETURNED_AND_SHREDDED` - Indicates returned to bank and shredded card

        * `DAMAGED` - indicates card is damaged

        * `EMERGENCY_REPLACEMENT` - Indicates emergency replacement card

        * `ERRONEOUS` - Indicates card is erroneous

        * `RETENTION` - Indicates retention card

        * `NPA_RECLASSIFIED` - Indicates NPA reclassified card

        * `TECHNOLOGY_UPGRADE` - Indicates card technology upgrade Card

        * `REPLACED_INACTIVE` - Indicates replaced-inactive card

        * `RENEWED_INACTIVE` - Indicates renewed-inactive card'
      example: NORMAL
    EmployerType:
      type: string
      description: Type of employer. <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=COMP_TYPE'. <br/> **Few sample values :** `Private`, `Public`, `Government`, `Non-Government`
      example: Non-Government
    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
    RequestValidityTime:
      description: Validity of the API request. It protects the API from unauthorized request or man-in-the-middle (MITM) attacks <br/>For example, if the validity of the API request is set for a maximum of 5 minutes (including retry attempts), and someone tries to post the same request after 5 minutes, then the system rejects the API request without processing.
      type: object
      required:
      - dataValidUntilTimestamp
      properties:
        dataValidUntilTimestamp:
          type: string
          format: date-time
          description: The date and time after which the request is considered as invalid. If the timestamp of the institution is greater than this timestamp, the API request is considered as expired and is returned.<br/>The 'dataValidUntilTimestamp' parameter is converted into the institution time zone before comparing it with the institution date and time. It is expressed in ISO 8601 extended format. Must be either <br/> 'YYYY-MM-DDThh:mm:ss[.sss]Z'<br/> or 'YYYY-MM-DDThh:mm:ss[.sss] (+|-) hh:mm' where [.sss] is optional and can be 1 to 3 digits.
          minLength: 20
          maxLength: 29
          example: '2020-07-04T12:09:56.450-07:00'
    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
    ClientSearchInfo:
      type: object
      properties:
        code:
          $ref: '#/components/schemas/ClientCode'
        mobile:
          $ref: '#/components/schemas/Mobile'
    BaseCard:
      allOf:
      - $ref: '#/components/schemas/BaseSearchCard'
      description: Base Card information
      type: object
      properties:
        type:
          $ref: '#/components/schemas/CardType'
        relationship:
          $ref: '#/components/schemas/CardRelationship'
        status:
          $ref: '#/components/schemas/CardStatus'
    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
    CurrentAddress:
      allOf:
      - $ref: '#/components/schemas/Address'
      type: object
      properties:
        lodgingMode:
          $ref: '#/components/schemas/LodgingMode'
    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'
    DebitApplication:
      type: object
      description: Contains information about different types of debit cards
      required:
      - type
      properties:
        type:
          $ref: '#/components/schemas/OnboardingApplicationType'
    ClientType:
      type: string
      description: 'Indicates client type <br /> <BR/> **Conditional Mandatory**<font color=''red''>* </font> field - Required while creating new client. <br/> Valid values are configured on ''Card Management > Institution Parameter Setup > System Codes [ISSS15]''     screen for ''Type Id=CUSTOMER_TYPE''. <br/> **Few sample values: **  `Individual`, `Corporate`, `Bank Staff`'
      example: Individual
    OnboardingApplicationType:
      type: string
      description: 'Application type indicates the type of card being requested. <br/> **Valid values: ** <br/> `PRIMARY` - Issue Primary Card <br /> `ADD_ON` - Issue Add-On Card <br /> `SUPPLEMENTARY` - Issue Supplementary Card <br />'
      example: PRIMARY
    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
    AddOnClient:
      type: object
      properties:
        clientCode:
          $ref: '#/components/schemas/ConditionalAddonClientCode'
        relation:
          $ref: '#/components/schemas/Relation'
    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'
    CobrandNumber:
      type: string
      description: Co-brand Number Value. It is also known as Partner Membership Number. <BR/> This field is required if configured as **Business Mandatory**<font color='red'>* </font>.
      minLength: 1
      maxLength: 20
      pattern: '[a-zA-Z0-9]+'
      example: Citi
    ConditionalCardNumber:
      type: string
      description: Unique number (PAN) assigned to the existing 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: 12
      maxLength: 22
      pattern: '[0-9]+'
      example: '5001890797820298'
    Title:
      type: string
      description: 'The title or salutation that is added before the name of client. <br/> <br/> **Conditional Mandatory**<font color=''red''>* </font> field - Required while creating new client. <br/> The valid values are configured on ''Card Management > Institution Parameter Setup > System Codes [ISSS15]'' screen for ''Type Id=TITLE''. **Sample values**: Mr, Mrs, Miss, Dr, Chief, Sir, Ms'
      example: Mr
    CurrentContact:
      type: object
      properties:
        phoneNumber1:
          $ref: '#/components/schemas/PhoneNumber1'
        phoneNumber2:
          $ref: '#/components/schemas/PhoneNumber2'
    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
    ProgramCode:
      type: string
      description: Program code of a card
      minLength: 1
      maxLength: 10
      pattern: '[A-Z0-9](([_])?[A-Z0-9])+'
      example: LOANPR
    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
    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
    CardExpiry:
      type: string
      description: Expiry date of the card in "MM/YY" format. This field is not applicable for LVC cards. The 'expiry' and 'expiry Date Time' fields are mutually exclusive, which means you can use any one of these fields to specify the details.
      pattern: (0[1-9]|1[0-2])/[0-9]{2}
      example: 11/30
    Mobile:
      type: object
      description: Mobile number details
      properties:
        isd:
          type: string
          description: ISD code is defined as the country code to call a mobile subscriber directly from outside the country. For example, +91 for India and +971 for UAE. <BR/>If not provided, then the institution ISD code is populated.
          pattern: '[+]?[0-9-]+'
          minLength: 1
          maxLength: 4
          example: '+91'
        number:
          type: string
          description: Mobile number excluding ISD Code. <BR/> **Conditional Mandatory**<font color='red'>* </font> field - Required when SMS alert is activated or ISD value is provided.
          pattern: '[0-9]+'
          minLength: 4
          maxLength: 15
          example: '9058344422'
    LegalDocumentType:
      type: string
      description: 'Legal Document Type <BR/> **Conditional Mandatory**<font color=''red''>* </font> field - Required when type is configured in document checklist plan associated with program. <br/> Valid values are configured on "Card Management > Institution Parameter Setup > System Codes [ISSS15]"     screen for "Type Id=LEGAL_IDENTIFICATION_TYPE". <br/> **Few sample values:**

        * `Passport`

        * `National Id`

        * `Tax ID`

        * `Driving License`

        * `Travel Ticket`

        * `Travel Visa`

        * `Voter ID`

        * `Pan Card`

        * `Pan card`

        * `Ration Card`

        * `Aadhar Card`

        * `Company Id`

        * `Other Id`'
      example: National Id
    Errors:
      required:
      - Error
      type: object
      properties:
        Error:
          type: array
          description: Errors array wrapped in an error object
          items:
            $ref: '#/components/schemas/ErrorMessage'
          example: []
    RiskCategory:
      type: string
      description: 'Client''s risk category. <BR/> This field is required if configured as **Business Mandatory**<font color=''red''>* </font>. <br/> **Valid values: **

        * `NONE` - Insignificant or no risk

        * `LOW` - Low risk

        * `MODERATE` - Moderate risk

        * `HIGH` - High risk

        * `CRITICAL` - Critical risk

        * `CATASTROPHIC` - Catastrophic risk'
      example: LOW
    ClientCode:
      type: string
      description: Unique code of the client
      minLength: 4
      maxLength: 24
      pattern: '[a-zA-Z0-9]+'
      example: 215812722194
    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=''

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