---
swagger: "2.0"
info:
  title: crds-cnf-d-card-provisioning-details
  description: This microservice will help to retrive information of provisioning
    related to the card plastics according to certain criteria
  version: 1.0.0
  x-ibm-name: crds-cnf-d-card-provisioning-details
host: 127.0.0.1
basePath: /api
schemes:
- https
produces:
- application/json
paths:
  /v1/cards/provisioning/retrieve:
    post:
      tags:
      - retrieve-card-provisioning
      operationId: retrieve-card-provisioning
      summary: 'LOB: TS&CO Container (OD&T); Feature: Location queries; Functionality:
        Show detail of the provisioning that correspond to the characteristics selected
        in the filters.'
      description: This api retrieves the list of the provisioning of the current
        requests.
      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: retrieveProvisioningRequest
        in: body
        required: true
        schema:
          $ref: '#/definitions/RetrieveProvisioningRequest'
      responses:
        200:
          description: Successful operation.
          schema:
            $ref: '#/definitions/RetrieveProvisioningResponse'
        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/provisioning/detail/retrieve:
    post:
      tags:
      - retrieve-card-provisioning-detail
      operationId: retrieve-card-provisioning-detail
      summary: 'LOB: TS&CO container (OD&T); Feature: Consultation of the remittances
        generated within the provisioning; Functionality: Show the detail of the remittances
        generated within the provisioning selected by the user '
      description: This API retrieves the details of the provisioning generated within
        the allocation selected by the user
      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: retrieveProvisioningDetailRequest
        in: body
        required: true
        schema:
          $ref: '#/definitions/RetrieveProvisioningDetailRequest'
      responses:
        200:
          description: Successful operation.
          schema:
            $ref: '#/definitions/RetrieveProvisioningDetailResponse'
        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/provisioning/inventories/retrieve:
    post:
      tags:
      - retrieve-provisioning-cards-inventories
      operationId: retrieve-provisioning-cards-inventories
      summary: 'LOB: TS&CO Container (OD&T); Feature: Show inventory list; Functionality:
        Show detail of the inventories that correspond to the characteristics selected
        in the filters.'
      description: This api retrieves the detail of the inventories of the card related
        to the provisioning that correspond to the given criteria.
      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: retrieveProvCardsInventoryRequest
        in: body
        required: true
        schema:
          $ref: '#/definitions/RetrieveProvCardsInventoryRequest'
      responses:
        200:
          description: Successful operation.
          schema:
            $ref: '#/definitions/RetrieveProvCardsInventoryResponse'
        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/provisioning/inventories/detail/retrieve:
    post:
      tags:
      - retrieve-provisioning-inventory-detail
      operationId: retrieve-provisioning-inventory-detail
      summary: 'LOB: TS&CO Container(OD&T); Feature: show cards list; Functionality:
        show detail of the selected card that correspond to the inventory selected.'
      description: This Api show detail of the selected card to the inventory list
      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: retrieveProvInventoryDetailRequest
        in: body
        required: true
        schema:
          $ref: '#/definitions/RetrieveProvInventoryDetailRequest'
      responses:
        200:
          description: Successful operation.
          schema:
            $ref: '#/definitions/RetrieveProvInventoryDetailResponse'
        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:
  RetrieveProvisioningRequest:
    type: object
    properties:
      organizationBranch:
        $ref: '#/definitions/OrganizationBranch'
      cardPlastic:
        $ref: '#/definitions/CardPlastic'
      cardProvisioning:
        $ref: '#/definitions/CardProvisioning'
  RetrieveProvisioningDetailRequest:
    type: object
    properties:
      provisioningReferenceNumber:
        description: ' Reference number generated by TS&CO container to identify the
          provisioning request'
        type: string
        example: "168714"
        maxLength: 6
      productSerialNumber:
        description: Identifier that is related to the reference number and depends
          on the number of types of product that are required for the provisioning
        type: string
        example: "0045"
        maxLength: 4
      accountNumber:
        description: Customer's Account Number with the Bank.An account number is
          the primary identifier for ownership of an account, whether a checking account
          or savings account or credit card account or investment account, or a loan
          account.
        type: string
        example: 0000000000004967
        maxLength: 16
    required:
    - provisioningReferenceNumber
    - productSerialNumber
  RetrieveProvCardsInventoryRequest:
    type: object
    properties:
      cardInventory:
        type: array
        minItems: 1
        maxItems: 2
        items:
          $ref: '#/definitions/CardInventory'
  RetrieveProvInventoryDetailRequest:
    type: object
    properties:
      provisioningReferenceNumber:
        description: Reference number generated by TS&CO container to identify the
          provisioning request
        type: string
        example: "168714"
        maxLength: 6
      productSerialNumber:
        description: Identifier that is related to the serial number of the number
          of types of product that are required for the provisioning
        type: string
        example: "0045"
        maxLength: 4
      accountNumber:
        description: Customer's Account Number with the Bank
        type: string
        example: "5256781234567890"
        maxLength: 16
      organizationBranch:
        $ref: '#/definitions/OrganizationBranch'
      cardPlastic:
        $ref: '#/definitions/CardPlasticData'
    required:
    - cardPlastic
  RetrieveProvisioningResponse:
    type: object
    properties:
      moreInformationIndicator:
        description: more information indicator
        type: string
        example: S
        maxLength: 1
      cardProvisioningInfo:
        type: array
        minItems: 1
        maxItems: 100
        items:
          $ref: '#/definitions/CardProvisioningInfo'
    required:
    - moreInformationIndicator
    - cardProvisioningInfo
  RetrieveProvisioningDetailResponse:
    type: object
    properties:
      moreInformationIndicator:
        description: more information indicator
        type: string
        example: S
        maxLength: 1
      cardProvisioning:
        type: array
        minItems: 1
        maxItems: 100
        items:
          $ref: '#/definitions/CardProvisioningDetail'
    required:
    - moreInformationIndicator
    - cardProvisioning
  RetrieveProvCardsInventoryResponse:
    type: object
    properties:
      moreInformationIndicator:
        description: more information indicator
        type: string
        example: S
        maxLength: 1
      cardInventoryInfo:
        type: array
        minItems: 1
        maxItems: 100
        items:
          $ref: '#/definitions/CardInventoryInfo'
    required:
    - moreInformationIndicator
    - cardInventoryInfo
  RetrieveProvInventoryDetailResponse:
    type: object
    properties:
      moreInformationIndicator:
        description: more information indicator
        type: string
        example: S
        maxLength: 1
      cardInventoryDetail:
        type: array
        minItems: 1
        maxItems: 100
        items:
          $ref: '#/definitions/CardInventoryDetail'
    required:
    - moreInformationIndicator
    - cardInventoryDetail
  CardInventory:
    type: object
    properties:
      organizationBranch:
        $ref: '#/definitions/OrganizationBranch'
      cardPlastic:
        $ref: '#/definitions/CardPlastic'
  CardInventoryInfo:
    type: object
    properties:
      totalCardCount:
        description: Number of total cards that match the given criteria
        type: integer
        format: int32
        minimum: 1
        maximum: 999999
        example: 65
      availableCardCount:
        description: Number of available cards in inventory
        type: integer
        format: int32
        minimum: 1
        maximum: 999999
        example: 50
      assignedCardCount:
        description: Number of assigned cards in inventory
        type: integer
        format: int32
        minimum: 1
        maximum: 999999
        example: 15
      organizationBranch:
        $ref: '#/definitions/OrganizationBranch'
      cardPlastic:
        $ref: '#/definitions/CardPlasticData'
    required:
    - totalCardCount
    - availableCardCount
    - assignedCardCount
    - cardPlastic
  CardInventoryDetail:
    type: object
    properties:
      provisioningReferenceNumber:
        description: Reference number generated by TS&CO container to identify the
          provisioning request
        type: string
        example: "168714"
        maxLength: 6
      productSerialNumber:
        description: Identifier that is related to the reference number and depends
          on the number of types of product that are required for the provisioning
        type: string
        example: "0045"
        maxLength: 4
      cardProvisioningDetail:
        $ref: '#/definitions/CardProvisioningDetail'
    required:
    - provisioningReferenceNumber
    - productSerialNumber
    - cardProvisioningDetail
  OrganizationBranch:
    type: object
    properties:
      sirh:
        description: SIRH of the branch that promoted the contract obtained by this
          web service
        type: string
        example: "0001"
        maxLength: 4
      organizationId:
        description: Identifier of the enterprise that required the provisioning
        type: string
        example: "0000000000000045"
        maxLength: 16
      organizationBranchId:
        description: Identifier of the Work unit related to the organization
        type: string
        example: 0000000000004967
        maxLength: 16
      organizationStructureCode:
        description: This is an attribute that helps to indentify if the client is
          a member of some civil asociation or a non-profit group, Ex 0000-None
        type: string
        example: "0000"
        maxLength: 4
  CardPlastic:
    type: object
    properties:
      bankIdentificationNumber:
        description: Card number Bin related to the provisioning of the requested
          plastic cards
        type: string
        example: "881052"
        maxLength: 6
      cardPlasticId:
        description: Type or design of the plastic card required for the provisioning
        type: string
        maxLength: 2
        example: "01"
      cardUsageCode:
        description: 'It helps to identify what the card provisioning request is destined
          for: sell, change or corporative'
        type: string
        example: "01"
        maxLength: 2
  CardPlasticData:
    type: object
    properties:
      bankIdentificationNumber:
        description: Card number Bin related to the provisioning of the requested
          plastic cards
        type: string
        example: "881052"
        maxLength: 6
      cardPlasticId:
        description: Type or design of the plastic card required for the provisioning
        type: string
        maxLength: 2
        example: "01"
      cardUsageCode:
        description: 'It helps to identify what the card provisioning request is destined
          for: sell, change or corporative'
        type: string
        example: "01"
        maxLength: 2
    required:
    - bankIdentificationNumber
  CardProvisioning:
    type: object
    properties:
      requestDate:
        description: Date that indicates when the provisioning request was created
          in format aaaa-mm-dd
        type: string
        example: "2022-01-14"
        format: date
        maxLength: 10
      provisioningStatusCode:
        description: Status of the provisioning request in its lifecycle. This field
          is captured by the user in the search criteria
        type: string
        example: "01"
        maxLength: 2
      provisioningReferenceNumber:
        description: Reference number generated by TS&CO container to identify the
          provisioning request
        type: string
        example: "000001"
        maxLength: 6
      productSerialNumber:
        description: Identifier that is related to the serial number of the number
          of types of product that are required for the provisioning
        type: string
        example: "000001"
        maxLength: 4
  CardProvisioningInfo:
    type: object
    properties:
      cardRequestedCount:
        description: It denotes the number of plastic cards requested
        type: integer
        format: int32
        minimum: 1
        maximum: 999999
        example: 100
      requestTypeCode:
        description: It is the type of the provisioning request. Ex- Automatic, Special
        type: string
        example: "01"
        maxLength: 2
      requestDate:
        description: Date that indicates when the provisioning request was created
          in format aaaa-mm-dd
        type: string
        example: "2022-01-14"
        format: date
        maxLength: 10
      provisioningStatusCode:
        description: Status of the provisioning request in its lifecycle. This field
          is captured by the user in the search criteria
        type: string
        example: "01"
        maxLength: 2
      provisioningReferenceNumber:
        description: Reference number generated by TS&CO container to identify the
          provisioning request
        type: string
        example: "000001"
        maxLength: 6
      productSerialNumber:
        description: Identifier that is related to the serial number of the number
          of types of product that are required for the provisioning
        type: string
        example: "000001"
        maxLength: 4
      organizationBranch:
        $ref: '#/definitions/OrganizationBranch'
      cardPlastic:
        $ref: '#/definitions/CardPlasticData'
    required:
    - provisioningReferenceNumber
    - productSerialNumber
    - requestTypeCode
    - provisioningStatusCode
    - requestDate
    - cardPlastic
    - cardRequestedCount
  CardProvisioningDetail:
    type: object
    properties:
      accountNumber:
        description: Customer's Account Number with the Bank.An account number is
          the primary identifier for ownership of an account, whether a checking account
          or savings account or credit card account or investment account, or a loan
          account.
        type: string
        example: 0000000000004967
        maxLength: 16
      accountStatusCode:
        description: Account Status code that defines if the account has been created
          in S111. 00-Not created, 01-Sent to S111
        type: string
        example: "01"
        maxLength: 2
      cardStatusCode:
        description: The different status of card palstic are Active, Block, Canceled..
          Etc
        type: string
        example: "02"
        maxLength: 2
      billingCycleDay:
        description: Day that is assigned to the account so that is cut off periodically.
        type: string
        example: "14"
        maxLength: 2
      requestDate:
        description: Date that indicates when the provisioning request was created
          in format aaaa-mm-dd
        type: string
        example: "2022-01-14"
        format: date
        maxLength: 10
      lastStatusUpdateDate:
        description: Date of the last change of status of the plastic within the S111
          system.
        type: string
        example: "2022-01-14"
        format: date
        maxLength: 10
      lastTransactionDate:
        description: Date of the last transaction made by the card
        type: string
        example: "2022-01-14"
        format: date
        maxLength: 10
      branchDeliveryDate:
        description: The date on which the supply of plastic cards arrived at the
          branch or company
        type: string
        example: "2022-01-14"
        format: date
        maxLength: 10
      receivedDate:
        description: Date when the card is sold to the customer.
        type: string
        example: "2022-01-14"
        format: date
        maxLength: 10
      activationDate:
        description: The date when the card plastic is activated.The date is captured
          in ISO 8601, YYYY-MM-DD format.
        type: string
        example: "2022-01-14"
        format: date
        maxLength: 10
      expiryDate:
        description: The date on which the card becomes invalid/expired. The customer
          can place a request for new card on or before the expiry date of the existing
          card plastic.
        type: string
        example: "2022-01-14"
        format: date
        maxLength: 10
      authorizationStartDate:
        description: Date when the authorization process of the provisioning request
          begins.
        type: string
        example: "2022-01-14"
        format: date
        maxLength: 10
      startDate:
        description: It is the date when the use of plastics begins.
        type: string
        example: "2022-01-14"
        format: date
        maxLength: 10
      branchTradeDate:
        description: Date of transfer of plastics between bank branches
        type: string
        example: "2022-01-14"
        format: date
        maxLength: 10
      embossedNameFlag:
        description: Flag that indicated if the card is sold and is personalized with
          the client's name
        type: boolean
        example: true
      inventoryAvailabilityFlag:
        description: Status of availability of plastic in the inventory of branch
          or company
        type: boolean
        example: true
      activationStatusCode:
        description: Card activation status.
        type: string
        example: "01"
        maxLength: 2
      sirh:
        description: sirh of the branch where was sold the card.
        type: string
        example: "0001"
        maxLength: 4
      cardAvailableFlag:
        description: Indicator or final monitoring status of the card in process when
          it is available, closed. When the plastic is already sold.
        type: boolean
        example: true
      tellerCode:
        description: Code of the executive who received the endowment of plastics
          in a branch.
        type: string
        example: "061370266314"
        maxLength: 12
      registeredAddressFlag:
        description: Flag that indicates if the address was provided by the client
          when requesting the plastic card.
        type: boolean
        example: true
    required:
    - accountNumber
    - accountStatusCode
    - cardStatusCode
    - billingCycleDay
    - requestDate
    - lastStatusUpdateDate
    - lastTransactionDate
    - branchDeliveryDate
    - receivedDate
    - activationDate
    - expiryDate
    - authorizationStartDate
    - startDate
    - branchTradeDate
    - embossedNameFlag
    - inventoryAvailabilityFlag
    - activationStatusCode
    - sirh
    - cardAvailableFlag
    - tellerCode
    - registeredAddressFlag
  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 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
security:
- OAuth2 Application Flow:
  - /api/v1
  ClientID: []
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
  ClientID:
    type: apiKey
    description: ""
    in: header
    name: X-IBM-Client-Id
x-ibm-endpoints:
- endpointUrl: https://perf.api.externalapib2b.wlb.lac.nsroot.net:7100/mx-gcgapi/perfext
  type:
  - production
  - development
...