---
swagger: "2.0"
info:
  title: SERV-SOR-V-PayrollPortabilityInformation
  description: The Microservice manages the activities related to Payroll Portability
    of customers from and to Banamex Accounts
  version: 1.0.0
  x-ibm-name: serv-sor-v-payrollportabilityinformation
host: 127.0.0.1
schemes:
- https
basePath: /api
produces:
- application/json
paths:
  /v1/servicing/accounts/payroll/portability:
    get:
      tags:
      - retrieve-payroll-portability-info
      operationId: retrieve-payroll-portability-info
      summary: The API retrieves the details of payroll portability request
      description: The API retrieves the details of payroll portability 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: 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: 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
      responses:
        200:
          description: Successful operation.
          schema:
            $ref: '#/definitions/RetrievePayrollPortabilityResponse'
        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/servicing/accounts/payroll/portability/manage:
    post:
      tags:
      - create-payroll-portability-info
      operationId: create-payroll-portability-info
      summary: To create the request of payroll portability for the customer
      description: The API is used to create the request of payroll portability for
        the customer
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - name: client_id
        in: header
        required: true
        type: string
        description: Client ID generated during application registration
      - name: Authorization
        in: header
        required: true
        type: string
        description: The Authorization Token received during login
      - name: Accept
        in: header
        required: true
        type: string
        description: Content-Types that are acceptable for the response
      - name: uuid
        in: header
        required: true
        type: string
        description: 128 bit UUID that you generate for every request
      - name: Accept-Language
        in: header
        required: false
        type: string
        description: List of acceptable human languages for response
      - name: Content-Type
        in: header
        required: true
        type: string
        description: Content-Types that are sent in the request
      - name: ChannelId
        in: header
        required: true
        type: string
        description: Channel where request originated
      - name: sid
        in: header
        required: true
        type: string
        description: SessionId sent by Consumer
      - 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: createPayrollPortabilityRequest
        in: body
        schema:
          $ref: '#/definitions/CreatePayrollPortabilityRequest'
      responses:
        200:
          description: Successful operation.
          schema:
            $ref: '#/definitions/CreatePayrollPortabilityResponse'
        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:
      - cancel-payroll-portability-info
      operationId: cancel-payroll-portability-info
      summary: To cancel the request of payroll portability for the customer
      description: The API is used to cancel the request of payroll portability for
        the customer
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - name: client_id
        in: header
        required: true
        type: string
        description: Client ID generated during application registration
      - name: Authorization
        in: header
        required: true
        type: string
        description: The Authorization Token received during login
      - name: Accept
        in: header
        required: true
        type: string
        description: Content-Types that are acceptable for the response
      - name: uuid
        in: header
        required: true
        type: string
        description: 128 bit UUID that you generate for every request
      - name: Accept-Language
        in: header
        required: false
        type: string
        description: List of acceptable human languages for response
      - name: Content-Type
        in: header
        required: true
        type: string
        description: Content-Types that are sent in the request
      - name: ChannelId
        in: header
        required: true
        type: string
        description: Channel where request originated
      - name: sid
        in: header
        required: true
        type: string
        description: SessionId sent by Consumer
      - 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: cancelPayrollPortabilityRequest
        in: body
        schema:
          $ref: '#/definitions/CancelPayrollPortabilityRequest'
      responses:
        200:
          description: Successful operation.
          schema:
            $ref: '#/definitions/CancelPayrollPortabilityResponse'
        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:
  RetrievePayrollPortabilityResponse:
    type: object
    properties:
      birthDate:
        description: customer's date of birth
        type: string
        format: date
        example: "1989-12-26"
      application:
        $ref: '#/definitions/PortabilityApplication'
  PortabilityApplication:
    type: object
    properties:
      applicationDate:
        description: date of application submission
        type: string
        format: date
        example: "2019-12-26"
      applicationStatus:
        description: portability application status
        type: string
        example: "1"
      cancellationReason:
        description: application rejection description
        type: string
        example: "13"
      channelType:
        description: Last Requestor Channel
        type: string
        example: "1"
      createdByAgentId:
        description: user id of application creator
        type: string
        example: sb12345
      folio:
        description: EBPM Folio generated for portability request
        type: string
        example: "7863289379"
      lastApplicationDate:
        description: Last application date
        type: string
        format: date
        example: "2019-12-26"
      lastApplicationType:
        description: last request operation
        type: string
        example: "1"
      lastUpdatedDate:
        description: date of last update made to payroll portability
        type: string
        format: date
        example: "2019-12-26"
      rejectionReason:
        description: reason of portability rejection
        type: string
        example: "12"
      updatedByAgentId:
        description: request updated by user
        type: string
        example: ab12345
      destinationAccount:
        $ref: '#/definitions/DestinationAccount'
      sourceAccount:
        $ref: '#/definitions/SourceAccount'
  DestinationAccount:
    type: object
    properties:
      accountAlias:
        description: CLABE number of the account
        type: string
        example: "12345678901234"
      accountId:
        type: string
        description: unique identifier of account mapped to account number
        example: "12345678"
      accountType:
        description: type of account
        type: string
        example: checking
      bankId:
        description: bank id
        type: string
        example: BNX
      bankName:
        description: Bank Name
        type: string
        example: Banamex
      customerId:
        description: unique identifier of the customer
        type: string
        example: "123456789012"
  SourceAccount:
    type: object
    properties:
      accountAlias:
        description: CLABE number of the account
        type: string
        example: "12345678901234"
      accountNumber:
        description: account number of the customer
        type: string
        example: "1234567890"
      accountType:
        description: type of account
        type: string
        example: Checking
      bankId:
        description: unique identifier of bank
        type: string
        example: BNX
      bankName:
        description: bank name
        type: string
        example: Banamex
      branchId:
        description: branch id of the account
        type: string
        example: "1234"
  CreatePayrollPortabilityRequest:
    type: object
    properties:
      customerId:
        description: unique identifier of customer
        type: string
        example: "123456789012"
      portabilityApplication:
        $ref: '#/definitions/PortabilityApplicationInfo'
      security:
        $ref: '#/definitions/Security'
    required:
    - customerId
  PortabilityApplicationInfo:
    type: object
    properties:
      channelType:
        description: Requestor Channel
        type: string
        example: Bancanet
      portabilityType:
        description: Code to indicate if the portability is to or from banamex account.
          Values S for send or R to receive
        type: string
        example: S
      sourceAccountInfo:
        $ref: '#/definitions/SourceAccountInfo'
      destinationAccountInfo:
        $ref: '#/definitions/DestinationAccountInfo'
    required:
    - portabilityType
  SourceAccountInfo:
    type: object
    properties:
      accountId:
        type: string
        description: unique identifier of account mapped to account number
        example: "12345678"
      accountAlias:
        description: CLABE number of the account
        type: string
        example: "12345678901234"
      accountNumber:
        description: account number of the customer
        type: string
        example: "1234567890"
      cardNumber:
        description: Number of the Card.
        type: string
        example: "566233800020356"
      accountType:
        description: type of account
        type: string
        example: Checking
      bankId:
        description: unique identifier of bank
        type: string
        example: "12"
      bankName:
        description: bank name
        type: string
        example: Banamex
      branchId:
        description: branch id of the account
        type: string
        example: "1234"
  DestinationAccountInfo:
    type: object
    properties:
      accountId:
        type: string
        description: unique identifier of account mapped to account number
        example: "12345678"
      accountAlias:
        description: CLABE number of the account
        type: string
        example: "12345678901234"
      accountNumber:
        description: account number of the customer
        type: string
        example: "1234567890"
      accountType:
        description: type of account
        type: string
        example: checking
      bankId:
        description: bank id
        type: string
        example: "12"
      bankName:
        description: Bank Name
        type: string
        example: Banamex
      branchId:
        description: branch id of the account
        type: string
        example: "1234"
      cardNumber:
        description: card number of the customer
        type: string
        example: "1234567890123456"
      caseId:
        description: Unique identifier associated with Case
        type: string
        example: "232333"
  CreatePayrollPortabilityResponse:
    type: object
    properties:
      folio:
        description: EBPM Folio generated for portability request
        type: string
        example: "7863289379"
      portabilityTimeStamp:
        description: Time stamp when the portability is made it
        type: string
        format: dateTime
        example: 02/07/2020 18:20:40
    required:
    - portabilityTimeStamp
  Security:
    type: object
    properties:
      lastEncryptedChallenge:
        type: string
        example: 0736H4sIAAAAAAAAAI1STWgTQRR+2SbUNBWq6MFbaEUQIT+SmoSeQtrDyhqDWxXsQSababKyM7POvm2SCp4KQu+eBa967cWbR2+ePAjeBfEgiNSbbzbbNtYeHBjm/b/vfW/efodcpGG5xyQTfFzyKrXq43qlUtr0hS8HrRiHXLrIkP/e/fypFLV/WZC5DfkImUaK4WMNxYh7seaeEmGMlFSKRtwrzaS+PvhhHbb2OhYUbLgs2rHWXOI0AH2PodI2LImuVqg8FTzgOvKVtKEg7nGMtbTltjLa/YhrW1KTyIFFMc1vK9FTCBedJ2yHlQMmB2UXNaFY24KcWGfUH65vOacglg3E8l8ITOiaA/PC7hvxKTwHy4E8qRsUgpPUYPybk5Cn6iVxV/sDX7JgBk7qOy9cHplJ2kMWBIlxHML0fKCbMRchX62kJ9ZnQJ1lcxbqx9zVFwfvX96wAJKqc7TGlTNz1ye0W9/rjpLBfr678nWn/u2ZBfOPiKENb5hwe8eXFOD6u9yBBZEg5nJwNGZiCU/mMDwYi90/Vjt8RAVSNSuOZPof1/5vIrW/t3L45c2yBVkDqIW0xl6MPLJN9Vj0uHYIcIf+adolJ443YSjIwpTQCy7b5g+V7he7AaOGsUBYOCHB0A4IhWqxVm00i/XV5q2QTmTqnEvXY4VGW0zk8B/v3GkvwhKtr7parzUa9eZNIyNkY/qu9MgUcI4gZgTmX+3/AT2pjop1AwAA=
        description: 'Challenge previously received (must be same as the given from
          get challenge service), composed by "Challenge" : "String State". This is
          encrypted by the frontend using <a href="https://apis-ccp.citibank.nam.nsroot.net:20000/swagger-ui/#!/securityTokenService-jwt">Platform
          End-to-End encryption APIs</a>.'
      encryptedChallengeToken:
        type: string
        example: 0736H4sIAAAAAAAAAI1STWgTQRR+2SbUNBWq6MFbaEUQIT+SmoSeQtrDyhqDWxXsQSababKyM7POvm2SCp4KQu+eBa967cWbR2+ePAjeBfEgiNSbbzbbNtYeHBjm/b/vfW/efodcpGG5xyQTfFzyKrXq43qlUtr0hS8HrRiHXLrIkP/e/fypFLV/WZC5DfkImUaK4WMNxYh7seaeEmGMlFSKRtwrzaS+PvhhHbb2OhYUbLgs2rHWXOI0AH2PodI2LImuVqg8FTzgOvKVtKEg7nGMtbTltjLa/YhrW1KTyIFFMc1vK9FTCBedJ2yHlQMmB2UXNaFY24KcWGfUH65vOacglg3E8l8ITOiaA/PC7hvxKTwHy4E8qRsUgpPUYPybk5Cn6iVxV/sDX7JgBk7qOy9cHplJ2kMWBIlxHML0fKCbMRchX62kJ9ZnQJ1lcxbqx9zVFwfvX96wAJKqc7TGlTNz1ye0W9/rjpLBfr678nWn/u2ZBfOPiKENb5hwe8eXFOD6u9yBBZEg5nJwNGZiCU/mMDwYi90/Vjt8RAVSNSuOZPof1/5vIrW/t3L45c2yBVkDqIW0xl6MPLJN9Vj0uHYIcIf+adolJ443YSjIwpTQCy7b5g+V7he7AaOGsUBYOCHB0A4IhWqxVm00i/XV5q2QTmTqnEvXY4VGW0zk8B/v3GkvwhKtr7parzUa9eZNIyNkY/qu9MgUcI4gZgTmX+3/AT2pjop1AwAA=
        description: Challenge token generated by the hardToken or softToken assigned
          to the client, This is encrypted by the frontend using <a href="https://apis-ccp.citibank.nam.nsroot.net:20000/swagger-ui/#!/securityTokenService-jwt">Platform
          End-to-End encryption APIs</a>.
  CancelPayrollPortabilityRequest:
    type: object
    properties:
      customerId:
        description: unique identifier of the customer
        type: string
        example: "123456789012"
      PortabilityApplicationDetail:
        $ref: '#/definitions/PortabilityApplicationDetail'
      security:
        $ref: '#/definitions/SecurityDetail'
    required:
    - customerId
  PortabilityApplicationDetail:
    type: object
    properties:
      cancellationDate:
        description: date of application cancellation
        type: string
        format: date
        example: "2019-12-26"
      cancellationReason:
        description: reason of cancellation
        type: string
        example: time expired
      cancelledByAgentId:
        description: user id of application cancellation
        type: string
        example: sb12345
      channelType:
        description: Requestor Channel
        type: string
        example: Bancanet
      sourceAccountInfo:
        $ref: '#/definitions/SourceAccountDetail'
      destinationAccountInfo:
        $ref: '#/definitions/DestinationAccountDetail'
  SourceAccountDetail:
    type: object
    properties:
      accountAlias:
        description: CLABE number of the account
        type: string
        example: "12345678901234"
      accountNumber:
        description: account number of the customer
        type: string
        example: "1234567890"
      accountType:
        description: type of account
        type: string
        example: Checking
      bankId:
        description: unique identifier of bank
        type: string
        example: BNX
      bankName:
        description: bank name
        type: string
        example: Banamex
      branchId:
        description: branch id of the account
        type: string
        example: "1234"
  DestinationAccountDetail:
    type: object
    properties:
      accountAlias:
        description: CLABE number of the account
        type: string
        example: "12345678901234"
      accountId:
        type: string
        description: unique identifier of account mapped to account number
        example: "12345678"
      accountType:
        description: type of account
        type: string
        example: checking
      bankId:
        description: bank id
        type: string
        example: BNX
      bankName:
        description: Bank Name
        type: string
        example: Banamex
    required:
    - accountId
  SecurityDetail:
    type: object
    properties:
      lastEncryptedChallenge:
        type: string
        example: 0736H4sIAAAAAAAAAI1STWgTQRR+2SbUNBWq6MFbaEUQIT+SmoSeQtrDyhqDWxXsQSababKyM7POvm2SCp4KQu+eBa967cWbR2+ePAjeBfEgiNSbbzbbNtYeHBjm/b/vfW/efodcpGG5xyQTfFzyKrXq43qlUtr0hS8HrRiHXLrIkP/e/fypFLV/WZC5DfkImUaK4WMNxYh7seaeEmGMlFSKRtwrzaS+PvhhHbb2OhYUbLgs2rHWXOI0AH2PodI2LImuVqg8FTzgOvKVtKEg7nGMtbTltjLa/YhrW1KTyIFFMc1vK9FTCBedJ2yHlQMmB2UXNaFY24KcWGfUH65vOacglg3E8l8ITOiaA/PC7hvxKTwHy4E8qRsUgpPUYPybk5Cn6iVxV/sDX7JgBk7qOy9cHplJ2kMWBIlxHML0fKCbMRchX62kJ9ZnQJ1lcxbqx9zVFwfvX96wAJKqc7TGlTNz1ye0W9/rjpLBfr678nWn/u2ZBfOPiKENb5hwe8eXFOD6u9yBBZEg5nJwNGZiCU/mMDwYi90/Vjt8RAVSNSuOZPof1/5vIrW/t3L45c2yBVkDqIW0xl6MPLJN9Vj0uHYIcIf+adolJ443YSjIwpTQCy7b5g+V7he7AaOGsUBYOCHB0A4IhWqxVm00i/XV5q2QTmTqnEvXY4VGW0zk8B/v3GkvwhKtr7parzUa9eZNIyNkY/qu9MgUcI4gZgTmX+3/AT2pjop1AwAA=
        description: 'Challenge previously received (must be same as the given from
          get challenge service), composed by "Challenge" : "String State". This is
          encrypted by the frontend using <a href="https://apis-ccp.citibank.nam.nsroot.net:20000/swagger-ui/#!/securityTokenService-jwt">Platform
          End-to-End encryption APIs</a>.'
      encryptedChallengeToken:
        type: string
        example: 0736H4sIAAAAAAAAAI1STWgTQRR+2SbUNBWq6MFbaEUQIT+SmoSeQtrDyhqDWxXsQSababKyM7POvm2SCp4KQu+eBa967cWbR2+ePAjeBfEgiNSbbzbbNtYeHBjm/b/vfW/efodcpGG5xyQTfFzyKrXq43qlUtr0hS8HrRiHXLrIkP/e/fypFLV/WZC5DfkImUaK4WMNxYh7seaeEmGMlFSKRtwrzaS+PvhhHbb2OhYUbLgs2rHWXOI0AH2PodI2LImuVqg8FTzgOvKVtKEg7nGMtbTltjLa/YhrW1KTyIFFMc1vK9FTCBedJ2yHlQMmB2UXNaFY24KcWGfUH65vOacglg3E8l8ITOiaA/PC7hvxKTwHy4E8qRsUgpPUYPybk5Cn6iVxV/sDX7JgBk7qOy9cHplJ2kMWBIlxHML0fKCbMRchX62kJ9ZnQJ1lcxbqx9zVFwfvX96wAJKqc7TGlTNz1ye0W9/rjpLBfr678nWn/u2ZBfOPiKENb5hwe8eXFOD6u9yBBZEg5nJwNGZiCU/mMDwYi90/Vjt8RAVSNSuOZPof1/5vIrW/t3L45c2yBVkDqIW0xl6MPLJN9Vj0uHYIcIf+adolJ443YSjIwpTQCy7b5g+V7he7AaOGsUBYOCHB0A4IhWqxVm00i/XV5q2QTmTqnEvXY4VGW0zk8B/v3GkvwhKtr7parzUa9eZNIyNkY/qu9MgUcI4gZgTmX+3/AT2pjop1AwAA=
        description: Challenge token generated by the hardToken or softToken assigned
          to the client, This is encrypted by the frontend using <a href="https://apis-ccp.citibank.nam.nsroot.net:20000/swagger-ui/#!/securityTokenService-jwt">Platform
          End-to-End encryption APIs</a>.
  CancelPayrollPortabilityResponse:
    type: object
    properties:
      applicationStatus:
        description: status of portability application
        type: string
        example: "1"
      folio:
        description: EBPM Folio generated for portability request
        type: integer
        format: int32
        example: 2337823
  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://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
...