---
swagger: "2.0"
info:
  version: 1.0.0
  title: CNSV-CLG-D-CommodityCatalog
  description: This microservice will provide the data for all  commodity catalog
  x-ibm-name: cnsv-clg-d-commoditycatalog
  name: ""
basePath: /api
schemes:
- https
produces:
- application/json
paths:
  /v1/consumer-services/catalogs/country:
    get:
      summary: To fetch the country details
      description: This API will be used to fetch the country details
      tags:
      - RetrieveCountryDetail
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - name: Accept
        in: header
        description: Content-Types that are acceptable for the response
        type: string
        required: true
      - name: Accept-Language
        in: header
        description: List of acceptable human languages for response
        type: string
        required: false
      - name: Authorization
        in: header
        description: The Authorization Token received during login
        type: string
        required: true
      - name: client_id
        in: header
        required: true
        type: string
        description: Client ID generated during application registration
      - name: uuid
        in: header
        description: 128 bit UUID that you generate for every request
        type: string
        required: true
      - name: countryCode
        in: header
        description: Country code in 2 character ISO 3166 format
        required: true
        type: string
      - name: ChannelId
        in: header
        description: channel where request originated
        type: string
        required: true
      - name: businessCode
        in: header
        description: Business code identified during application registration
        required: true
        type: string
      responses:
        200:
          description: The request has succeeded.
          schema:
            $ref: '#/definitions/RetrieveCountryDetailResponse'
        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/consumer-services/catalogs/metals:
    get:
      tags:
      - ' metal information'
      summary: to get metal information
      description: This API is to get metal and its coin information
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - name: client_id
        in: header
        description: Client ID generated during application registration
        required: true
        type: string
      - name: Authorization
        in: header
        description: The most recent Authorization token
        type: string
        required: true
      - name: Accept
        in: header
        description: 'Content-Types that are acceptable for the response '
        required: true
        type: string
      - name: 'uuid '
        in: header
        description: 'Random 128 bit UUID generated uniquely for every request from
          the Customer, which will represent transaction unique identifier '
        required: true
        type: string
      - name: Accept-Language
        in: header
        description: List of acceptable human languages for response
        required: false
        type: string
      - name: countryCode
        in: header
        description: Country code in 2 character ISO 3166 format
        required: true
        type: string
      - name: businessCode
        in: header
        description: Business code identified during application registration
        required: true
        type: string
      - name: ChannelId
        in: header
        description: Channel Id identifies the consumer from where the request comes
        required: true
        type: string
      responses:
        200:
          description: Success Response
          schema:
            $ref: '#/definitions/MetalResponse'
        400:
          description: <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><tr><td>error</td><td>UserNotFound</td><td>CustomerId
            is Invalid</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'
        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/consumer-services/catalogs/metals/summary:
    get:
      tags:
      - metal summary
      summary: metal summary information
      description: 'This API is to fetch metal and its coin summary information '
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - name: client_id
        in: header
        description: Client ID generated during application registration
        required: true
        type: string
      - name: Authorization
        in: header
        description: The most recent Authorization token
        type: string
        required: true
      - name: Accept
        in: header
        description: 'Content-Types that are acceptable for the response '
        required: true
        type: string
      - name: 'uuid '
        in: header
        description: 'Random 128 bit UUID generated uniquely for every request from
          the Customer, which will represent transaction unique identifier '
        required: true
        type: string
      - name: Accept-Language
        in: header
        description: List of acceptable human languages for response
        required: false
        type: string
      - name: countryCode
        in: header
        description: Country code in 2 character ISO 3166 format
        required: true
        type: string
      - name: businessCode
        in: header
        description: Business code identified during application registration
        required: true
        type: string
      - name: ChannelId
        in: header
        description: Channel Id identifies the consumer from where the request comes
        required: true
        type: string
      responses:
        200:
          description: Success Response
          schema:
            $ref: '#/definitions/MetalSummaryResponse'
        400:
          description: <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><tr><td>error</td><td>UserNotFound</td><td>CustomerId
            is Invalid</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'
        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/consumer-services/catalogs/dollar/summary:
    get:
      tags:
      - dollar summary
      summary: dollar summary
      description: This API is used to retreive dollar summary information
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - name: client_id
        in: header
        description: Client ID generated during application registration
        required: true
        type: string
      - name: Authorization
        in: header
        description: The most recent Authorization token
        type: string
        required: true
      - name: Accept
        in: header
        description: 'Content-Types that are acceptable for the response '
        required: true
        type: string
      - name: 'uuid '
        in: header
        description: 'Random 128 bit UUID generated uniquely for every request from
          the Customer, which will represent transaction unique identifier '
        required: true
        type: string
      - name: Accept-Language
        in: header
        description: List of acceptable human languages for response
        required: false
        type: string
      - name: countryCode
        in: header
        description: Country code in 2 character ISO 3166 format
        required: true
        type: string
      - name: businessCode
        in: header
        description: Business code identified during application registration
        required: true
        type: string
      - name: ChannelId
        in: header
        description: Channel Id identifies the consumer from where the request comes
        required: true
        type: string
      responses:
        200:
          description: Success Response
          schema:
            $ref: '#/definitions/DollarSummaryResponse'
        400:
          description: <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><tr><td>error</td><td>UserNotFound</td><td>CustomerId
            is Invalid</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'
        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/consumer-services/catalogs/dollar/{year}:
    get:
      tags:
      - dollar information
      summary: To get dollar information
      description: This API is used to retreive dollar information for last 8 years
        starting mentioned year
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - name: client_id
        in: header
        description: Client ID generated during application registration
        required: true
        type: string
      - name: Authorization
        in: header
        description: The most recent Authorization token
        type: string
        required: true
      - name: Accept
        in: header
        description: 'Content-Types that are acceptable for the response '
        required: true
        type: string
      - name: 'uuid '
        in: header
        description: 'Random 128 bit UUID generated uniquely for every request from
          the Customer, which will represent transaction unique identifier '
        required: true
        type: string
      - name: Accept-Language
        in: header
        description: List of acceptable human languages for response
        required: false
        type: string
      - name: countryCode
        in: header
        description: Country code in 2 character ISO 3166 format
        required: true
        type: string
      - name: businessCode
        in: header
        description: Business code identified during application registration
        required: true
        type: string
      - name: ChannelId
        in: header
        description: Channel Id identifies the consumer from where the request comes
        required: true
        type: string
      - name: year
        in: path
        description: Year to pass to get forex rate for year-8 to year
        required: true
        type: integer
        format: int32
      responses:
        200:
          description: Success Response
          schema:
            $ref: '#/definitions/DollarResponse'
        400:
          description: <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><tr><td>error</td><td>UserNotFound</td><td>CustomerId
            is Invalid</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'
        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/consumer-services/catalogs/currencies:
    get:
      tags:
      - currencies
      summary: currencies
      description: This API is used to retreive all currencies information
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - name: client_id
        in: header
        description: Client ID generated during application registration
        required: true
        type: string
      - name: Authorization
        in: header
        description: The most recent Authorization token
        type: string
        required: true
      - name: Accept
        in: header
        description: 'Content-Types that are acceptable for the response '
        required: true
        type: string
      - name: 'uuid '
        in: header
        description: 'Random 128 bit UUID generated uniquely for every request from
          the Customer, which will represent transaction unique identifier '
        required: true
        type: string
      - name: Accept-Language
        in: header
        description: List of acceptable human languages for response
        required: false
        type: string
      - name: countryCode
        in: header
        description: Country code in 2 character ISO 3166 format
        required: true
        type: string
      - name: businessCode
        in: header
        description: Business code identified during application registration
        required: true
        type: string
      - name: ChannelId
        in: header
        description: Channel Id identifies the consumer from where the request comes
        required: true
        type: string
      responses:
        200:
          description: Success Response
          schema:
            $ref: '#/definitions/CurrencyResponse'
        400:
          description: <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><tr><td>error</td><td>UserNotFound</td><td>CustomerId
            is Invalid</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'
        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/consumer-services/catalogs/currencies/continent:
    get:
      tags:
      - continent currencies
      summary: continent currencies
      description: This API is used to retreive all  currencies by continent information
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - name: client_id
        in: header
        description: Client ID generated during application registration
        required: true
        type: string
      - name: Authorization
        in: header
        description: The most recent Authorization token
        type: string
        required: true
      - name: Accept
        in: header
        description: 'Content-Types that are acceptable for the response '
        required: true
        type: string
      - name: 'uuid '
        in: header
        description: 'Random 128 bit UUID generated uniquely for every request from
          the Customer, which will represent transaction unique identifier '
        required: true
        type: string
      - name: Accept-Language
        in: header
        description: List of acceptable human languages for response
        required: false
        type: string
      - name: countryCode
        in: header
        description: Country code in 2 character ISO 3166 format
        required: true
        type: string
      - name: businessCode
        in: header
        description: Business code identified during application registration
        required: true
        type: string
      - name: ChannelId
        in: header
        description: Channel Id identifies the consumer from where the request comes
        required: true
        type: string
      responses:
        200:
          description: Success Response
          schema:
            $ref: '#/definitions/ContinentCurrencyResponse'
        400:
          description: <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><tr><td>error</td><td>UserNotFound</td><td>CustomerId
            is Invalid</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'
        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/consumer-services/catalogs/currencies/summary:
    get:
      tags:
      - currencies summary
      summary: currencies summary
      description: This API is used to retreive currency summary information
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - name: client_id
        in: header
        description: Client ID generated during application registration
        required: true
        type: string
      - name: Authorization
        in: header
        description: The most recent Authorization token
        type: string
        required: true
      - name: Accept
        in: header
        description: 'Content-Types that are acceptable for the response '
        required: true
        type: string
      - name: 'uuid '
        in: header
        description: 'Random 128 bit UUID generated uniquely for every request from
          the Customer, which will represent transaction unique identifier '
        required: true
        type: string
      - name: Accept-Language
        in: header
        description: List of acceptable human languages for response
        required: false
        type: string
      - name: countryCode
        in: header
        description: Country code in 2 character ISO 3166 format
        required: true
        type: string
      - name: businessCode
        in: header
        description: Business code identified during application registration
        required: true
        type: string
      - name: ChannelId
        in: header
        description: Channel Id identifies the consumer from where the request comes
        required: true
        type: string
      responses:
        200:
          description: Success Response
          schema:
            $ref: '#/definitions/CurrencySummaryResponse'
        400:
          description: <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><tr><td>error</td><td>UserNotFound</td><td>CustomerId
            is Invalid</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'
        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:
  RetrieveCountryDetailResponse:
    type: object
    properties:
      country:
        type: array
        items:
          $ref: '#/definitions/Country'
  Country:
    type: object
    properties:
      countryName:
        description: Country code of address
        type: string
        example: AFGANISTAN
  ContinentCurrencyResponse:
    type: object
    description: This response is to get currency continent information
    properties:
      continent:
        type: array
        items:
          $ref: '#/definitions/Continent'
  DollarSummaryResponse:
    type: object
    description: This response is to get Dollar summary  information
    properties:
      dollarSummary:
        type: array
        items:
          $ref: '#/definitions/Currency'
  CurrencySummaryResponse:
    type: object
    description: This response is to get currency summary  information
    properties:
      currency:
        type: array
        items:
          $ref: '#/definitions/Currency'
  CurrencyResponse:
    type: object
    description: This response is to get currency  information
    properties:
      currency:
        type: array
        items:
          $ref: '#/definitions/CurrencyDetail'
  Continent:
    type: object
    description: currency continent information
    properties:
      continent:
        type: string
        description: continent
        example: NORTH AMERICA
      currency:
        type: array
        items:
          $ref: '#/definitions/Currency'
  CurrencyDetail:
    type: object
    description: currency information
    properties:
      currencyCode:
        type: string
        description: currency code
        example: CAD
      countryNameSpanish:
        type: string
        description: country name in Spanish
        example: Canada
      countryName:
        type: string
        description: country name in English
        example: Canada
      currencyDescriptionSpanish:
        type: string
        description: currency description in Spanish
        example: Dolar
      currencyDescription:
        type: string
        description: currency description in English
        example: Dollar
      salePrice:
        type: number
        format: double
        description: sale price
        example: "1.30"
  Currency:
    type: object
    description: currency information
    properties:
      currencyCode:
        type: string
        description: currency code
        example: CAD
      countryFlagImage:
        type: string
        description: country flag image GIF
        example: Canada.GIF
      countryNameSpanish:
        type: string
        description: country name in Spanish
        example: Canada
      countryName:
        type: string
        description: country name in English
        example: Canada
      currencyDescriptionSpanish:
        type: string
        description: currency description in Spanish
        example: Dolar
      currencyDescription:
        type: string
        description: currency description in English
        example: Dollar
      buyPrice:
        type: number
        format: double
        description: buy price
        example: "1.25"
      salePrice:
        type: number
        format: double
        description: sale price
        example: "1.30"
  DollarResponse:
    type: object
    description: This response is to get the dollar information
    properties:
      foreignExchange:
        type: array
        items:
          $ref: '#/definitions/ForeignExchange'
  ForeignExchange:
    type: object
    description: foreing exchange
    properties:
      foreignExchangeRate:
        type: number
        format: double
        description: foreign ExchangeRate
        example: "1.25"
      month:
        type: integer
        format: int32
        description: month number
        example: "01"
      year:
        type: integer
        format: int32
        description: year
        example: "2010"
  MetalSummaryResponse:
    type: object
    description: This response is to get the metals summary
    properties:
      coin:
        type: array
        items:
          $ref: '#/definitions/Coin'
  MetalResponse:
    type: object
    description: This response is to get the metals information
    properties:
      metal:
        type: array
        items:
          $ref: '#/definitions/Metal'
  Metal:
    type: object
    description: metal information
    properties:
      metalType:
        type: string
        description: coin metal Type
        example: Oro
      coinMetal:
        type: array
        items:
          $ref: '#/definitions/CoinMetal'
  CoinMetal:
    type: object
    description: coin information
    properties:
      coinCategory:
        type: string
        description: metal coin category
        example: onzasoro
      coin:
        type: array
        items:
          $ref: '#/definitions/Coin'
  Coin:
    type: object
    description: different coin detail information
    properties:
      buyPrice:
        type: number
        format: double
        description: buy price
        example: "1.35"
      coinDenomination:
        type: string
        description: coin
        example: OroLibertad
      metalCode:
        type: string
        description: metal Code
        example: OLIB
      metalValue:
        type: string
        description: metal cost Value in mexican pesos
        example: "1800"
      salePrice:
        type: number
        format: double
        description: sale price
        example: "1.40"
  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
    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://api.banamex.com/mx-gcgapi/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://api.banamex.com/mx-gcgapi
  type:
  - production
  - development
...