---
swagger: "2.0"
info:
  title: crds-cdc-v-card-notes
  description: This microservice perform credit and debit card notes regarding operations.
  version: 1.0.0
  x-ibm-name: crds-cdc-v-card-notes
host: 127.0.0.1
schemes:
- https
basePath: /api
produces:
- application/json
paths:
  /v1/cards/customers/notes/info/save:
    post:
      tags:
      - save-customer-card-note-info
      operationId: save-customer-card-note-info
      summary: 'LOB: Cards, Feature: Debit and Credit Card, Functionality: Add Notes'
      description: This API is used by the agent to add notes that customer provides
        regarding the cards.
      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: saveCustomerCardNoteInfoRequest
        in: body
        schema:
          $ref: '#/definitions/SaveCustomerCardNoteInfoRequest'
      responses:
        200:
          description: Successful operation.
          schema:
            $ref: '#/definitions/SaveCustomerCardNoteInfoResponse'
        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/customers/notes/info/retrieve:
    post:
      tags:
      - retrieve-customer-card-note-info
      operationId: retrieve-customer-card-note-info
      summary: 'LOB: Cards, Feature: Debit and Credit Card, Functionality: Retrieve-notes'
      description: This API is used by the agent to read the notes that a customer
        provides regarding the cards.
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - name: client_id
        in: header
        required: false
        type: string
        description: Client ID generated during application registration
      - name: Authorization
        in: header
        required: false
        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: customerCardNoteInfoRequest
        in: body
        schema:
          $ref: '#/definitions/CustomerCardNoteInfoRequest'
      responses:
        200:
          description: Successful operation.
          schema:
            $ref: '#/definitions/CustomerCardNoteInfoResponse'
        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:
  SaveCustomerCardNoteInfoRequest:
    type: object
    properties:
      agentId:
        description: SOE id of Agent who registers the card note
        type: string
        pattern: ^[a-zA-Z0-9]*$
        example: jp34651
      customerId:
        description: Customer ID is a key associated with a specific entity or person
          Citi does business or has some relationship with
        type: string
        pattern: ^[0-9]{5,12}$
        minLength: 5
        maxLength: 12
        example: "123456789012"
      accountId:
        description: Unique ID used by front end to identify the account
        type: string
        example: "123456"
      cardPlastic:
        $ref: '#/definitions/CardPlastic'
    required:
    - agentId
    - accountId
    - customerId
  SaveCustomerCardNoteInfoResponse:
    type: object
    properties:
      responseCode:
        description: Code of the Response received from backend.
        type: string
        example: "101"
        maxLength: 3
    required:
    - responseCode
  CustomerCardNoteInfoRequest:
    type: object
    properties:
      agentId:
        description: SOE id of Agent who registers the card note
        type: string
        pattern: ^[a-zA-Z0-9]*$
        example: jp34651
      cardPlastic:
        $ref: '#/definitions/CardPlasticInfo'
    required:
    - agentId
  CustomerCardNoteInfoResponse:
    type: object
    properties:
      recordCount:
        description: Number of total records received so far in the query.
        type: integer
        format: int32
        example: 12
      transactionResponseReasonCode:
        description: Code refers to the reason for the status of transaction's authorization.
        type: string
        maxLength: 3
        example: "123"
      noteDetails:
        type: array
        items:
          $ref: '#/definitions/NoteDetailInfo'
  CardPlastic:
    type: object
    properties:
      notes:
        $ref: '#/definitions/Notes'
  CardPlasticInfo:
    type: object
    properties:
      account:
        $ref: '#/definitions/Account'
      notes:
        $ref: '#/definitions/NotesInfo'
  Account:
    type: object
    properties:
      customerId:
        description: Customer ID is a key associated with a specific entity or person
          Citi does business or has some relationship with
        type: string
        pattern: ^[0-9]{5,12}$
        minLength: 5
        maxLength: 12
        example: "123456789012"
      accountId:
        description: Unique ID used by front end to identify the account
        type: string
        example: "123456"
    required:
    - customerId
    - accountId
  Notes:
    type: object
    properties:
      noteType:
        description: Type of note created to clasify the reason of operation for debit
          card.
        type: string
        pattern: ^[a-zA-Z0-9]*$
        example: "1"
        maxLength: 3
      noteStatusCode:
        description: The current status of the note to indicate if note is open or
          close.
        type: string
        pattern: '[CO]'
        example: C
        maxLength: 1
      noteDetails:
        type: array
        items:
          $ref: '#/definitions/NoteDetail'
    required:
    - noteType
    - noteStatusCode
  NoteDetail:
    type: object
    properties:
      noteText:
        description: Comments entered during the ongoing research or investigation
          of case.
        type: string
        pattern: .*
        example: Card blocked for security purposes
        maxLength: 60
    required:
    - noteText
  NotesInfo:
    type: object
    properties:
      noteType:
        description: Type of note created to clasify the reason of operation for debit
          card.
        type: string
        pattern: ^[a-zA-Z0-9]*$
        example: "1"
        maxLength: 3
      queryMonthCode:
        description: Code used to specify the month to be consulted. Eg. 01 = January
        type: string
        pattern: ^[a-zA-Z0-9]*$
        example: "01"
        maxLength: 2
  NoteDetailInfo:
    type: object
    properties:
      noteText:
        description: Description of the case like providing brief summary of the issue
          faced by the customer.
        type: string
        pattern: .*
        example: Card blocked for security purposes
        maxLength: 60
      noteType:
        description: Type of note created to clasify the reason of operation for card.
          Type of case for example lost of card etc.
        type: string
        pattern: ^[a-zA-Z0-9]*$
        example: "1"
        maxLength: 3
      noteStatusCode:
        description: The current status of the note to indicate if note is open or
          close.
        type: string
        pattern: '[CO]'
        example: C
        maxLength: 1
      agentId:
        description: SOE id of Agent who registers the card note
        type: string
        pattern: ^[a-zA-Z0-9]*$
        example: jp34651
      noteDate:
        description: Refers to the system date and time when the actual transaction
          was executed for an account.
        type: string
        format: date-time
        example: "2022-06-22T19:02:30Z"
  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
...