---
swagger: "2.0"
info:
  title: SERV-CTC-V-Disputes
  description: This Service provides functionality for self-service disputes for being
    used by Front-End
  version: 1.2.0
  x-ibm-name: serv-ctc-v-disputes
host: 127.0.0.1
schemes:
- https
basePath: /api
produces:
- application/json
paths:
  /v1/servicing/disputes/cases/retrieve:
    post:
      tags:
      - retrieve-case-information
      operationId: retrieve-case-information
      summary: retrieve-case-information
      description: This API retrieves the detail of the created cases related to an
        account Id between a selected period
      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: 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: ChannelId
        in: header
        required: true
        type: string
        description: Channel where request originated
      - name: sid
        in: header
        required: true
        type: string
        description: SessionId sent by Consumer
      - name: retrieveCaseInformationRequest
        in: body
        schema:
          $ref: '#/definitions/RetrieveCaseInformationRequest'
      responses:
        200:
          description: Successful operation.
          schema:
            $ref: '#/definitions/RetrieveCaseDetailResponse'
        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'
  /v2/servicing/disputes/cases/retrieve:
    post:
      tags:
      - retrieve-case-information-v2
      operationId: retrieve-case-information-v2
      summary: retrieve-case-information
      description: This API retrieves the detail of the created cases related to an
        account Id between a selected period
      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: 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: ChannelId
        in: header
        required: true
        type: string
        description: Channel where request originated
      - name: sid
        in: header
        required: true
        type: string
        description: SessionId sent by Consumer
      - name: retrieveCaseInformationRequest
        in: body
        schema:
          $ref: '#/definitions/RetrieveCaseInformationV2Request'
      responses:
        200:
          description: Successful operation.
          schema:
            $ref: '#/definitions/RetrieveCaseDetailV2Response'
        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:
  RetrieveCaseInformationRequest:
    type: object
    properties:
      account:
        $ref: '#/definitions/Account'
      startDate:
        description: Start date of the query
        type: string
        format: date
        example: "2020-01-01"
      endDate:
        description: Final date of the query
        type: string
        format: date
        example: "2020-12-31"
    required:
    - startDate
    - endDate
  RetrieveCaseDetailResponse:
    type: array
    items:
      $ref: '#/definitions/CaseData'
  CaseData:
    type: object
    properties:
      deviceAccessUniqueId:
        description: Unique ID used by front end to identify the account as a device
          access
        type: string
        example: "23234"
      complaintDate:
        description: Date when the complaint was registered by the user or customer.
          Format YYYY-MM-DD
        type: string
        format: date
        example: "2016-10-01"
      caseDetail:
        $ref: '#/definitions/CaseDetail'
    required:
    - deviceAccessUniqueId
  CaseDetail:
    type: object
    properties:
      caseNumber:
        description: Unique number assigned to the case for identification.
        type: string
        example: I8092510496
        maxLength: 11
      caseStatus:
        description: Case Status refers to the present stage or status of the case,
          possible values WIP CIF CIB
        type: string
        example: WIP
        maxLength: 3
      caseStatusDescription:
        description: Description of case Status
        type: string
        example: Work In Progress
        maxLength: 15
      closedDate:
        description: Close date of the case, Format YYYY-MM-DD
        type: string
        format: date
        example: "2016-10-01"
      resolvedDate:
        description: Date when the case got resolved.
        type: string
        format: date
        example: "2016-10-01"
      caseReopenedFlag:
        description: Flag indicating, If the case is reopened.
        type: boolean
        example: true
      dispute:
        $ref: '#/definitions/DisputeDetail'
    required:
    - caseNumber
    - caseStatus
    - caseStatusDescription
    - closedDate
  DisputeDetail:
    type: object
    properties:
      disputeAmount:
        description: Dispute Amount
        type: number
        format: double
        example: 200.500000
      transactionAmount:
        description: Refers to the total amount of transaction
        type: number
        format: double
        example: 200.500000
      transactionDate:
        description: Transaction date. Format YYYY-MM-DD
        type: string
        format: date
        example: "2016-10-01"
      merchantName:
        description: Name of the merchant against whom dispute have been raised.
        type: string
        example: Walmart
        maxLength: 30
      disputeType:
        description: Type of dispute
        type: string
        example: DIS
    required:
    - transactionAmount
    - transactionDate
  Account:
    type: object
    properties:
      accountId:
        description: Account Id of the customer who is creating a dispute.
        type: string
        example: "3999279922"
        maxLength: 12
  RetrieveCaseInformationV2Request:
    type: object
    properties:
      account:
        $ref: '#/definitions/AccountV2'
      startDate:
        description: Start date of the query
        type: string
        format: date
        example: "2020-01-01"
      endDate:
        description: Final date of the query
        type: string
        format: date
        example: "2020-12-31"
    required:
    - startDate
    - endDate
  RetrieveCaseDetailV2Response:
    type: object
    properties:
      accounts:
        type: array
        items:
          $ref: '#/definitions/AccountDisputeV2'
  AccountDisputeV2:
    type: object
    properties:
      deviceAccessUniqueId:
        description: Unique ID used by front end to identify the account as a device
          access
        type: string
        example: "23234"
      displayDeviceAccessNumber:
        description: The last digits of the Access Media Id
        type: string
        example: "12345"
        maxLength: 5
      deviceAccessStatus:
        description: Device access status active, inactive, canceled, blocked, etc.
        type: integer
        format: int32
        example: 10
      deviceAccessStatusDescription:
        description: description of access media status
        type: string
        example: ACTIVE UNTIL EXPIRATION
      bankIdentificationNumber:
        description: A bank identification number (BIN) is the initial four to six
          numbers that appear on a credit card
        type: string
        example: "123456"
      productName:
        description: Name by which the Product is known across enterprise
        type: string
        example: Checking Account
      cardType:
        description: Type of the card- Debit/ Credit
        type: string
        example: Debit
      cardHolderType:
        description: Identifies the type of card user such as Primary or Suplementary.
        type: string
        example: PRIMARY
      cases:
        type: array
        items:
          $ref: '#/definitions/CaseDataV2'
    required:
    - deviceAccessUniqueId
    - displayDeviceAccessNumber
    - bankIdentificationNumber
  CaseDataV2:
    type: object
    properties:
      complaintDate:
        description: Date when the complaint was registered by the user or customer.
          Format YYYY-MM-DD
        type: string
        format: date
        example: "2016-10-01"
      caseDetail:
        $ref: '#/definitions/CaseDetailV2'
  CaseDetailV2:
    type: object
    properties:
      caseNumber:
        description: Unique number assigned to the case for identification.
        type: string
        example: I8092510496
        maxLength: 11
      caseStatus:
        description: Case Status refers to the present stage or status of the case,
          possible values WIP CIF CIB
        type: string
        example: WIP
        maxLength: 3
      caseStatusDescription:
        description: Description of case Status
        type: string
        example: Work In Progress
        maxLength: 15
      closedDate:
        description: Close date of the case, Format YYYY-MM-DD
        type: string
        format: date
        example: "2016-10-01"
      resolvedDate:
        description: Date when the case got resolved.
        type: string
        format: date
        example: "2016-10-01"
      caseReopenedFlag:
        description: Flag indicating, If the case is reopened.
        type: boolean
        example: true
      dispute:
        $ref: '#/definitions/DisputeDetailV2'
    required:
    - caseNumber
    - caseStatus
    - caseStatusDescription
    - closedDate
  DisputeDetailV2:
    type: object
    properties:
      disputeAmount:
        description: Dispute Amount
        type: number
        format: double
        example: 200.500000
      transactionAmount:
        description: Refers to the total amount of transaction
        type: number
        format: double
        example: 200.500000
      transactionDate:
        description: Transaction date. Format YYYY-MM-DD
        type: string
        format: date
        example: "2016-10-01"
      merchantName:
        description: Name of the merchant against whom dispute have been raised.
        type: string
        example: Walmart
        maxLength: 30
      disputeType:
        description: Type of dispute
        type: string
        example: DIS
    required:
    - transactionAmount
    - transactionDate
  AccountV2:
    type: object
    properties:
      accountId:
        description: Account Id of the customer who is creating a dispute.
        type: string
        example: "3999279922"
        maxLength: 12
  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: URI to human readable documentation or detailed description of
          the error
        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://sandbox.externalapib2b.wlb.nam.nsroot.net:7101/mx-gcgapi-uat/sandbox2/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://sandbox.externalapib2b.wlb.nam.nsroot.net:7101/mx-gcgapi-uat/sandbox2
  type:
  - production
  - development
...