---
swagger: "2.0"
info:
  title: CRDS-CCC-V-CardMntData
  description: This microservice is used for functionalities related to the card maintenance.
  version: 1.0.0
  x-ibm-name: crds-ccc-v-cardmntdata
host: 127.0.0.1
schemes:
- https
basePath: /api
produces:
- application/json
paths:
  /v1/cards/plastic/report:
    post:
      tags:
      - card-report
      operationId: card-report
      summary: To do the reporting of a card when it is stolen/lost or damaged etc.
        and request the generation of a new card to replace it.
      description: This API is used to do the reporting of a card when it is stolen/lost
        or damaged etc. and request the generation of a new card to replace it.
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - name: client_id
        in: header
        required: true
        type: string
        description: Client ID generated during application registration
      - name: Authorization
        in: header
        required: true
        type: string
        description: The Authorization Token received during login
      - name: Accept
        in: header
        required: true
        type: string
        description: Content-Types that are acceptable for the response
      - name: uuid
        in: header
        required: true
        type: string
        description: 128 bit UUID that you generate for every request
      - name: Accept-Language
        in: header
        required: false
        type: string
        description: List of acceptable human languages for response
      - name: Content-Type
        in: header
        required: true
        type: string
        description: Content-Types that are sent in the request
      - name: ChannelId
        in: header
        required: true
        type: string
        description: Channel where request originated
      - name: countryCode
        in: header
        required: true
        type: string
        description: Country code in 2 character ISO 3166 format
      - name: businessCode
        in: header
        required: true
        type: string
        description: Business code identified during application registration
      - name: sid
        in: header
        required: true
        type: string
        description: SessionId sent by Consumer
      - name: cardReportRequest
        in: body
        schema:
          $ref: '#/definitions/CardReportRequest'
      responses:
        200:
          description: Successful operation.
          schema:
            $ref: '#/definitions/CardReportResponse'
        400:
          description: <table><table><tr><td>Type</td><td>Code</td><td>Details</td></tr><tr><td>error</td><td>invalidRequest</td><td>Missing
            or invalid Parameters</td></tr></table>
          schema:
            $ref: '#/definitions/ErrorResponse'
        401:
          description: <table><tr><td>Type</td><td>Code</td><td>Details</td></tr><tr><td>error</td><td>unAuthorized</td><td>Authorization
            credentials are missing or invalid</td></tr></table>
          schema:
            $ref: '#/definitions/ErrorResponse'
        403:
          description: <table><tr><td>Type</td><td>Code</td><td>Details</td><td>More
            Info</td></tr><tr><td>error</td><td>accessNotConfigured</td><td>The request
            operation is not configured to access this resource</td><td>Channel/Country/Business
            provided in the request is not supported currently</td></tr></table>
          schema:
            $ref: '#/definitions/ErrorResponse'
        404:
          description: <table><tr><td>Type</td><td>Code</td><td>Details</td><td>More
            Info</td></tr><tr><td>error</td><td>resourceNotFound</td><td>The requested
            resource was not found</td><td>Empty resource/resource not found</td></tr></table>
          schema:
            $ref: '#/definitions/ErrorResponse'
        422:
          description: <table><table><tr><td>Type</td><td>Code</td><td>Details</td></tr><tr><td>error</td><td>businessValidationFailed</td><td>Business
            validation error occured on one or more parameters</td></tr></table>
          schema:
            $ref: '#/definitions/ErrorResponse'
        500:
          description: <table><tr><td>Type</td><td>Code</td><td>Details</td></tr><tr><td>fatal</td><td>serverUnavailable</td><td>The
            request failed due to an internal error/server unavailability</td></tr></table>
          schema:
            $ref: '#/definitions/ErrorResponse'
  /v1/cards/plastic/delivery/branch:
    post:
      tags:
      - card-delivery-branch
      operationId: card-delivery-branch
      summary: To select the branch address to rescue/send the card (New/ replacement)
        where the customer wants. The accountId shared in the request gives the reference
        to the account for which the card is generated and the branchId in the request
        gives the reference to the particular branch which is selected for the retrieval
        of the card.
      description: This API is to select the branch address to rescue/send the card
        where the customer wants
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - name: client_id
        in: header
        required: true
        type: string
        description: Client ID generated during application registration
      - name: Authorization
        in: header
        required: true
        type: string
        description: The Authorization Token received during login
      - name: Accept
        in: header
        required: true
        type: string
        description: Content-Types that are acceptable for the response
      - name: uuid
        in: header
        required: true
        type: string
        description: 128 bit UUID that you generate for every request
      - name: Accept-Language
        in: header
        required: false
        type: string
        description: List of acceptable human languages for response
      - name: Content-Type
        in: header
        required: true
        type: string
        description: Content-Types that are sent in the request
      - name: ChannelId
        in: header
        required: true
        type: string
        description: Channel where request originated
      - name: countryCode
        in: header
        required: true
        type: string
        description: Country code in 2 character ISO 3166 format
      - name: businessCode
        in: header
        required: true
        type: string
        description: Business code identified during application registration
      - name: sid
        in: header
        required: true
        type: string
        description: SessionId sent by Consumer
      - name: cardDeliveryBranchRequest
        in: body
        schema:
          $ref: '#/definitions/CardDeliveryBranchRequest'
      responses:
        200:
          description: Successful operation.
          schema:
            $ref: '#/definitions/CardDeliveryBranchResponse'
        400:
          description: <table><table><tr><td>Type</td><td>Code</td><td>Details</td></tr><tr><td>error</td><td>invalidRequest</td><td>Missing
            or invalid Parameters</td></tr></table>
          schema:
            $ref: '#/definitions/ErrorResponse'
        401:
          description: <table><tr><td>Type</td><td>Code</td><td>Details</td></tr><tr><td>error</td><td>unAuthorized</td><td>Authorization
            credentials are missing or invalid</td></tr></table>
          schema:
            $ref: '#/definitions/ErrorResponse'
        403:
          description: <table><tr><td>Type</td><td>Code</td><td>Details</td><td>More
            Info</td></tr><tr><td>error</td><td>accessNotConfigured</td><td>The request
            operation is not configured to access this resource</td><td>Channel/Country/Business
            provided in the request is not supported currently</td></tr></table>
          schema:
            $ref: '#/definitions/ErrorResponse'
        404:
          description: <table><tr><td>Type</td><td>Code</td><td>Details</td><td>More
            Info</td></tr><tr><td>error</td><td>resourceNotFound</td><td>The requested
            resource was not found</td><td>Empty resource/resource not found</td></tr></table>
          schema:
            $ref: '#/definitions/ErrorResponse'
        422:
          description: <table><table><tr><td>Type</td><td>Code</td><td>Details</td></tr><tr><td>error</td><td>businessValidationFailed</td><td>Business
            validation error occured on one or more parameters</td></tr></table>
          schema:
            $ref: '#/definitions/ErrorResponse'
        500:
          description: <table><tr><td>Type</td><td>Code</td><td>Details</td></tr><tr><td>fatal</td><td>serverUnavailable</td><td>The
            request failed due to an internal error/server unavailability</td></tr></table>
          schema:
            $ref: '#/definitions/ErrorResponse'
  /v1/cards/plastic/delivery/status/retrieve:
    post:
      tags:
      - card-delivery-status
      operationId: card-delivery-status
      summary: To retrieve the card delivery status when it is sent to a branch or
        the client's address
      description: This API is used to retrieve the card delivery status when it is
        sent to a branch or the client's address
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - name: client_id
        in: header
        required: true
        type: string
        description: Client ID generated during application registration
      - name: Authorization
        in: header
        required: true
        type: string
        description: The Authorization Token received during login
      - name: Accept
        in: header
        required: true
        type: string
        description: Content-Types that are acceptable for the response
      - name: uuid
        in: header
        required: true
        type: string
        description: 128 bit UUID that you generate for every request
      - name: Accept-Language
        in: header
        required: false
        type: string
        description: List of acceptable human languages for response
      - name: Content-Type
        in: header
        required: true
        type: string
        description: Content-Types that are sent in the request
      - name: ChannelId
        in: header
        required: true
        type: string
        description: Channel where request originated
      - name: countryCode
        in: header
        required: true
        type: string
        description: Country code in 2 character ISO 3166 format
      - name: businessCode
        in: header
        required: true
        type: string
        description: Business code identified during application registration
      - name: sid
        in: header
        required: true
        type: string
        description: SessionId sent by Consumer
      - name: cardDeliveryStatusRequest
        in: body
        schema:
          $ref: '#/definitions/CardDeliveryStatusRequest'
      responses:
        200:
          description: Successful operation.
          schema:
            $ref: '#/definitions/CardDeliveryStatusResponse'
        400:
          description: <table><table><tr><td>Type</td><td>Code</td><td>Details</td></tr><tr><td>error</td><td>invalidRequest</td><td>Missing
            or invalid Parameters</td></tr></table>
          schema:
            $ref: '#/definitions/ErrorResponse'
        401:
          description: <table><tr><td>Type</td><td>Code</td><td>Details</td></tr><tr><td>error</td><td>unAuthorized</td><td>Authorization
            credentials are missing or invalid</td></tr></table>
          schema:
            $ref: '#/definitions/ErrorResponse'
        403:
          description: <table><tr><td>Type</td><td>Code</td><td>Details</td><td>More
            Info</td></tr><tr><td>error</td><td>accessNotConfigured</td><td>The request
            operation is not configured to access this resource</td><td>Channel/Country/Business
            provided in the request is not supported currently</td></tr></table>
          schema:
            $ref: '#/definitions/ErrorResponse'
        404:
          description: <table><tr><td>Type</td><td>Code</td><td>Details</td><td>More
            Info</td></tr><tr><td>error</td><td>resourceNotFound</td><td>The requested
            resource was not found</td><td>Empty resource/resource not found</td></tr></table>
          schema:
            $ref: '#/definitions/ErrorResponse'
        422:
          description: <table><table><tr><td>Type</td><td>Code</td><td>Details</td></tr><tr><td>error</td><td>businessValidationFailed</td><td>Business
            validation error occured on one or more parameters</td></tr></table>
          schema:
            $ref: '#/definitions/ErrorResponse'
        500:
          description: <table><tr><td>Type</td><td>Code</td><td>Details</td></tr><tr><td>fatal</td><td>serverUnavailable</td><td>The
            request failed due to an internal error/server unavailability</td></tr></table>
          schema:
            $ref: '#/definitions/ErrorResponse'
  /v1/cards/plastic/hard-block:
    post:
      tags:
      - card-hard-block
      operationId: card-hard-block
      summary: To block the card of the customer with the hard reference.
      description: This API is used to block the card of the customer with the hard
        reference.
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - name: client_id
        in: header
        required: true
        type: string
        description: Client ID generated during application registration
      - name: Authorization
        in: header
        required: true
        type: string
        description: The Authorization Token received during login
      - name: Accept
        in: header
        required: true
        type: string
        description: Content-Types that are acceptable for the response
      - name: uuid
        in: header
        required: true
        type: string
        description: 128 bit UUID that you generate for every request
      - name: Accept-Language
        in: header
        required: false
        type: string
        description: List of acceptable human languages for response
      - name: Content-Type
        in: header
        required: true
        type: string
        description: Content-Types that are sent in the request
      - name: ChannelId
        in: header
        required: true
        type: string
        description: Channel where request originated
      - name: countryCode
        in: header
        required: true
        type: string
        description: Country code in 2 character ISO 3166 format
      - name: businessCode
        in: header
        required: true
        type: string
        description: Business code identified during application registration
      - name: sid
        in: header
        required: true
        type: string
        description: SessionId sent by Consumer
      - name: cardHardBlockRequest
        in: body
        schema:
          $ref: '#/definitions/CardHardBlockRequest'
      responses:
        200:
          description: Successful operation.
          schema:
            $ref: '#/definitions/CardHardBlockResponse'
        400:
          description: <table><table><tr><td>Type</td><td>Code</td><td>Details</td></tr><tr><td>error</td><td>invalidRequest</td><td>Missing
            or invalid Parameters</td></tr></table>
          schema:
            $ref: '#/definitions/ErrorResponse'
        401:
          description: <table><tr><td>Type</td><td>Code</td><td>Details</td></tr><tr><td>error</td><td>unAuthorized</td><td>Authorization
            credentials are missing or invalid</td></tr></table>
          schema:
            $ref: '#/definitions/ErrorResponse'
        403:
          description: <table><tr><td>Type</td><td>Code</td><td>Details</td><td>More
            Info</td></tr><tr><td>error</td><td>accessNotConfigured</td><td>The request
            operation is not configured to access this resource</td><td>Channel/Country/Business
            provided in the request is not supported currently</td></tr></table>
          schema:
            $ref: '#/definitions/ErrorResponse'
        404:
          description: <table><tr><td>Type</td><td>Code</td><td>Details</td><td>More
            Info</td></tr><tr><td>error</td><td>resourceNotFound</td><td>The requested
            resource was not found</td><td>Empty resource/resource not found</td></tr></table>
          schema:
            $ref: '#/definitions/ErrorResponse'
        422:
          description: <table><table><tr><td>Type</td><td>Code</td><td>Details</td></tr><tr><td>error</td><td>businessValidationFailed</td><td>Business
            validation error occured on one or more parameters</td></tr></table>
          schema:
            $ref: '#/definitions/ErrorResponse'
        500:
          description: <table><tr><td>Type</td><td>Code</td><td>Details</td></tr><tr><td>fatal</td><td>serverUnavailable</td><td>The
            request failed due to an internal error/server unavailability</td></tr></table>
          schema:
            $ref: '#/definitions/ErrorResponse'
definitions:
  CardReportRequest:
    type: object
    properties:
      cardIssue:
        $ref: '#/definitions/CardIssue'
    required:
    - cardIssue
  CardIssue:
    type: object
    properties:
      accountId:
        description: Unique ID used by front end to identify the account
        type: string
        example: "123456"
      reportTypeCode:
        description: 'Code to indicate the type of the report. Values: Lost and Stolen
          request (Request flag = T), Damage Card Replacement (Request flag = R),
          Blocking request (Request flag = B), Other request (Request flag = Z).'
        type: string
        example: T
      cardBlockCode:
        description: Card block Codes. Possibles values are in AMCR file (AMCR-LB-LM-BLK).
        type: string
        example: L
      blockReasonCode:
        description: 'The reason for blocking the card. For eg: The card is stolen
          while travelling.'
        type: string
        example: "01"
      feeCode:
        description: Code to indicate how the replacement need to be payed. Valid
          values are B, N, Y and U
        type: string
        example: B
      replacementReason:
        description: Reason of the replacement of the card. Possible values E, O,
          B, G, U
        type: string
        example: E
    required:
    - accountId
    - reportTypeCode
    - cardBlockCode
    - feeCode
    - replacementReason
  CardReportResponse:
    type: object
    properties:
      reportFolioId:
        description: Unique Id to identify the operation. It is generated by the folio
          operation service used for tracking.
        type: string
        example: 05235e5da96d000001
      cardPlastic:
        $ref: '#/definitions/CardPlastic'
      address:
        $ref: '#/definitions/AddressInformation'
    required:
    - reportFolioId
    - cardPlastic
    - address
  CardPlastic:
    type: object
    properties:
      displayCardNumber:
        description: The last 4 digits of the new card number.
        type: string
        example: "3523"
    required:
    - displayCardNumber
  AddressInformation:
    type: object
    properties:
      postalCode:
        description: Postal code of the address.
        type: string
        example: "06500"
      colonyName:
        description: Name of the Colony.
        type: string
        example: Cuauhtemoc
      lastUpdatedDate:
        description: Last time the address was updated
        type: string
        format: date
        example: "2018-02-02"
        maxLength: 10
    required:
    - postalCode
    - colonyName
    - lastUpdatedDate
  CardDeliveryBranchRequest:
    type: object
    properties:
      branchId:
        description: Unique identifier for the branch.
        type: string
        example: "1234"
      branchName:
        description: Name of the branch.
        type: string
        example: Patio Santa fe
      accountId:
        description: Unique ID used by front end to identify the account
        type: string
        example: "123456"
      reportFolioId:
        description: Unique Id to identify the operation. It is generated by the folio
          operation service, used  for tracking
        type: string
        example: "123456"
      branchAddress:
        $ref: '#/definitions/AddressInfo'
    required:
    - branchId
    - branchName
  AddressInfo:
    type: object
    properties:
      colonyName:
        description: Name of the Colony of the bank branch.
        type: string
        example: Cuauhtemoc
      postalCode:
        description: Postal code of the bank branch.
        type: string
        example: "06500"
      city:
        description: City of the bank branch.
        type: string
        example: Mexico City
      streetName:
        description: The name on a street of the bank branch.
        type: string
        example: Rio de la plata
    required:
    - colonyName
    - postalCode
    - city
    - streetName
  CardDeliveryBranchResponse:
    type: object
    properties:
      displayCardNumber:
        description: The last 4 digits of the card number.
        type: string
        example: "3523"
      deliveryFolioId:
        description: Folio ID for the query obtained from this rescue/ send card request.
          It is generated by the folio operation service, used  for tracking
        type: string
        example: 05235e5da96d000001
      branchId:
        description: Unique identifier for the branch.
        type: string
        example: "1234"
      branchName:
        description: Name of the branch.
        type: string
        example: Patio Santa fe
      branchAddress:
        $ref: '#/definitions/Address'
    required:
    - displayCardNumber
    - deliveryFolioId
    - branchId
    - branchAddress
    - branchName
  Address:
    type: object
    properties:
      colonyName:
        description: Name of the Colony of the bank branch.
        type: string
        example: Cuauhtemoc
      postalCode:
        description: Postal code of the bank branch.
        type: string
        example: "06500"
      city:
        description: City of the bank branch.
        type: string
        example: Ciudad de Mexico
      streetName:
        description: The name on a street of the bank branch.
        type: string
        example: Rio de la plata
    required:
    - colonyName
    - postalCode
    - city
    - streetName
  CardDeliveryStatusRequest:
    properties:
      accountId:
        description: Unique ID used by front end to identify the account.
        type: string
        example: "1234"
    required:
    - accountId
  CardDeliveryStatusResponse:
    type: object
    properties:
      displayCardNumber:
        description: The last 4 digits of the card number.
        type: string
        example: "3523"
      branchId:
        description: Unique identifier for the branch.
        type: string
        example: "1234"
      deliveryStatus:
        description: Delivery status of the card. Ex- Pending, Sent, In-process, Canceled,
          etc.
        type: string
        example: Pending
      deliveryMode:
        description: 'Delivery Mode. It represents shipping mode basically and says
          by which mode card plastic is getting delivered. For Ex: Standard shipping
          or Pickup Branch or Preferred Mailing Address'
        type: string
        example: Branch
      address:
        $ref: '#/definitions/AddressDetail'
    required:
    - displayCardNumber
    - branchId
    - deliveryStatus
    - deliveryMode
    - address
  AddressDetail:
    type: object
    properties:
      colonyName:
        description: Name of the Colony of the bank branch.
        type: string
        example: Cuauhtemoc
      postalCode:
        description: Postal code of the bank branch.
        type: string
        example: "06500"
      city:
        description: City of the bank branch.
        type: string
        example: Ciudad de Mexico
      streetName:
        description: The name on a street of the bank branch.
        type: string
        example: Rio de la plata
      landmark:
        description: A landscape that is easily seen and recognized from a distance,
          especially one that enables someone to establish their location.
        type: string
        example: between Gante and Bolivar
    required:
    - colonyName
    - postalCode
    - city
    - streetName
  CardHardBlockRequest:
    type: object
    properties:
      accountId:
        description: Unique ID used by front end to identify the account.
        type: string
        example: "1234"
      cardBlockCode:
        description: 'The block code used to block a particular card.Card Block Codes
          are Temp. Block,  Lost, Fraud / Stolen, Over Credit Limit For eg: if card
          is lost the first step is to block the card to avoid any discrepany like
          misuse(Fraud)'
        type: string
        example: L
      blockReasonCode:
        description: 'Block reason code gives  more specific reason for blocking the
          card. For eg: The card is stolen while travelling.'
        type: string
        example: "01"
    required:
    - cardBlockCode
    - blockReasonCode
    - accountId
  CardHardBlockResponse:
    type: object
    properties:
      hardBlockFolioId:
        description: Unique Id to identify the operation. It is generated by the folio
          operation service used for tracking.
        type: string
        example: 05235e5da96d000001
    required:
    - hardBlockFolioId
  ErrorResponse:
    properties:
      type:
        type: string
        description: Invalid - Request did not confirm to the specification and was
          unprocessed and rejected. Please fix the value and try again
        enum:
        - error
        - warn
        - invalid
        - fatal
      code:
        description: Error code which qualifies the error
        type: string
      details:
        description: Human readable explanation specific to the occurrence of the
          problem
        type: string
      location:
        description: The name of the field that resulted in the error
        type: string
      moreInfo:
        description: More Info can be used to pass any additional details
        type: string
      uuid:
        description: 128 bit UUID that you generate for every request
        type: string
      timestamp:
        description: Timestamp of the error
        type: string
    required:
    - type
    - code
x-ibm-configuration:
  enforced: true
  testable: true
  phase: realized
securityDefinitions:
  OAuth2 Application Flow:
    type: oauth2
    description: ""
    flow: application
    scopes:
      /api/v1: ""
    tokenUrl: https://perf.api.externalapib2b.wlb.lac.nsroot.net:7100/mx-gcgapi/perfext/api/v1/oauth/token
  Client ID:
    type: apiKey
    description: ""
    in: header
    name: X-IBM-Client-Id
security:
- OAuth2 Application Flow:
  - /api/v1
  Client ID: []
x-ibm-endpoints:
- endpointUrl: https://perf.api.externalapib2b.wlb.lac.nsroot.net:7100/mx-gcgapi/perfext
  type:
  - production
  - development
...