---
swagger: "2.0"
info:
  title: crds-cnf-d-provisioning-organization
  description: This microservice will help to manage the information of organizations
    and branches for provisioning requests of plastic cards
  version: 1.0.0
  x-ibm-name: crds-cnf-d-provisioning-organization
host: 127.0.0.1
basePath: /api
schemes:
- https
produces:
- application/json
paths:
  /v1/cards/provisioning/organization:
    post:
      tags:
      - add-provisioning-organization
      operationId: add-provisioning-organization
      summary: 'LOB: TS&CO Container(OD&T); Feature: Register a new organization or
        branch; Functionality: Register a new organization or branch for future card
        provisionig request'
      description: This API helps to register a new organization or branch for future
        card provisionig request.
      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: addProvisioningOrganizationRequest
        in: body
        required: true
        schema:
          $ref: '#/definitions/AddProvisioningOrganizationRequest'
      responses:
        204:
          description: Successful operation.
        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'
    put:
      tags:
      - update-provisioning-organization
      operationId: update-provisioning-organization
      summary: 'LOB: TS&CO Container(OD&T); Feature: Modify the status of an organization
        or branch; Functionality: Modify the registered status with a new status for
        the indicated organization or branch.'
      description: This API helps to modify the registered status with a new status
        for the indicated organization or branch.
      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: updateProvOrganizationRequest
        in: body
        required: true
        schema:
          $ref: '#/definitions/UpdateProvOrganizationRequest'
      responses:
        204:
          description: Successful operation.
        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/organizations/status:
    put:
      tags:
      - update-provisioning-organization-status
      operationId: update-provisioning-organization-status
      summary: 'LOB: TS&CO Container(OD&T); Feature: Update the status of an organization
        or branch; Functionality: Update the status of an organization or branch.'
      description: This API helps to update the status of an organization or branch.
      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: updateOrganizationStatusRequest
        in: body
        required: true
        schema:
          $ref: '#/definitions/UpdateOrganizationStatusRequest'
      responses:
        204:
          description: Successful operation.
        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/organizations/retrieve:
    post:
      tags:
      - retrieve-provisioning-organization
      operationId: retrieve-provisioning-organization
      summary: 'LOB: TS&CO Container; Feature: Inquiry the information of an organization
        or branch; Functionality: Inquiry the information registered of the organization
        or branch.'
      description: This API helps to inquiry the information registered of the organization
        or branch.
      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: retrieveProvOrganizationRequest
        in: body
        required: true
        schema:
          $ref: '#/definitions/RetrieveProvOrganizationRequest'
      responses:
        200:
          description: Successful operation.
          schema:
            $ref: '#/definitions/RetrieveProvOrganizationResponse'
        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:
  AddProvisioningOrganizationRequest:
    type: object
    properties:
      productCode:
        description: Key of the product contracted by the organization Ex. 01-Bancanet
          Empresarial / TEF Nomina. 02-Digitem / TEF Nomina
        type: string
        maxLength: 2
        example: "02"
      serviceFeeIndicator:
        description: Indicator that specifies if the organization/branch accepts commissions
          for the provisioning service. Ex. 01-Yes. 02-No
        type: string
        maxLength: 2
        example: "01"
      organization:
        $ref: '#/definitions/Organization'
    required:
    - productCode
    - serviceFeeIndicator
    - organization
  UpdateProvOrganizationRequest:
    type: object
    properties:
      productCode:
        description: Key of the product contracted by the organization Ex. 01-Bancanet
          Empresarial / TEF Nomina. 02-Digitem / TEF Nomina
        type: string
        maxLength: 2
        example: "02"
      serviceFeeIndicator:
        description: Indicator that specifies if the organization/branch accepts commissions
          for the provisioning service. Ex. 01-Yes. 02-No
        type: string
        maxLength: 2
        example: "01"
      organization:
        $ref: '#/definitions/Organization'
    required:
    - productCode
    - serviceFeeIndicator
    - organization
  UpdateOrganizationStatusRequest:
    type: object
    properties:
      organizationId:
        description: Identifier of the company or branch that previously was register
          for provisioning requests
        type: string
        maxLength: 16
        example: 0000028804220011
    required:
    - organizationId
  RetrieveProvOrganizationRequest:
    type: object
    properties:
      organizationId:
        description: Identifier of the company that, as a client, hired the payroll
          card for its employees.
        type: string
        maxLength: 16
        example: 0000028804220011
    required:
    - organizationId
  RetrieveProvOrganizationResponse:
    type: object
    properties:
      productCode:
        description: Key of the product contracted by the organization Ex. 01-Bancanet
          Empresarial / TEF Nomina. 02-Digitem / TEF Nomina
        type: string
        maxLength: 2
        example: "02"
      serviceFeeIndicator:
        description: Indicator that specifies if the organization/branch accepts commissions
          for the provisioning service. Ex. 01-Yes. 02-No
        type: string
        maxLength: 2
        example: "01"
      organizationData:
        $ref: '#/definitions/OrganizationData'
    required:
    - productCode
    - serviceFeeIndicator
    - organizationData
  OrganizationData:
    type: object
    properties:
      organizationFullName:
        description: Name of the company/branch that is registered or will be registered
          for plastic cards provisioning
        type: string
        maxLength: 75
        example: Ford Motors Company de México, S.A. de C.V.
      organizationStatusCode:
        description: Organization status. Ex. 0-Active. 1-Inactive. 2-Baja.
        type: string
        maxLength: 2
        example: "1"
      organizationContact:
        $ref: '#/definitions/OrganizationContact'
    required:
    - organizationFullName
    - organizationStatusCode
    - organizationContact
  Organization:
    type: object
    properties:
      organizationId:
        description: Identifier of the company that, as a client, hired the payroll
          card for its employees
        type: string
        maxLength: 16
        example: 0000028804220011
      organizationFullName:
        description: Name of the company/branch that is registered or will be registered
          for plastic cards provisioning
        type: string
        maxLength: 75
        example: Ford Motors Company de México, S.A. de C.V.
      organizationStatusCode:
        description: Organization status. Ex. 00-Activa. 01-Inactiva. 02-Baja.
        type: string
        maxLength: 2
        example: "01"
      organizationContact:
        $ref: '#/definitions/OrganizationContact'
    required:
    - organizationId
    - organizationStatusCode
    - organizationFullName
    - organizationContact
  OrganizationContact:
    type: object
    properties:
      customerId:
        description: Organization(as a customer) identifier assigned to the organziation
          by the Bank
        type: string
        maxLength: 12
        example: "000204453307"
      legalRepresentative:
        $ref: '#/definitions/LegalRepresentative'
    required:
    - customerId
  LegalRepresentative:
    type: object
    properties:
      fullName:
        description: Name of the legal representative responsible for the Organization
        type: string
        maxLength: 55
        example: Juan Perez Perez
      emailAddress:
        description: Email Address of the legal representative responsible for the
          Organization
        type: string
        maxLength: 75
        example: jperezperez@ford.com.mx
      phoneNumber:
        description: Phone Number of the legal representative responsible for the
          Organization
        type: string
        maxLength: 10
        example: "5555688722"
      extensionNumber:
        description: Telephone extension number of the legal representative responsible
          for the Organization
        type: string
        maxLength: 5
        example: "12345"
      faxNumber:
        description: Fax number of the legal representative responsible for the Organization
        type: string
        maxLength: 10
        example: " 5555688904"
    required:
    - fullName
    - phoneNumber
  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
...