Mastercard
Mastercard Cards API

The Cards API from Mastercard — 7 operation(s) for cards.
Documentation GitHub OpenAPI
OpenAPI Specification

swagger: '2.0'
info:
  title: Mastercard Bill Payment Validator Account Opening Cards 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: 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
  /donors/{donor_id}/cards:
    get:
      tags:
      - Cards
      summary: Get All Cards API
      description: Fetches all the cards for given donor. Entire response body is encrypted and it should be decrypted to view the actual response.
      operationId: getAllCardsUsingGET
      parameters:
      - $ref: '#/components/parameters/ClientId'
      - $ref: '#/components/parameters/CorrelationId'
      - $ref: '#/components/parameters/ProgramId'
      - $ref: '#/components/parameters/Donor'
      responses:
        '200':
          $ref: '#/components/responses/DonateGetAllCards'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '500':
          $ref: '#/components/responses/InternalServerError'
      deprecated: false
    post:
      tags:
      - Cards
      summary: Add Card API
      description: Donor can add his/her card onto platform by calling this API, so that next time he/she wants to donate, he/she don't have to provide card details.A card will be added once. Second time, the initial card Id will be returned.Entire request body should be encrypted.
      operationId: addCardUsingPOST
      parameters:
      - $ref: '#/components/parameters/ClientId'
      - $ref: '#/components/parameters/CorrelationId'
      - $ref: '#/components/parameters/ProgramId'
      - $ref: '#/components/parameters/Donor'
      requestBody:
        $ref: '#/components/requestBodies/AddCard'
      responses:
        '200':
          $ref: '#/components/responses/DonateCard'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error-AddCard'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '500':
          $ref: '#/components/responses/InternalServerError'
      deprecated: false
  /donors/{donor_id}/cards/searches:
    post:
      tags:
      - Cards
      summary: Search Card API
      description: Search card by pan or user id passed. Entire request body should be encrypted.
      operationId: searchCardUsingPOST
      parameters:
      - $ref: '#/components/parameters/ClientId'
      - $ref: '#/components/parameters/CorrelationId'
      - $ref: '#/components/parameters/ProgramId'
      - $ref: '#/components/parameters/Donor'
      requestBody:
        $ref: '#/components/requestBodies/SearchCard'
      responses:
        '200':
          $ref: '#/components/responses/DonateGetAllCards'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '500':
          $ref: '#/components/responses/InternalServerError'
      deprecated: false
  /donors/{donor_id}/cards/{card_id}:
    get:
      tags:
      - Cards
      summary: Retrieve Card API
      description: Retrieves card by card id passed. Entire response body is encrypted and it should be decrypted to view the actual response.
      operationId: retrieveCardUsingGET
      parameters:
      - $ref: '#/components/parameters/ClientId'
      - $ref: '#/components/parameters/CorrelationId'
      - $ref: '#/components/parameters/ProgramId'
      - $ref: '#/components/parameters/Card'
      - $ref: '#/components/parameters/Donor'
      responses:
        '200':
          $ref: '#/components/responses/DonateCardRetrieve'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '500':
          $ref: '#/components/responses/InternalServerError'
      deprecated: false
    put:
      tags:
      - Cards
      summary: Update Card API
      description: Donor can update his/her already added card by providing new card informatin along with cardId. Entire request body should be encrypted.
      operationId: updateCardUsingPUT
      parameters:
      - $ref: '#/components/parameters/ClientId'
      - $ref: '#/components/parameters/CorrelationId'
      - $ref: '#/components/parameters/ProgramId'
      - $ref: '#/components/parameters/Card'
      - $ref: '#/components/parameters/Donor'
      responses:
        '200':
          $ref: '#/components/responses/DonateCardUpdate'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '500':
          $ref: '#/components/responses/InternalServerError'
      deprecated: false
      requestBody:
        $ref: '#/components/requestBodies/UpdateCard'
    delete:
      tags:
      - Cards
      summary: Delete Card API
      description: Donor can delete his/her saved card from Donation platform.
      operationId: deleteCardUsingDELETE
      parameters:
      - $ref: '#/components/parameters/ClientId'
      - $ref: '#/components/parameters/CorrelationId'
      - $ref: '#/components/parameters/ProgramId'
      - $ref: '#/components/parameters/Card'
      - $ref: '#/components/parameters/Donor'
      responses:
        '204':
          $ref: '#/components/responses/NoContent'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '500':
          $ref: '#/components/responses/InternalServerError'
      deprecated: false
  /donations/non-ma/setup/cards:
    get:
      tags:
      - Cards
      summary: Get All Non Mastercard Brand Cards API
      description: This API is used by the API consumer to download all their Non-Mastercard registered cards.
      operationId: fetchDonationNonMA
      parameters:
      - $ref: '#/components/parameters/ClientId'
      - name: x-correlation-id
        in: header
        description: CorrelationId is a unique donation request ID. It is recommended to pass the x-correlation-id by the customer and to use the format "bankname_UUID" (bank name can be indicated using the first 4 digits). Maximum length of this field should be 100 alphanumeric characters. If not passed, Mastercard will generate it. ***Note:*** If there is a timeout when doing the guest api call, it is important to redo the same api call with same x-correlation-id to get the status of the previous api call
        required: false
        schema:
          type: string
          example: 03f8c4e8-8bdc-4a30-a2b4-b6f989e96ca3
      - $ref: '#/components/parameters/ProgramId'
      responses:
        '200':
          $ref: '#/components/responses/RetrieveNonMABrandCards'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error-InvalidProgramId'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error-InternalServerError'
      deprecated: false
  /source-verifications/{issuing_country}/medicare-cards:
    post:
      x-mastercard-api-encrypted: true
      summary: Verifies the details of a medicare card document with an identity verification provider
      tags:
      - Cards
      responses:
        '200':
          $ref: '#/components/responses/MedicareCardSourceVerificationResponse'
        '400':
          $ref: '#/components/responses/BadRequestError'
        '403':
          $ref: '#/components/responses/ForbiddenError_2'
        '404':
          $ref: '#/components/responses/NotFoundError'
      description: Returns the status of the Medicare Card source verification as it's being processed by the vendor. Biometrics are not used with this API, which means document scanning is not required for the users to verify their identity. This will be a one-time verification with no data being stored.
      operationId: verifyMedicareCard
      parameters:
      - $ref: '#/components/parameters/IssuingCountryParameter'
      - $ref: '#/components/parameters/EncryptedPayloadParameter'
      requestBody:
        $ref: '#/components/requestBodies/MedicareCardSourceVerificationRequest'
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'
    PrepaidCardProfileResponse:
      description: The prepaid card was successfully created/issued.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/PrepaidCardProfile'
      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'
    Forbidden:
      description: Forbidden
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error-403'
    DonateCardRetrieve:
      description: Success
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/DonateCardRetrieve'
    RetrieveNonMABrandCards:
      description: Success
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/RetrieveNonMABrandCards'
    Unauthorized:
      description: Unauthorised
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error-401'
    InternalServerError:
      description: Internal Server Error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error-500'
    NotFound:
      description: The specified resource was not found
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error-404'
    DonateCardUpdate:
      description: Success
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/DonateCardUpdate'
    DonateGetAllCards:
      description: Success
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/DonateGetAllCards'
    BadRequest:
      description: Bad Request
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    DonateCard:
      description: Success
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/DonateCard'
    NoContent:
      description: The Setup is successfully deleted.
    NotFoundError:
      description: Request didn't match an existing resource.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiError'
          examples:
            NotFoundExample:
              $ref: '#/components/examples/NotFoundExample'
    ForbiddenError_2:
      description: Consent not given.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiError'
          examples:
            ForbiddenExample:
              $ref: '#/components/examples/ForbiddenExample_2'
            ForbiddenExampleUnauthorizedScopedFields:
              $ref: '#/components/examples/ForbiddenExampleUnauthorizedScopedFields'
    BadRequestError:
      description: Something was wrong with the request.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiError'
          examples:
            BadRequestExampleUserConsent:
              $ref: '#/components/examples/BadRequestExampleUserConsent'
            BadRequestExampleCountryCode:
              $ref: '#/components/examples/BadRequestExampleCountryCode'
            BadRequestExamplePhoneNumber:
              $ref: '#/components/examples/BadRequestExamplePhoneNumber'
            BadRequestExampleIVPConnectionTimeout:
              $ref: '#/components/examples/BadRequestExampleIVPConnectionTimeout'
            BadRequestExampleIVPSystemError:
              $ref: '#/components/examples/BadRequestExampleIVPSystemError'
            BadRequestExampleMedicareExpireDate:
              $ref: '#/components/examples/BadRequestExampleMedicareExpireDate'
            BadRequestExampleMedicareName:
              $ref: '#/components/examples/BadRequestExampleMedicareName'
            BadRequestExampleMedicareIndividualReferenceNo:
              $ref: '#/components/examples/BadRequestExampleMedicareIndividualReferenceNo'
            BadRequestExampleMedicareMedicareNumber:
              $ref: '#/components/examples/BadRequestExampleMedicareMedicareNumber'
            BadRequestExampleMedicareCountryCode:
              $ref: '#/components/examples/BadRequestExampleMedicareCountryCode'
            BadRequestExampleMedicareUserConsent:
              $ref: '#/components/examples/BadRequestExampleMedicareUserConsent'
            BadRequestExampleDocumentMismatch:
              $ref: '#/components/examples/BadRequestExampleDocumentMismatch'
    MedicareCardSourceVerificationResponse:
      description: Success.
      headers:
        X-Transaction-ID:
          $ref: '#/components/headers/X-Transaction-ID'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/MedicareCardSourceVerificationResult'
          examples:
            MedicareSuccessExample:
              $ref: '#/components/examples/MedicareSuccessExample'
            MedicareDataNotMatchedExample:
              $ref: '#/components/examples/MedicareDataNotMatchedExample'
            MedicareDocumentInvalidExample:
              $ref: '#/components/examples/MedicareDocumentInvalidExample'
  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: []
    InitialLoad:
      type: object
      properties:
        currency:
          type: string
          description: The currency in which the amount is loaded. <br/> **Valid values :** 3-letter currency codes in `ISO 4217`
          maxLength: 3
          minLength: 3
          pattern: '[A-Z]+'
          example: USD
        amount:
          type: number
          format: double
          multipleOf: 1.0e-05
          description: The amount that can be loaded to the client account.
          minimum: 0
          maximum: 9999999999.99999
          example: 1000
    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 contac

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

Documentation

Specifications

Code Examples

Other Resources

OpenAPI Specification
