---
swagger: "2.0"
info:
  title: SERV-PYI-D-PayeeDetails
  description: This Microservice retrieves customer external account list
  version: 1.0.0
  x-ibm-name: serv-pyi-d-payeedetails
host: 127.0.0.1
schemes:
- https
basePath: /api
produces:
- application/json
paths:
  /v1/servicing/accounts/payments/payees/internal/retrieve:
    post:
      tags:
      - internal-all-payees
      summary: This API is used to retrieve the internal payee list for the customer.
      description: This API is used to retrieve the internal payee list for the customer.
      operationId: internal-all-payees
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - name: client_id
        in: header
        required: false
        type: string
        description: Client ID generated during application registration
      - name: Authorization
        in: header
        required: false
        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: retrieveInternalAllPayeesRequest
        in: body
        schema:
          $ref: '#/definitions/RetrieveInternalAllPayeesRequest'
      responses:
        200:
          description: Successful operation.
          schema:
            $ref: '#/definitions/RetrieveInternalAllPayeesResponse'
        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/payments/payees/retrieve:
    post:
      tags:
      - external-account-list
      operationId: external-account-list
      summary: API to retrieve customer external account list by customer number
      description: MTS API for external accounts by customer number, account identifier
        and account type
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - name: client_id
        in: header
        required: false
        type: string
        description: Client ID generated during application registration
      - name: Authorization
        in: header
        required: false
        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: dataCenterLocation
        in: header
        description: CSI Data center location number
        required: false
        type: string
        maxLength: 2
      - name: externalAccountListRequest
        in: body
        schema:
          $ref: '#/definitions/ExternalAccountListRequest'
      responses:
        200:
          description: Successful operation.
          schema:
            $ref: '#/definitions/ExternalAccountListResponse'
        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'
        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/payments/payees/transfer/retrieve:
    post:
      tags:
      - transfer-payee
      operationId: transfer-payee
      summary: To retrieve transfer payee information by his cellphone number or debit
        card number or contract number
      description: This API is used to retrieve transfer payee information by his
        cellphone number or debit card number or contract number
      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: transferPayeeRequest
        in: body
        schema:
          $ref: '#/definitions/TransferPayeeRequest'
      responses:
        200:
          description: Successful operation.
          schema:
            $ref: '#/definitions/TransferPayeeResponse'
        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'
        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:
  ExternalAccountListRequest:
    type: object
    properties:
      customerId:
        description: Customer ID
        type: string
        example: "66845512"
      accountType:
        description: Payee account type
        type: integer
        format: int32
        example: 1
      pageId:
        description: Page Id for pagination
        type: integer
        example: 1
      destinationSystemFlag:
        description: True for S016 destination or False for Mongo DB
        type: boolean
        example: true
    required:
    - customerId
  ExternalAccountListResponse:
    type: object
    properties:
      pageId:
        description: Page Id for pagination
        type: integer
        example: 1
      moreInformationFlag:
        description: More Information Flag
        format: boolean
        example: true
      accounts:
        type: array
        items:
          $ref: '#/definitions/AccountDetail'
  Payee:
    type: object
    properties:
      emailAddress:
        description: Payee email address
        type: string
        example: carlo.russo@hotmail.com
      partyType:
        description: Id for the Type of the beneficiary (1 - Physical person / 2 -
          Moral person)
        type: integer
        example: 1
      partyTypeDescription:
        description: Description for the Type of the beneficiary (1 - Physical person
          / 2 - Moral person)
        type: string
        example: Physical person
      payeeName:
        description: Payee name
        type: string
        example: Carlo Russo
      phoneNumber:
        description: Payee phone number
        type: string
        example: "55223123"
      phoneServiceProvider:
        description: Payee service phone carrier
        type: integer
        format: int32
        example: 10
      bankId:
        description: Bank ID
        type: string
        example: "33"
      bankName:
        description: Bank Name
        type: string
        example: Banco de Mexico
      taxId:
        description: tax id
        type: string
        example: FTM981104540
      transactionLimitAmount:
        description: transferLimitAmount
        type: number
        format: double
        example: 999999
      paymentFrequencyType:
        description: Payee account payment frequency
        type: string
        example: D
  AccountDetail:
    type: object
    properties:
      accountNickName:
        description: Account alias name
        type: string
        example: TDCBanamex
      accountNumber:
        description: Account number, CLABE or card number
        type: string
        example: "50100089864529"
      accountType:
        description: Payee account type
        type: integer
        format: int32
        example: 1
      accountTypeDescription:
        description: Type of the account description (Access media checkbook or card
          number)
        type: string
        example: Card Number
        maxLength: 22
      displayAccountNumber:
        description: The last digits of an account
        type: string
        example: "1244"
      branchId:
        description: Branch ID
        type: string
        example: "4411"
      channelType:
        description: Channel used for account addition
        type: integer
        format: int32
        example: 8
      currencyCode:
        description: Currency code
        type: integer
        format: int32
        example: 11
      currencyCodeDescription:
        description: Currency name
        type: string
        example: Pesos Mexicanos
        maxLength: 22
      merchantId:
        description: Unique identifier of a company which provides a product or service
          (merchant)
        type: string
        example: "301"
      transactionReferenceNumber:
        description: Transaction Reference Number
        type: string
        example: Pago credito personal
      routingNumber:
        description: ABA Code
        type: string
        example: 1234567890l
      merchantCategoryCode:
        description: Unique identifier of a service (merchant)
        type: string
        example: "2"
      economicSector:
        description: Customerbusiness sector
        type: integer
        format: int32
        example: 1
      industrySegment:
        description: Industry segment
        type: string
        example: "1"
      relationshipType:
        description: Type of relationship between customer and beneficiary
        type: string
        example: Primos
      payeeDetail:
        $ref: '#/definitions/Payee'
      accountProfile:
        $ref: '#/definitions/AccountProfile'
    required:
    - accountType
    - accountNumber
  AccountProfile:
    type: object
    properties:
      lastSearchDate:
        description: Payee account last date search
        type: string
        format: date
        example: "2018-05-06"
        maxLength: 10
      lastUpdatedDate:
        description: Payee account last update date
        type: string
        format: date
        example: "2018-05-06"
        maxLength: 10
      creationDateTime:
        description: Account payee creation date time
        type: string
        format: dateTime
        example: "2019-01-01T12:10:00"
        maxLength: 10
      cancellationDate:
        description: Payee account cancellation date
        type: string
        format: date
        example: "2018-05-06"
        maxLength: 10
  RetrieveInternalAllPayeesRequest:
    type: object
    properties:
      dataCenterLocation:
        description: data center location
        type: integer
        format: int32
        example: 10
      branchId:
        description: Branch Number
        type: string
        example: "5247"
      customerId:
        description: Customer Id
        type: string
        example: "111111111"
      accountNumber:
        description: Account Number
        type: string
        example: "66821476"
      pageId:
        description: Page Id for pagination
        type: integer
        example: 1
      destinationSystemFlag:
        description: True for S016 destination or False for Mongo DB
        type: boolean
        example: true
    required:
    - dataCenterLocation
    - customerId
  RetrieveInternalAllPayeesResponse:
    type: object
    properties:
      queryTime:
        description: Query Time
        type: string
        example: 04:22:00
      pageId:
        description: Page Id for pagination
        type: integer
        example: 1
      moreInformationFlag:
        description: More information flag
        format: boolean
        example: true
      accounts:
        type: array
        items:
          $ref: '#/definitions/AccountDetails'
    required:
    - queryTime
  PayeeDetails:
    type: object
    properties:
      payeeName:
        description: payee name
        type: string
        example: GRUPO BESH SA DE CV
      phoneNumber:
        description: Phone Number
        type: string
        example: "5544332211"
      taxId:
        description: tax id
        type: string
        example: FTM981104540
      lastUpdatedDate:
        description: date of last update to the payee
        type: string
        format: date
        example: "2018-09-20"
        maxLength: 10
      emailAddress:
        description: Email Address
        type: string
        example: ana@ejemplo.com
      partyType:
        description: Id for the Type of the beneficiary (1 - Physical person / 2 -
          Moral person)
        type: integer
        example: 1
      partyTypeDescription:
        description: Description for the Type of the beneficiary (1 - Physical person
          / 2 - Moral person)
        type: string
        example: Physical person
      registrationDate:
        description: Registration date for the payee
        type: string
        format: date
        example: "2018-04-05"
        maxLength: 10
      expiryDate:
        description: expiration date of the account registered for payment
        type: string
        format: date
        example: "2020-02-03"
        maxLength: 10
      deleteDate:
        description: cancellation date for the payee
        type: string
        format: date
        example: "2018-06-09"
        maxLength: 10
      transactionLimitAmount:
        description: transferLimitAmount
        type: number
        format: double
        example: 999999.990000
      paymentFrequencyType:
        description: Frecuency of the transaction
        type: string
        example: D
    required:
    - payeeName
    - phoneNumber
    - taxId
    - lastUpdatedDate
    - partyType
    - partyTypeDescription
    - registrationDate
    - expiryDate
    - deleteDate
    - transactionLimitAmount
  AccountDetails:
    type: object
    properties:
      branchId:
        description: current  branch id
        type: string
        example: "3221"
      accountNumber:
        description: Account Number
        type: string
        example: "999999"
      accountNickName:
        description: account alias
        type: string
        example: TELETON
      productCode:
        description: productCode
        type: integer
        format: int32
        example: 1
      productName:
        description: Product Name
        type: string
        example: Payrol account
        maxLength: 22
      productInstrument:
        description: productInstrument
        type: integer
        format: int32
        example: 4
      currencyCode:
        description: currencyCode
        type: integer
        format: int32
        example: 1
      currencyCodeDescription:
        description: Currency name
        type: string
        example: Pesos Mexicanos
        maxLength: 22
      accountAccessPrefix:
        description: First 4 digits from the account or card
        type: string
        example: "5211"
      accountType:
        description: Type of the account
        type: integer
        example: 6
      accountTypeDescription:
        description: Name of the type of the account
        type: string
        example: Cuenta Maestra
      displayAccountNumber:
        description: The last digits of an account
        type: string
        example: "1244"
      electronicBankingUsageCode:
        description: electronicBankingUsageCode
        type: integer
        example: 0
        maxLength: 2
      payeeDetail:
        $ref: '#/definitions/PayeeDetails'
      accountOperations:
        type: array
        items:
          $ref: '#/definitions/Operation'
    required:
    - branchId
    - accountNumber
    - productCode
    - productInstrument
    - currencyCode
    - accountType
    - accountTypeDescription
    - accountAccessPrefix
  Operation:
    type: object
    properties:
      lastOperationId:
        description: operation id of the last update
        type: integer
        format: int32
        example: 0
      lastOperationDescription:
        description: description of operation id.
        type: string
        example: CONSULTA APLICADA
      lastOperationDate:
        description: date of last consultation related to this payee.
        type: string
        format: date
        example: "2018-06-09"
        maxLength: 10
      lastOperationTime:
        description: time of last consultation related to this payee
        type: string
        example: 03:20:00
    required:
    - lastOperationId
    - lastOperationDescription
    - lastOperationDate
    - lastOperationTime
  TransferPayeeRequest:
    properties:
      referenceIdentifier:
        description: The field can be used to place CARD NUMBER, ACCOUNT NUMBER, or
          CLABE NUMBER, which is used to track the transaction
        type: string
        maxLength: 25
        example: "1234567890123456789"
      referenceIdentifierType:
        description: Type of account access Media
        type: string
        example: "1"
    required:
    - referenceIdentifier
    - referenceIdentifierType
  TransferPayeeResponse:
    properties:
      payeeInfo:
        $ref: '#/definitions/PayeeInfo'
  PayeeInfo:
    properties:
      customerId:
        description: Customer ID
        type: string
        example: "000000123456"
      firstName:
        description: Name of the beneficiary
        type: string
        example: Carlos
        maxLength: 20
      lastName:
        description: Last name of the beneficiary
        type: string
        example: Ruso
        maxLength: 20
      maternalLastName:
        description: Maternal last name of the beneficiary
        type: string
        example: Hernandez
        maxLength: 20
      birthDate:
        description: Customer s Date of Birth
        type: string
        format: date
        example: "1990-02-25"
      emailAddress:
        description: Payee email address
        type: string
        example: carlo.russo@hotmail.com
        maxLength: 78
      phoneNumber:
        description: Phone number of the payee
        type: string
        example: "55223123"
        maxLength: 10
      address:
        $ref: '#/definitions/Address'
      payeeAccount:
        $ref: '#/definitions/PayeeAccount'
    required:
    - firstName
    - lastName
  PayeeAccount:
    properties:
      accountNumber:
        description: The account associated to the customer
        type: string
        example: "1234567890123456"
      phone:
        $ref: '#/definitions/Phone'
    required:
    - accountNumber
  Phone:
    properties:
      phoneNumber:
        description: Phone number associated to the account of the payee
        type: string
        example: "55223123"
        maxLength: 10
      associationType:
        description: Id Movil association type
        type: integer
        example: 3
        maxLength: 1
  Address:
    properties:
      streetName:
        description: The name on astreet of a particular building or address.
        type: string
        example: TEMASCALTEPEC
        maxLength: 36
      streetNumber:
        description: The number on a street of a particular building or address.
        type: string
        pattern: ^[0-9]+$
        example: "27"
        maxLength: 5
      unitNumber:
        description: The number of the housing unit that is distinctly separated from
          other living spaces within the building.
        type: string
        pattern: ^[0-9]+$
        example: "209"
        maxLength: 5
      colonyName:
        description: Name of the Colony
        type: string
        example: Cumbria
        maxLength: 24
      city:
        description: City of address
        type: string
        example: Ciudad de Mexico
        maxLength: 20
      stateName:
        description: State information of the address.
        type: string
        example: Ciudad de Mexico
        maxLength: 20
      postalCode:
        description: A postal code also known locally in various English-speaking
          countries throughout the world as a postcode,post code, Eircode,PIN Code
          or ZIP Code is a series of letters or digits or both, sometimes including
          spaces or punctuation, included in a postal address for the purpose of sorting
          mail.
        type: string
        example: "06500"
        pattern: ^[0-9]+$
        maxLength: 6
  ErrorResponse:
    properties:
      type:
        type: string
        description: Invalid - Request did not confirm to the specification and was
          unprocessed and rejected. Please fix the value and try again
        enum:
        - error
        - warn
        - invalid
        - fatal
      code:
        description: Error code which qualifies the error
        type: string
      details:
        description: Human readable explanation specific to the occurrence of the
          problem
        type: string
      location:
        description: The name of the field that resulted in the error
        type: string
      moreInfo:
        description: URI to human readable documentation or detailed description of
          the error
        type: string
      uuid:
        description: 128 bit UUID that you generate for every request
        type: string
      timestamp:
        description: timestamp of the error
        type: string
    required:
    - type
    - code
x-ibm-configuration:
  enforced: true
  testable: true
  phase: realized
securityDefinitions:
  OAuth2 Application Flow:
    type: oauth2
    description: ""
    flow: application
    scopes:
      /api/v1: ""
    tokenUrl: https://sandbox.externalapib2b.wlb.nam.nsroot.net:7101/mx-gcgapi-uat/sandbox2/api/v1/oauth/token
  Client ID:
    type: apiKey
    description: ""
    in: header
    name: X-IBM-Client-Id
security:
- OAuth2 Application Flow:
  - /api/v1
  Client ID: []
x-ibm-endpoints:
- endpointUrl: https://sandbox.externalapib2b.wlb.nam.nsroot.net:7101/mx-gcgapi-uat/sandbox2
  type:
  - production
  - development
...