swagger: "2.0"
info:
  version: "1.1"
  title: Loyalty Reward Balance API
  contact:
    name: Rewards and Beneficts Solutions Team
    email: RNB_DEV_Leads@restricted.chase.com
  description: >-
    This service returns Cardholder?s available rewards balance and other
    relevant data such as conversion rate.
  license:
    name: N/A
    url: N/A
host: api.chase.com
x-chase-info: 24380//External///Product
x-chase-info-2: DM61209/true/card/loyaltybankrewards/v1
basePath: /card/loyalty/bank-rewards/points-balance/v1
tags:
  - name: card-loyalty-bank-rewards-v1
    description: Reward Balance
schemes:
  - https
paths:
  /merchants/users/{account-reference-universal-unique-identifier}/rewards-balance:
    get:
      tags:
        - card-loyalty-bank-rewards-v1
      summary: Available rewards Balance
      description: >-
        Returns cardholder?s available rewards balance and other relevant data
        such as conversion rate.
      produces:
        - application/json
      parameters:
        - $ref: "#/parameters/authorization"
        - $ref: "#/parameters/authorization2"
        - $ref: "#/parameters/channel-type"
        - $ref: "#/parameters/trace-id"
        - $ref: "#/parameters/external-account-identifier"
        - $ref: "#/parameters/account-reference-universal-unique-identifier"
      responses:
        "200":
          description: Successful  response from API
          schema:
            $ref: "#/definitions/RewardBalanceResponse"
        "400":
          description: >-
            Request is invalid either required data is missing or data is not
            consistent
          schema:
            $ref: "#/definitions/Error"
        "401":
          description: >-
            Authorization Failure. Customer Token does not match. Customer will
            need to re-do the OAuth
          schema:
            $ref: "#/definitions/Error"
        "404":
          description: If the {resourceId} being requested is not found
          schema:
            $ref: "#/definitions/Error"
        "405":
          description: Operation /method not allowed
          schema:
            $ref: "#/definitions/Error"
        "409":
          description: >-
            List of business reasons of error codes and descriptions are as
            below <br/> 601  : Account is not eligible. <br/> 605  : This
            feature is permanently unavailable. <br/> 610  : Customer is not
            enrolled in the Pay with Points feature. <br/> 101  : Account is not
            found. <br/> 102  : Partner Information not found. <br/> 179  :
            Multiple accounts found. <br/>
          schema:
            $ref: "#/definitions/Error"
        "500":
          description: Internal Server Error
          schema:
            $ref: "#/definitions/Error"
        "502":
          description: Bad Gateway
          schema:
            $ref: "#/definitions/Error"
        "503":
          description: Downstream System Exception
          schema:
            $ref: "#/definitions/Error"
  /ping:
    get:
      tags:
        - card-loyalty-bank-rewards-v1
      summary: ping
      description: This method is used to get health check of the service
      operationId: ping
      parameters: []
      responses:
        "200":
          description: successful operation
          schema:
            type: array
            items:
              type: string
parameters:
  account-reference-universal-unique-identifier:
    name: account-reference-universal-unique-identifier
    type: string
    required: true
    in: path
    maxLength: 8000
    description: >-
      A universally unique identifier (UUID) that is randomly generated to
      identify each account that is persisted at the merchant end. This value
      will help the merchant identify the card account during a transaction or
      product trade.  A UUID is a 128-bit number used to identify information in
      computer systems. The field length of 36 bytes corresponds to 128 bits
      (via Hexadecimal string conversion)
  authorization:
    name: authorization
    in: header
    required: true
    type: string
    maxLength: 8000
    description: >-
      OAuth bearer token will be sent in this header as per the OAuth2 spec.
      This header will be used by the API gateway. The API does not need to do
      anything with this header
  authorization2:
    name: authorization2
    in: header
    required: true
    type: string
    maxLength: 8000
    description: >-
      Additional authorization on top of standard OAuth token in the
      Authorization Header. The use of this header is different for 3-legged and
      2-legged use cases
  external-account-identifier:
    name: external-account-identifier
    description: >-
      A unique identifier created to establish a relationship between customer
      and account as it exists in Firms customer enterprise system
    in: header
    required: true
    type: string
    maxLength: 32
  channel-type:
    name: channel-type
    description: Digital channel type indicates where the request originated from.
    in: header
    required: false
    type: string
    maxLength: 15
  trace-id:
    name: trace-id
    description: >-
      A unique Trace Id for every request. This SHOULD be unique for every
      request and 128 bit number, represented in lower hex characters.
    in: header
    required: true
    type: string
    maxLength: 32
definitions:
  RewardBalanceResponse:
    type: object
    properties:
      Reward:
        $ref: "#/definitions/Rewards Account"
      productInformation:
        $ref: "#/definitions/productInformation"
  Rewards Account:
    type: object
    required:
      - rewardsBalanceAmount
      - rewardsCurrencyCode
      - rewardsConversionRate
      - rewardsBalanceDollarAmount
    properties:
      rewardsBalanceAmount:
        type: number
        format: double
        description: Specifies the value of rewards in rewards currency (Miles, Points).
        x-chase-dataelem: CONF/194634/N/N
      rewardsCurrencyCode:
        type: string
        description: >-
          Codifies the method used to accumulate the rewards balance amount.
          Sample values include -> Miles, Points
        maxLength: 10
      rewardsConversionRate:
        type: number
        description: >-
          The factor used to convert rewards from rewards currency to US
          dollars.
        format: float
      rewardsBalanceDollarAmount:
        type: number
        description: The us dollar equilivalent of the reward balance.
        format: double
  Error:
    type: object
    required:
      - errorDescription
    properties:
      errorDescription:
        type: string
        description: Freeform explanatory text for the error.
        maxLength: 250
      serviceErrorCode:
        type: string
        description: >-
          A code defined by the API provider that describes the specific error
          for a given API. This code provides more fine grained information than
          the httpStatusCode. As an example if an API provides an httpStatusCode
          of 400 they may also include the serviceErrorCode that includes more
          specific information of what caused a 400 response. (i.e.
          INVALID_EMAIL, INVALID_PHONE_NUMBER, etc)
        maxLength: 20
      externalErrorCode:
        type: string
        description: >-
          A code defined by the service for the external partner that includes a
          more specific information of what caused the error.
        maxLength: 90
  productInformation:
    type: object
    required:
      - merchantDefinedProductCode
    properties:
      merchantDefinedProductCode:
        type: string
        description: >-
          Codifies the product referred in the Merchant Relationship Manager
          Service built within Loyalty application interface. The value is
          internally assigned by the application according to the reward product
          code (RPC).
        enum:
          - SAPPHIRE_RESERVE
          - JPM_RESERVE
          - SAPPHIRE_PREFERRED
          - SAPPHIRE_NO_FEE
          - INK_BUSINESS_PREFERRED
          - INK_PLUS
          - INK_BUSINESS_CASH
          - INK_CASH
          - INK_BUSINESS_UNLIMITED
          - FREEDOM_UNLIMITED
          - FREEDOM
          - FREEDOM_STUDENT
          - SLATE
        maxLength: 50
securityDefinitions:
  Common 2-Legged OAuth:
    type: oauth2
    description: This API is secured by the common 2-legged OAuth API.
    flow: application
    scopes:
      card: ""
    tokenUrl: https://api-sandbox.chase.com/ccoauth/token
security:
  - Common 2-Legged OAuth:
      - card
x-ibm-configuration: {}