---
swagger: "2.0"
info:
  title: SERV-PYI-V-MerchantManagement
  description: The purpose of this microservice is to manage registered merchants
    from the customer.
  version: 1.0.0
  x-ibm-name: serv-pyi-v-merchantmanagement
host: 127.0.0.1
schemes:
- https
basePath: /api
produces:
- application/json
paths:
  /v1/servicing/customers/merchants/retrieve:
    get:
      tags:
      - retrieve-customer-merchants
      operationId: retrieve-customer-merchants
      summary: To obtain all previously registered merchants for a customer so he
        can perform a payment
      description: This API is used to obtain all previously registered merchants
        for a customer so he can perform a payment
      produces:
      - application/json
      parameters:
      - name: client_id
        in: header
        required: true
        type: string
        description: Client ID generated during application registration
      - name: Authorization
        in: header
        required: true
        type: string
        description: The Authorization Token received during login
      - name: Accept
        in: header
        required: true
        type: string
        description: Content-Types that are acceptable for the response
      - name: uuid
        in: header
        required: true
        type: string
        description: 128 bit UUID that you generate for every request
      - name: Accept-Language
        in: header
        required: false
        type: string
        description: List of acceptable human languages for response
      - name: Content-Type
        in: header
        required: false
        type: string
        description: Content-Types that are sent in the request
      - name: countryCode
        in: header
        required: true
        type: string
        description: Content-Types that are sent in the request2 character ISO country
          code
        default: MX
      - 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: accountType
        in: query
        required: false
        type: string
        description: Type of the account
      responses:
        200:
          description: Successful operation.
          schema:
            $ref: '#/definitions/CustomerMerchantsResponse'
        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/customers/merchants/info/{merchantTableReferenceId}:
    get:
      tags:
      - merchant-info
      operationId: merchant-info
      summary: To retrieve the information of one specific merchant
      description: This API is used to retrieve the information of one specific merchant
      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: false
        type: string
        description: Content-Types that are sent in the request
      - name: countryCode
        in: header
        required: true
        type: string
        description: Content-Types that are sent in the request2 character ISO country
          code
        default: MX
      - 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: merchantTableReferenceId
        in: path
        required: true
        type: string
        description: Service Database Identifier
      responses:
        200:
          description: Successful operation.
          schema:
            $ref: '#/definitions/MerchantDetailResponse'
        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:
  CustomerMerchantsResponse:
    type: object
    properties:
      merchants:
        type: array
        items:
          $ref: '#/definitions/Merchant'
  Merchant:
    type: object
    properties:
      merchantId:
        description: Unique identifier of a company which provides a product or service
          (merchant)
        type: string
        example: "117418"
      merchantCategoryCode:
        description: Line of business or activity of the merchant
        type: string
        example: "1174"
      merchantBusinessName:
        description: Legal name of the merchant under which it performs their business
        type: string
        example: Teléfonos de México, S. A. B. de C. V.
      merchantNickName:
        description: Nick Name of Merchant, given by customer for easier recognition
        type: string
        example: Teléfono
      transactionLimitAmount:
        description: Any transaction amount limit fixed for any payee.
        type: number
        format: double
        example: 1234.560000
      currencyCode:
        description: The currency code identifier of the account
        type: integer
        format: int32
        example: 1
      currencyCodeDescription:
        description: Currency Code of the account
        type: string
        example: MXN
      merchantServiceInformation:
        type: array
        items:
          $ref: '#/definitions/MerchantServiceInformation'
    required:
    - merchantBusinessName
    - merchantCategoryCode
    - merchantNickName
    - transactionLimitAmount
    - merchantServiceInformation
    - currencyCode
  MerchantServiceInformation:
    type: object
    properties:
      merchantSubCategory:
        description: Identifier of the service provided by the merchant
        type: string
        example: "18"
      merchantName:
        description: Name of the merchant
        type: string
        example: Telmex
      merchantTableReferenceId:
        description: Service Database Identifier
        type: string
        example: 1000:084
    required:
    - merchantSubCategory
    - merchantName
    - merchantTableReferenceId
  MerchantDetailResponse:
    type: object
    properties:
      merchantId:
        description: Unique identifier of a company which provides a product or service
          (merchant)
        type: string
        example: "117418"
      captureLineType:
        description: Type of the capture line
        type: string
        example: "3"
      captureLineAccessType:
        description: Type of the access of the capture line
        type: string
        example: "1"
      imageName:
        description: Name of the image, used to help icon
        type: string
        example: "117418"
      multiplePaymentCode:
        description: Code to identify if the payment can be do it one or more times.
          Values A) more than one B) once
        type: string
        example: A
      modifyAmountFlag:
        description: Flag to indicate if the amount could be modified or not
        type: boolean
        example: false
      paymentOperationType:
        description: Type of the payment operation, to identify if is going to use
          DB with capture line or with web services
        type: string
        example: "1"
      paymentOperationSubType:
        description: Subtype of the payment operation, if the payment is going to
          use web services, identify if is going to be direct or in group
        type: string
        example: "1"
      paymentConfiguration:
        type: array
        items:
          $ref: '#/definitions/PaymentConfiguration'
    required:
    - paymentConfiguration
    - merchantId
    - captureLineType
    - captureLineAccessType
  PaymentConfiguration:
    type: object
    properties:
      referenceId:
        description: Unique ID used by front-end to identify  the input of the payment
          reference
        type: integer
        format: int32
        example: 77
      referenceLabel:
        description: Label and placeholder to the input of the form of the reference
          field
        type: string
        example: LINEA CAPTURA
      referenceMaximumLength:
        description: Max length of the input of the form of the reference field
        type: integer
        format: int32
        example: 20
      referenceMinimumLength:
        description: Min length of the input of the form of the reference field
        type: integer
        format: int32
        example: 2
      referenceType:
        description: Data Type of the reference field
        type: string
        example: "N"
    required:
    - referenceId
    - referenceLabel
    - referenceType
    - referenceMaximumLength
  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
...