---
swagger: "2.0"
info:
  title: CRDS-CCC-V-CardServicingAction
  description: This microservice retrieves different status from cards and perform
    servicing actions to them
  version: 1.0.0
  x-ibm-name: crds-ccc-v-cardservicingaction
host: 127.0.0.1
schemes:
- https
basePath: /api
produces:
- application/json
paths:
  /v1/cards/servicing/action/retrieve:
    post:
      tags:
      - card-servicing-action-data
      operationId: card-servicing-action-data
      summary: To retrieve detail of all servicing actions for the cards of the customer
      description: This API is used to retrieve detail of all servicing actions for
        the cards of the customer
      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: false
        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: sid
        in: header
        required: true
        type: string
        description: SessionId sent by Consumer
      - name: operationId
        in: query
        required: false
        type: integer
        description: Id for the operation to be performed.
      - name: cardsActionStatusesRequest
        in: body
        schema:
          $ref: '#/definitions/CardServicingActionRequest'
      responses:
        200:
          description: Successful operation.
          schema:
            $ref: '#/definitions/CardServicingActionResponse'
        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:
  CardServicingActionRequest:
    type: object
    properties:
      cardAccount:
        type: array
        items:
          $ref: '#/definitions/CardAccount'
  CardAccount:
    type: object
    properties:
      accountId:
        description: Unique ID used by front end to identify the account
        type: string
        example: "123456"
  CardServicingActionResponse:
    type: object
    properties:
      invalidAccounts:
        type: array
        items:
          $ref: '#/definitions/InvalidAccount'
      cardAccountDetail:
        type: array
        items:
          $ref: '#/definitions/CardAccountDetail'
  CardAccountDetail:
    type: object
    properties:
      validResponseFlag:
        description: validResponseFlag
        type: boolean
        example: true
      invalidResponseMessage:
        description: invalidResponseMessage
        type: string
        example: the account doesn't exists
      accountId:
        description: Unique ID used by front end to identify the account
        type: string
        example: "123456"
      accountNumber:
        description: The account associated to the customer
        type: string
        example: 000000000000149078
      branchId:
        description: The branch id where the account was created
        type: string
        example: "1234"
      accountType:
        description: Type of the account
        type: integer
        format: int32
        example: 1
      accountTypeDescription:
        description: Name of the type of the account
        type: string
        example: Cuenta maestra
      currencyCode:
        description: The currency code identifier of the account
        type: integer
        format: int32
        example: 1
      currencyCodeDescription:
        description: Currency Code of the account
        type: string
        example: MXN
      accountNickName:
        description: Nickname of the account
        type: string
        example: Mi cuenta favorita
      productCode:
        description: Product code that identify the type of account
        type: integer
        format: int32
        example: 66
      productInstrument:
        description: The product instrument code
        type: integer
        format: int32
        example: 12
      accountAlias:
        description: CLABE of the account
        type: string
        example: "123456789123"
      productName:
        description: The product name
        type: string
        example: Checking Account
      displayAccountNumber:
        description: Tha last digits of the account or card
        type: string
        example: "1234"
      deviceAccessData:
        type: array
        items:
          $ref: '#/definitions/AccountMediaAccess'
    required:
    - accountId
    - accountNumber
    - displayAccountNumber
    - productCode
    - productInstrument
    - currencyCode
    - currencyCodeDescription
    - accountType
    - accountTypeDescription
  AccountMediaAccess:
    type: object
    properties:
      deviceAccessUniqueId:
        description: Unique ID used by front end to identify the account as a device
          access
        type: string
        example: "23234"
      deviceAccessStatus:
        description: status of access Media
        type: integer
        format: int64
        example: 0
      deviceAccessStatusDescription:
        description: description of access media status
        type: string
        example: ACTIVO HASTA SU VENCIMIENTO
      deviceAccessType:
        description: type of device Access Media
        type: integer
        format: int32
        example: 0
      deviceAccessTypeDescription:
        description: description of type of device Access Media
        type: string
        example: Chequera
      deviceAccessNickName:
        description: Nickname of the account
        type: string
        example: Mi cuenta favorita
      productName:
        description: The product name
        type: string
        example: Checking Account
      displayDeviceAccessNumber:
        description: displayAccessMedia
        type: string
        example: "123"
      deviceAccessPrefix:
        description: The device access prefix which is first four digits of account/card
        type: string
        example: "7002"
      cardPlastic:
        $ref: '#/definitions/CardPlastic'
    required:
    - deviceAccessUniqueId
    - deviceAccessStatus
    - deviceAccessStatusDescription
    - deviceAccessTypeDescription
    - deviceAccessType
    - displayDeviceAccessNumber
    - deviceAccessPrefix
  CardPlastic:
    type: object
    properties:
      cardType:
        description: Type of the card
        type: string
        example: Credit
      cardStatus:
        description: Status of the card
        type: string
        example: Active
      creditLimitAmount:
        description: Credit limit amount on the card account
        type: number
        format: double
        example: 1200.560000
      cardLockedFlag:
        description: Flag to check whether card is locked or not
        type: boolean
        example: false
      pinChangeRequiredFlag:
        description: Flag to specify whether pin change is required for this account
        type: boolean
        example: false
    required:
    - cardType
    - cardStatus
  InvalidAccount:
    type: object
    properties:
      validResponseFlag:
        description: validResponseFlag
        type: boolean
        example: true
      invalidResponseMessage:
        description: invalidResponseMessage
        type: string
        example: the account doesn't exists
      account:
        $ref: '#/definitions/Account'
  Account:
    type: object
    properties:
      accountId:
        description: Unique ID used by front end to identify the account
        type: string
        example: "123456"
      accountNumber:
        description: The account associated to the customer
        type: string
        example: 000000000000149078
      branchId:
        description: The branch id where the account was created
        type: string
        example: "1234"
      productCode:
        description: Product code that identify the type of account
        type: integer
        format: int32
        example: 66
      productInstrument:
        description: The product instrument code
        type: integer
        format: int32
        example: 12
      accountAlias:
        description: CLABE of the account
        type: string
        example: "123456789123"
      accountType:
        description: ""
        type: integer
        format: int32
        example: 1
      accountTypeDescription:
        description: Name of the type of the account
        type: string
        example: Cuenta maestra
      productName:
        description: The product name
        type: string
        example: Checking Account
      currencyCode:
        description: The currency code identifier of the account
        type: integer
        format: int32
        example: 1
      currencyCodeDescription:
        description: Currency Code of the account
        type: string
        example: MXN
      deviceAccessData:
        type: array
        items:
          $ref: '#/definitions/AccountMediaAccessDetail'
    required:
    - accountId
    - productCode
    - productInstrument
    - currencyCode
    - currencyCodeDescription
    - accountType
    - accountTypeDescription
    - productName
  AccountMediaAccessDetail:
    type: object
    properties:
      deviceAccessId:
        description: access Media Id
        type: string
        example: "123456789012"
      deviceAccessStatus:
        description: access Media status
        type: integer
        format: int32
        example: 1
      deviceAccessStatusDescription:
        description: description of access media status
        type: string
        example: ACTIVO HASTA SU VENCIMIENTO
      deviceAccessType:
        description: type of device Access Media
        type: integer
        format: int32
        example: 1
      deviceAccessTypeDescription:
        description: description of type of device Access Media
        type: string
        example: Chequera
      deviceAccessPrefix:
        description: The device access prefix which is first four digits of account/card
        type: string
        example: "7002"
      deviceAccessUniqueId:
        description: Unique ID used by front end to identify the account as a device
          access
        type: string
        example: "23234"
      productName:
        description: The product name
        type: string
        example: Checking Account
    required:
    - deviceAccessId
    - deviceAccessStatus
    - deviceAccessType
    - deviceAccessPrefix
    - deviceAccessStatusDescription
    - deviceAccessTypeDescription
    - deviceAccessUniqueId
  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
...