---
swagger: "2.0"
info:
  title: RewardsPointsAwardsAndRedemption_Digital_Domain
  description: This service is used to perform aggregator operations across multiple
    products.<br/>PCF Deployment Reference name -->  PPR-D-RwdPtsAwardRed-DGL-EA<br/>PCF
    Deployment Reference name(TW) -->  PPR-D-RwdPtsAwardRed-DGL-EA-TW<br/>
  x-ibm-name: RewardsPointsAwardsAndRedemption_Digital_Domain
  version: 1.12.0
host: 127.0.0.1
schemes:
- https
basePath: /api
produces:
- application/json
paths:
  /v1/rewards/selectAndCredit/redemption:
    post:
      summary: Redeem the credit card reward points
      description: Request for the redemption to be processed for credit card enrolled.
      tags:
      - PRODUCT PRICING BUNDLING AND REWARDS
      parameters:
      - name: Authorization
        in: header
        description: 'The most recent Authorization token. This will have the format
          Bearer + {space} + {accessToken}. Example: Bearer KGNsaWVudF9pZDpjbGllbnRfc2VjcmV0KQ=='
        type: string
        required: true
      - name: uuid
        in: header
        description: 128 bit random UUID generated uniquely for every request.
        type: string
        required: true
      - name: Accept
        in: header
        description: Content-Type that are acceptable for the response.
        type: string
        required: true
      - name: client_id
        in: header
        description: Client ID generated during application registration.
        required: true
        type: string
      - name: Content-Type
        in: header
        description: application/json
        required: true
        type: string
      - name: clientDetails
        in: header
        description: This field is used to capture device,browser and network information.
          Refer the developer portal for more information.These are the fields which
          will be passed as part of the header devicePrint,deviceTokenCookie,userIpAddress,userAgent,hardwareId,simId,deviceModel,deviceName,deviceOsName,deviceOsVersion,multitaskingSupportFlag,languageSupport,wifiMacAddress,cellTowerId,locationAreaCode,rsaApplicationKey,wapClientId,mobileCarrierCode,mobileCountryCode,osId,geoLongitude,geoLatitude,geoHorizontalAccuracy,geoAltitude,geoAltitudeAccuracy,geoSpeed,geoTimestamp,geoStatus,basicServiceSetId,signalStrength,wifiChannel,serviceSetId
        type: string
        required: false
      - name: SelectAndCreditRedemptionRequest
        in: body
        description: Select And Credit Redemption Request
        required: true
        schema:
          $ref: '#/definitions/SelectAndCreditRedemptionRequest'
      responses:
        200:
          description: Successful operation.
          schema:
            $ref: '#/definitions/SelectAndCreditRedemptionResponse'
        400:
          description: <table><tr><td>Type</td><td>Code</td><td>Details</td></tr><tr><td>invalid</td><td>invalidRequest</td><td>Missing
            or invalid parameters</td></tr><tr><td>error</td><td>inSufficientPointBalance</td><td>The
            order points cannot be more than available balance of the member</td></tr>
            <tr><td>error</td><td>exceedsMaximumPointsAllowed</td><td>Requested amount
            or points are more than allowed equivalent points.</td></tr><tr><td>error</td><td>notEligibleToRedeem</td><td>Member
            not eligible to order this item</td></tr><tr><td>error</td><td>belowMinimumPointsAllowed</td><td>Requested
            amount or points are less than allowed equivalent points.</td></tr><tr><td>error</td><td>transactionAlreadyRedeemed</td><td>Transaction
            is already redeemed</td></tr><tr><td>error</td><td>errorGeneratingOrderId</td><td>Order
            Id is not generated</td></tr><tr><td>invalid</td><td>invalidPointsAndAmountCombination</td><td>Points
            and amount combination are invalid</td></tr><tr><td>error</td><td>RedemptionNotAllowed</td><td>Redemption
            Not allowed</td></tr><tr><td>error</td><td>exceedsMaximumAmountAllowed</td><td>Requested
            partial amount is greater than maximum transaction amount to be redeemed.</td></tr></table>
          schema:
            $ref: '#/definitions/ErrorResponse'
        401:
          description: <table><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>error</td><td>accessNotConfigured</td><td>Access
            is not configured for this resource</td></tr></table>
          schema:
            $ref: '#/definitions/ErrorResponse'
        500:
          description: <table><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/apac/rewards/{rewardLinkCode}/redemption:
    post:
      summary: Redeem the credit card reward points
      description: Request for the redemption to be processed for credit card enrolled.
      tags:
      - PRODUCT PRICING BUNDLING AND REWARDS
      parameters:
      - name: rewardLinkCode
        in: path
        description: Unique link code per card associated with a member account
        type: string
        required: true
      - name: Authorization
        in: header
        description: 'The most recent Authorization token. This will have the format
          Bearer + {space} + {accessToken}. Example: Bearer KGNsaWVudF9pZDpjbGllbnRfc2VjcmV0KQ==.'
        required: true
        type: string
      - name: uuid
        in: header
        description: 128 bit random UUID generated uniquely for every request.
        type: string
        required: true
      - name: Accept
        in: header
        description: Content-Type that are acceptable for the response.
        type: string
        required: true
      - name: Content-Type
        in: header
        description: application/json
        required: true
        type: string
      - name: client_id
        in: header
        description: The client ID  you received during application registration in
          the developer portal
        type: string
        required: true
      - name: Accept-Language
        in: header
        description: Accept-Language header.
        required: false
        type: string
      - name: clientDetails
        in: header
        description: This field is used to capture device,browser and network information.
          Refer the developer portal for more information.These are the fields which
          will be passed as part of the header devicePrint,deviceTokenCookie,userIpAddress,userAgent,hardwareId,simId,deviceModel,deviceName,deviceOsName,deviceOsVersion,multitaskingSupportFlag,languageSupport,wifiMacAddress,cellTowerId,locationAreaCode,rsaApplicationKey,wapClientId,mobileCarrierCode,mobileCountryCode,osId,geoLongitude,geoLatitude,geoHorizontalAccuracy,geoAltitude,geoAltitudeAccuracy,geoSpeed,geoTimestamp,geoStatus,basicServiceSetId,signalStrength,wifiChannel,serviceSetId
        type: string
        required: false
      - name: rewardsPointsRedemptionRequest
        in: body
        description: Redemption information
        required: true
        schema:
          $ref: '#/definitions/RewardPointsRedemptionRequest'
      responses:
        200:
          description: Successful operation.
          schema:
            $ref: '#/definitions/RewardPointsRedemptionResponse'
        400:
          description: <table><tr><td>Type</td><td>Code</td><td>Details</td></tr><tr><td>invalid</td><td>invalidRequest</td><td>Missing
            or invalid parameters</td></tr>  <tr><td>error</td><td>invalidRewardLinkCode</td><td>Reward
            link code is invalid</td></tr> <tr><td>error</td><td>errorGeneratingOrderId</td><td>Order
            Id is not generated</td></tr><tr><td>error</td><td>inSufficientPointBalance</td><td>The
            order points cannot be more than available balance of the member</td></tr>
            <tr><td>error</td><td>exceedsMaximumPointsAllowed</td><td>Requested amount
            or points are more than allowed equivalent points.</td></tr><tr><td>error</td><td>notEligibleToRedeem</td><td>Member
            not eligible to order this item</td></tr><tr><td>error</td><td>belowMinimumPointsAllowed</td><td>Requested
            amount or points are less than allowed equivalent points.</td></tr><tr><td>error</td><td>inactiveRewardLinkCode</td><td>Reward
            link code is inactive</td></tr><tr><td>error</td><td>invalidPointsAndAmountCombination</td><td>Points
            and amount combination are invalid</td></tr><tr><td>error</td><td>currencyNotSupported</td><td>Currency
            is not supported</td></tr><tr><td>error</td><td>transactionAlreadyRedeemed</td><td>Transaction
            is already redeemed</td></tr></table>
          schema:
            $ref: '#/definitions/ErrorResponse'
        401:
          description: <table><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>error</td><td>accessNotConfigured</td><td>Access
            is not configured for this resource</td></tr></table>
          schema:
            $ref: '#/definitions/ErrorResponse'
        500:
          description: <table><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/rewardsPointsAwardsAndRedemption/transactions/retrieve:
    post:
      summary: Thsi API will be used to inquire the history of redemption details(earned
        or redeemed) for all the transactions done for the specified period
      description: Thsi API will be used to inquire the history of redemption details(earned
        or redeemed) for all the transactions done for the specified period
      operationId: RetrieveRewardPointTransactionRedemptionHistory
      tags:
      - PRODUCT PRICING BUNDLING AND REWARDS
      parameters:
      - name: Authorization
        in: header
        description: 'The most recent Authorization token. This will have the format
          Bearer + {space} + {accessToken}. Example: Bearer KGNsaWVudF9pZDpjbGllbnRfc2VjcmV0KQ==.'
        type: string
        required: true
      - name: uuid
        in: header
        description: 128 bit random UUID generated uniquely for every request.
        type: string
        required: true
      - name: Accept
        in: header
        description: Content-Type that are acceptable for the response.
        type: string
        required: true
      - name: client_id
        in: header
        description: Client ID generated during application registration.
        required: true
        type: string
      - name: Content-Type
        in: header
        description: application/json
        required: true
        type: string
      - name: clientDetails
        in: header
        description: This field is used to capture device,browser and network information.
          Refer the developer portal for more information.These are the fields which
          will be passed as part of the header devicePrint,deviceTokenCookie,userIpAddress,userAgent,hardwareId,simId,deviceModel,deviceName,deviceOsName,deviceOsVersion,multitaskingSupportFlag,languageSupport,wifiMacAddress,cellTowerId,locationAreaCode,rsaApplicationKey,wapClientId,mobileCarrierCode,mobileCountryCode,osId,geoLongitude,geoLatitude,geoHorizontalAccuracy,geoAltitude,geoAltitudeAccuracy,geoSpeed,geoTimestamp,geoStatus,basicServiceSetId,signalStrength,wifiChannel,serviceSetId
        type: string
        required: false
      - name: nextPreviousIndicator
        in: query
        description: Indicator for retrieving the next records or the previous records
          in the response
        type: string
        required: false
      - name: RetrieveRewardPointTransactionRedemptionHistoryRequest
        in: body
        description: RetrieveRewardPointTransactionRedemptionHistoryRequest
        required: true
        schema:
          $ref: '#/definitions/RetrieveRewardPointTransactionRedemptionHistoryRequest'
      responses:
        200:
          description: Successful operation.
          schema:
            $ref: '#/definitions/RetrieveRewardPointTransactionRedemptionHistoryResponse'
        204:
          description: No content.
        400:
          description: <table><tr><td>Type</td><td>Code</td><td>Details</td></tr><tr><td>invalid</td><td>invalidRequest</td><td>Missing
            or invalid Parameters</td></tr><tr><td>1</td><td>RWS_6402_0004</td><td>InvalidAccountId</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></tr><tr><td>error</td><td>accessNotConfigured</td><td>The
            request operation is not configured to access this resource</td></tr></table>
          schema:
            $ref: '#/definitions/ErrorResponse'
        404:
          description: <table><tr><td>error</td><td>resourceNotFound</td><td>Empty
            resource/resource not found</td></tr></table>
          schema:
            $ref: '#/definitions/ErrorResponse'
        422:
          description: <table><tr><td>Type</td><td>Code</td><td>Details</td></tr><tr><td>invalid</td><td>invalidRequest</td><td>Missing
            or invalid 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</td></tr></table>
          schema:
            $ref: '#/definitions/ErrorResponse'
  /v1/offers/{offerId}/payWithPoints/unused:
    get:
      summary: This API is used to fetch the Pay with points unused offers.
      description: This API is used to fetch the Pay with points unused offers.
      operationId: UnusedPayWithPointsOfferListInquiry
      tags:
      - PRODUCT PRICING BUNDLING AND REWARDS
      parameters:
      - name: Authorization
        in: header
        description: 'The most recent Authorization token. This will have the format
          Bearer + {space} + {accessToken}. Example: Bearer KGNsaWVudF9pZDpjbGllbnRfc2VjcmV0KQ==.'
        type: string
        required: true
      - name: uuid
        in: header
        description: 128 bit random UUID generated uniquely for every request.
        type: string
        required: true
      - name: Accept
        in: header
        description: Content-Type that are acceptable for the response.
        type: string
        required: true
      - name: client_id
        in: header
        description: Client ID generated during application registration.
        required: true
        type: string
      - name: Accept-Language
        in: header
        description: Accept-Language header.
        required: false
        type: string
      - name: clientDetails
        in: header
        description: This field is used to capture device,browser and network information.
          Refer the developer portal for more information.These are the fields which
          will be passed as part of the header devicePrint,deviceTokenCookie,userIpAddress,userAgent,hardwareId,simId,deviceModel,deviceName,deviceOsName,deviceOsVersion,multitaskingSupportFlag,languageSupport,wifiMacAddress,cellTowerId,locationAreaCode,rsaApplicationKey,wapClientId,mobileCarrierCode,mobileCountryCode,osId,geoLongitude,geoLatitude,geoHorizontalAccuracy,geoAltitude,geoAltitudeAccuracy,geoSpeed,geoTimestamp,geoStatus,basicServiceSetId,signalStrength,wifiChannel,serviceSetId
        type: string
        required: false
      - name: offerId
        in: path
        description: Unique offer Id associated with the offer.
        type: string
        required: true
      responses:
        200:
          description: Successful operation.
          schema:
            $ref: '#/definitions/UnusedPayWithPointsOfferListInquiryResponse'
        204:
          description: No content
        400:
          description: <table><tr><td>Type</td><td>Code</td><td>Details</td></tr><tr><td>invalid</td><td>invalidRequest</td><td>Missing
            or invalid parameters</td></tr><tr><td>error</td><td>invalidOfferId</td><td>Offer
            Id is invalid</td></tr><tr><td>error</td><td>customerNotEligible</td><td>Customer
            is not eligible for the offer</td></tr></table>
          schema:
            $ref: '#/definitions/ErrorResponse'
        401:
          description: <table><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>error</td><td>accessNotConfigured</td><td>Access
            is not configured for this resource</td></tr></table>
          schema:
            $ref: '#/definitions/ErrorResponse'
        500:
          description: <table><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/rewards/payWithPoints/redemption/unusedOffers:
    post:
      summary: This API is used to redeem the Pay with points unused offers.
      description: This API is used to redeem the Pay with points unused offers.
      operationId: RedeemPayWithPointsUnusedOffers
      tags:
      - PRODUCT PRICING BUNDLING AND REWARDS
      parameters:
      - name: Authorization
        in: header
        description: 'The most recent Authorization token. This will have the format
          Bearer + {space} + {accessToken}. Example: Bearer KGNsaWVudF9pZDpjbGllbnRfc2VjcmV0KQ==.'
        required: true
        type: string
      - name: uuid
        in: header
        description: 128 bit random UUID generated uniquely for every request.
        type: string
        required: true
      - name: Accept
        in: header
        description: Content-Type that are acceptable for the response.
        type: string
        required: true
      - name: Content-Type
        in: header
        description: application/json
        required: true
        type: string
      - name: client_id
        in: header
        description: The client ID  you received during application registration in
          the developer portal
        type: string
        required: true
      - name: Accept-Language
        in: header
        description: Accept-Language header.
        required: false
        type: string
      - name: clientDetails
        in: header
        description: This field is used to capture device,browser and network information.
          Refer the developer portal for more information.These are the fields which
          will be passed as part of the header devicePrint,deviceTokenCookie,userIpAddress,userAgent,hardwareId,simId,deviceModel,deviceName,deviceOsName,deviceOsVersion,multitaskingSupportFlag,languageSupport,wifiMacAddress,cellTowerId,locationAreaCode,rsaApplicationKey,wapClientId,mobileCarrierCode,mobileCountryCode,osId,geoLongitude,geoLatitude,geoHorizontalAccuracy,geoAltitude,geoAltitudeAccuracy,geoSpeed,geoTimestamp,geoStatus,basicServiceSetId,signalStrength,wifiChannel,serviceSetId
        type: string
        required: false
      - name: RedeemPayWithPointsUnusedOffersRequest
        in: body
        description: RedeemPayWithPointsUnusedOffersRequest
        required: true
        schema:
          $ref: '#/definitions/RedeemPayWithPointsUnusedOffersRequest'
      responses:
        200:
          description: Successful operation.
          schema:
            $ref: '#/definitions/RedeemPayWithPointsUnusedOffersResponse'
        400:
          description: <table><tr><td>Type</td><td>Code</td><td>Details</td></tr><tr><td>invalid</td><td>invalidRequest</td><td>Missing
            or invalid parameters</td></tr>  <td>error</td><td>exceedsMaximumNumberOfTransactions</td><td>Maximum
            number of transactions is exceeded</td></tr></table>
          schema:
            $ref: '#/definitions/ErrorResponse'
        401:
          description: <table><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>error</td><td>accessNotConfigured</td><td>Access
            is not configured for this resource</td></tr></table>
          schema:
            $ref: '#/definitions/ErrorResponse'
        500:
          description: <table><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/rewards/{rewardLinkCode}/shopWithPoints/reversals:
    post:
      summary: This is to reverse the points redeemed during shop with points
      description: This is to reverse the points redeemed during shop with points
      operationId: ShopWithPointsRedemtionReversal
      tags:
      - PRODUCT PRICING BUNDLING AND REWARDS
      parameters:
      - name: Authorization
        in: header
        description: 'The most recent Authorization token. This will have the format
          Bearer + {space} + {accessToken}. Example: Bearer KGNsaWVudF9pZDpjbGllbnRfc2VjcmV0KQ==.'
        type: string
        required: true
      - name: uuid
        in: header
        description: 128 bit random UUID generated uniquely for every request.
        type: string
        required: true
      - name: Accept
        in: header
        description: Content-Type that are acceptable for the response.
        type: string
        required: true
      - name: client_id
        in: header
        description: Client ID generated during application registration.
        required: true
        type: string
      - name: Content-Type
        in: header
        description: application/json
        required: true
        type: string
      - name: clientDetails
        in: header
        description: This field is used to capture device,browser and network information.
          Refer the developer portal for more information.These are the fields which
          will be passed as part of the header devicePrint,deviceTokenCookie,userIpAddress,userAgent,hardwareId,simId,deviceModel,deviceName,deviceOsName,deviceOsVersion,multitaskingSupportFlag,languageSupport,wifiMacAddress,cellTowerId,locationAreaCode,rsaApplicationKey,wapClientId,mobileCarrierCode,mobileCountryCode,osId,geoLongitude,geoLatitude,geoHorizontalAccuracy,geoAltitude,geoAltitudeAccuracy,geoSpeed,geoTimestamp,geoStatus,basicServiceSetId,signalStrength,wifiChannel,serviceSetId
        type: string
        required: false
      - name: rewardLinkCode
        in: path
        description: Unique link code issued during registration process.
        required: true
        type: string
      - name: ShopWithPointsRedemtionReversalRequest
        in: body
        description: ShopWithPointsRedemtionReversalRequest
        required: true
        schema:
          $ref: '#/definitions/ShopWithPointsRedemtionReversalRequest'
      responses:
        200:
          description: Successful operation.
        204:
          description: No content
        400:
          description: <table><tr><td>error</td><td>invalidRequest</td><td>Missing
            or invalid Parameters</td></tr></table>
          schema:
            $ref: '#/definitions/ErrorResponse'
        401:
          description: <table><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>error</td><td>accessNotConfigured</td><td>Access
            is not configured for this resource</td></tr></table>
          schema:
            $ref: '#/definitions/ErrorResponse'
        404:
          description: <table><tr><td>error</td><td>resourceNotFound</td><td>Resource
            not found</td></tr></table>
          schema:
            $ref: '#/definitions/ErrorResponse'
        422:
          description: <table><tr><td>error</td><td>customerLocked</td><td>Customer
            is locked</td></tr><tr><td>error</td><td>customerNotEligibleForRedemptionReversal</td><td>Customer
            is not eligible for redemption reversal</td></tr><tr><td>error</td><td>transationAlreadyReversed</td><td>Transaction
            has already been redeemed</td></tr><tr><td>error</td><td>partialRedemptionReversalNotAllowed</td><td>Partial
            redemption reversal is not allowed</td></tr><tr><td>error</td><td>invalidRewardLinkCode</td><td>Invalid
            reward link code</td></tr><tr><td>error</td><td>inactiveRewardLinkCode</td><td>Inactve
            reward link code</td></tr></table>
          schema:
            $ref: '#/definitions/ErrorResponse'
        500:
          description: <table><tr><td>fatal</td><td>serverUnavailable</td><td>The
            request failed due to an internal error</td></tr></table>
          schema:
            $ref: '#/definitions/ErrorResponse'
  /v1/rewards/shopWithPoints/redemption/reversals:
    post:
      summary: This is to reverse the points redeemed during shop with points
      description: This is to reverse the points redeemed during shop with points
      operationId: ShopWithPointsPointRedemptionReversal
      tags:
      - PRODUCT PRICING BUNDLING AND REWARDS
      parameters:
      - name: Authorization
        in: header
        description: 'The most recent Authorization token. This will have the format
          Bearer + {space} + {accessToken}. Example: Bearer KGNsaWVudF9pZDpjbGllbnRfc2VjcmV0KQ==.'
        type: string
        required: true
      - name: uuid
        in: header
        description: 128 bit random UUID generated uniquely for every request.
        type: string
        required: true
      - name: Accept
        in: header
        description: Content-Type that are acceptable for the response.
        type: string
        required: true
      - name: client_id
        in: header
        description: Client ID generated during application registration.
        required: true
        type: string
      - name: Content-Type
        in: header
        description: application/json
        required: true
        type: string
      - name: clientDetails
        in: header
        description: This field is used to capture device,browser and network information.
          Refer the developer portal for more information.These are the fields which
          will be passed as part of the header devicePrint,deviceTokenCookie,userIpAddress,userAgent,hardwareId,simId,deviceModel,deviceName,deviceOsName,deviceOsVersion,multitaskingSupportFlag,languageSupport,wifiMacAddress,cellTowerId,locationAreaCode,rsaApplicationKey,wapClientId,mobileCarrierCode,mobileCountryCode,osId,geoLongitude,geoLatitude,geoHorizontalAccuracy,geoAltitude,geoAltitudeAccuracy,geoSpeed,geoTimestamp,geoStatus,basicServiceSetId,signalStrength,wifiChannel,serviceSetId
        type: string
        required: false
      - name: ShopWithPointsPointRedemptionReversalRequest
        in: body
        description: ShopWithPointsPointRedemptionReversalRequest
        required: true
        schema:
          $ref: '#/definitions/ShopWithPointsPointRedemptionReversalRequest'
      responses:
        200:
          description: Successful operation.
        400:
          description: <table><tr><td>Type</td><td>Code</td><td>Details</td></tr><tr><td>invalid</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></tr><tr><td>error</td><td>accessNotConfigured</td><td>The
            request operation is not configured to access this resource</td></tr></table>
          schema:
            $ref: '#/definitions/ErrorResponse'
        404:
          description: <table><tr><td>Type</td><td>Code</td><td>Details</td></tr><tr><td>error</td><td>resourceNotFound</td><td>Empty
            resource/resource not found</td></tr></table>
          schema:
            $ref: '#/definitions/ErrorResponse'
        422:
          description: <table><tr><td>Type</td><td>Code</td><td>Details</td></tr><tr><td>error</td><td>customerNotEligibleForRedemptionReversal</td><td>Customer
            is not eligible for redemption reversal</td></tr><tr><td>error</td><td>partialRedemptionReversalNotAllowed</td><td>Partial
            redemption reversal is not allowed</td></tr><tr><td>error</td><td>transationAlreadyReversed</td><td>Transaction
            has already been redeemed</td></tr><tr><td>error</td><td>customerLocked</td><td>Customer
            is locked</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</td></tr></table>
          schema:
            $ref: '#/definitions/ErrorResponse'
  /v1/rewardPointsAwardsAndRedemption/rewardPrograms/enrollment:
    post:
      summary: This API is for enrollment of rewards program.
      description: This API is for enrollment of rewards program.
      operationId: RequestRewardPointsTransactionRewardProgramsEnrollment
      tags:
      - PRODUCT PRICING BUNDLING AND REWARDS
      parameters:
      - name: Authorization
        in: header
        description: 'The most recent Authorization token. This will have the format
          Bearer + {space} + {accessToken}. Example: Bearer KGNsaWVudF9pZDpjbGllbnRfc2VjcmV0KQ==.'
        type: string
        required: true
      - name: uuid
        in: header
        description: 128 bit random UUID generated uniquely for every request.
        type: string
        required: true
      - name: Accept
        in: header
        description: Content-Type that are acceptable for the response.
        type: string
        required: true
      - name: client_id
        in: header
        description: Client ID generated during application registration.
        required: true
        type: string
      - name: Content-Type
        in: header
        description: application/json
        required: true
        type: string
      - name: clientDetails
        in: header
        description: This field is used to capture device,browser and network information.
          Refer the developer portal for more information.These are the fields which
          will be passed as part of the header devicePrint,deviceTokenCookie,userIpAddress,userAgent,hardwareId,simId,deviceModel,deviceName,deviceOsName,deviceOsVersion,multitaskingSupportFlag,languageSupport,wifiMacAddress,cellTowerId,locationAreaCode,rsaApplicationKey,wapClientId,mobileCarrierCode,mobileCountryCode,osId,geoLongitude,geoLatitude,geoHorizontalAccuracy,geoAltitude,geoAltitudeAccuracy,geoSpeed,geoTimestamp,geoStatus,basicServiceSetId,signalStrength,wifiChannel,serviceSetId
        type: string
        required: false
      - name: RequestRewardPointsTransactionRewardProgramsEnrollmentRequest
        in: body
        description: RequestRewardPointsTransactionRewardProgramsEnrollmentRequest
        required: true
        schema:
          $ref: '#/definitions/RequestRewardPointsTransactionRewardProgramsEnrollmentRequest'
      responses:
        200:
          description: Successful operation.
          schema:
            $ref: '#/definitions/RequestRewardPointsTransactionRewardProgramsEnrollmentResponse'
        400:
          description: <table><tr><td>Type</td><td>Code</td><td>Details</td></tr><tr><td>invalid</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></tr><tr><td>error</td><td>accessNotConfigured</td><td>The
            request operation is not configured to access this resource</td></tr></table>
          schema:
            $ref: '#/definitions/ErrorResponse'
        404:
          description: <table><tr><td>Type</td><td>Code</td><td>Details</td></tr><tr><td>error</td><td>resourceNotFound</td><td>Empty
            resource/resource not found</td></tr></table>
          schema:
            $ref: '#/definitions/ErrorResponse'
        422:
          description: <table><tr><td>Type</td><td>Code</td><td>Details</td></tr><tr><td>error</td><td>businessValidationsFailed</td><td>Business
            validations failed</td><tr><td>Error</td><td>InvalidProduct</td><td>ProductId
            is invalid</td></tr><tr><td>Error</td><td>InvalidCardId</td><td>CardId
            is invalid</td></tr><tr><td>Error</td><td>InvalidBundle</td><td>BundleId
            is invalid</td></tr><tr><td>Error</td><td>BundleAlreadyEnrolled</td><td>Bundle
            is already enrolled</td></tr><tr><td>Error</td><td>BudnleAwaitingEnrollment</td><td>Bundle
            is awaiting enrollment</td></tr><tr><td>Error</td><td>BundleAwaitingDeEnrollment</td><td>Bundle
            is awaiting deenrollment</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</td></tr></table>
          schema:
            $ref: '#/definitions/ErrorResponse'
  /v1/rewardPointsAwardsAndRedemption/rewardPrograms/disenrollment:
    post:
      summary: This API is for de-enrollment of rewards program.
      description: This API is for de-enrollment of rewards program.
      operationId: RequestRewardPointsTransactionRewardProgramsDisenrollment
      tags:
      - PRODUCT PRICING BUNDLING AND REWARDS
      parameters:
      - name: Authorization
        in: header
        description: 'The most recent Authorization token. This will have the format
          Bearer + {space} + {accessToken}. Example: Bearer KGNsaWVudF9pZDpjbGllbnRfc2VjcmV0KQ==.'
        type: string
        required: true
      - name: uuid
        in: header
        description: 128 bit random UUID generated uniquely for every request.
        type: string
        required: true
      - name: Accept
        in: header
        description: Content-Type that are acceptable for the response.
        type: string
        required: true
      - name: client_id
        in: header
        description: Client ID generated during application registration.
        required: true
        type: string
      - name: Content-Type
        in: header
        description: application/json
        required: true
        type: string
      - name: clientDetails
        in: header
        description: This field is used to capture device,browser and network information.
          Refer the developer portal for more information.These are the fields which
          will be passed as part of the header devicePrint,deviceTokenCookie,userIpAddress,userAgent,hardwareId,simId,deviceModel,deviceName,deviceOsName,deviceOsVersion,multitaskingSupportFlag,languageSupport,wifiMacAddress,cellTowerId,locationAreaCode,rsaApplicationKey,wapClientId,mobileCarrierCode,mobileCountryCode,osId,geoLongitude,geoLatitude,geoHorizontalAccuracy,geoAltitude,geoAltitudeAccuracy,geoSpeed,geoTimestamp,geoStatus,basicServiceSetId,signalStrength,wifiChannel,serviceSetId
        type: string
        required: false
      - name: RequestRewardPointsTransactionRewardProgramsDisenrollmentRequest
        in: body
        description: RequestRewardPointsTransactionRewardProgramsDisenrollmentRequest
        required: true
        schema:
          $ref: '#/definitions/RequestRewardPointsTransactionRewardProgramsDisenrollmentRequest'
      responses:
        200:
          description: Successful operation.
        400:
          description: <table><tr><td>Type</td><td>Code</td><td>Details</td></tr><tr><td>invalid</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></tr><tr><td>error</td><td>accessNotConfigured</td><td>The
            request operation is not configured to access this resource</td></tr></table>
          schema:
            $ref: '#/definitions/ErrorResponse'
        404:
          description: <table><tr><td>Type</td><td>Code</td><td>Details</td></tr><tr><td>error</td><td>resourceNotFound</td><td>Empty
            resource/resource not found</td></tr></table>
          schema:
            $ref: '#/definitions/ErrorResponse'
        422:
          description: <table><tr><td>Type</td><td>Code</td><td>Details</td></tr><tr><td>error</td><td>businessValidationsFailed</td><td>Business
            validations failed</td><tr><td>Error</td><td>InvalidProduct</td><td>ProductId
            is invalid</td></tr><tr><td>Error</td><td>InvalidCardId</td><td>CardId
            is invalid</td></tr><tr><td>Error</td><td>InvalidBundle</td><td>BundleId
            is invalid</td></tr><tr><td>Error</td><td>BundleAlreadyEnrolled</td><td>Bundle
            is already enrolled</td></tr><tr><td>Error</td><td>BudnleAwaitingEnrollment</td><td>Bundle
            is awaiting enrollment</td></tr><tr><td>Error</td><td>BundleAwaitingDeEnrollment</td><td>Bundle
            is awaiting deenrollment</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</td></tr></table>
          schema:
            $ref: '#/definitions/ErrorResponse'
  /v1/rewards/shopWithPoints/redemption:
    post:
      summary: The customer can buy any item from partners website using his points
        that have been accumulated on his credit card. There is not point redemption
        in this case. Points are transferred from customers account to partners account.
        Partner can then convert the points in currency
      description: The customer can buy any item from partners website using his points
        that have been accumulated on his credit card. There is not point redemption
        in this case. Points are transferred from customers account to partners account.
        Partner can then convert the points in currency
      operationId: ShopWithPointsRedemption
      tags:
      - ProductPricingBundlingAndRewards
      parameters:
      - name: Authorization
        in: header
        description: 'The most recent Authorization token. This will have the format
          Bearer + {space} + {accessToken}. Example: Bearer KGNsaWVudF9pZDpjbGllbnRfc2VjcmV0KQ==.'
        type: string
        required: true
      - name: uuid
        in: header
        description: 128 bit random UUID generated uniquely for every request.
        type: string
        required: true
      - name: Accept
        in: header
        description: Content-Type that are acceptable for the response.
        type: string
        required: true
      - name: client_id
        in: header
        description: Client ID generated during application registration.
        required: true
        type: string
      - name: Content-Type
        in: header
        description: application/json
        required: true
        type: string
      - name: clientDetails
        in: header
        description: This field is used to capture device,browser and network information.
          Refer the developer portal for more information.These are the fields which
          will be passed as part of the header devicePrint,deviceTokenCookie,userIpAddress,userAgent,hardwareId,simId,deviceModel,deviceName,deviceOsName,deviceOsVersion,multitaskingSupportFlag,languageSupport,wifiMacAddress,cellTowerId,locationAreaCode,rsaApplicationKey,wapClientId,mobileCarrierCode,mobileCountryCode,osId,geoLongitude,geoLatitude,geoHorizontalAccuracy,geoAltitude,geoAltitudeAccuracy,geoSpeed,geoTimestamp,geoStatus,basicServiceSetId,signalStrength,wifiChannel,serviceSetId
        type: string
        required: false
      - name: ShopWithPointsPointRedemptionRequest
        in: body
        description: ShopWithPointsPointRedemptionRequest
        required: true
        schema:
          $ref: '#/definitions/ShopWithPointsPointRedemptionRequest'
      responses:
        200:
          description: Successful operation.
          schema:
            $ref: '#/definitions/ShopWithPointsPointRedemptionResponse'
        206:
          description: This is applicable for scenarios when one or more requests
            are failed.
          schema:
            $ref: '#/definitions/ShopWithPointsPointRedemptionResponse'
        400:
          description: <table><tr><td>Type</td><td>Code</td><td>Details</td></tr><tr><td>invalid</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></tr><tr><td>error</td><td>accessNotConfigured</td><td>The
            request operation is not configured to access this resource</td></tr></table>
          schema:
            $ref: '#/definitions/ErrorResponse'
        422:
          description: <table><tr><td>Type</td><td>Code</td><td>Details</td></tr><tr><td>error</td><td>errorGeneratingOrderId</td><td>Order
            Id is not generated</td></tr><tr><td>error</td><td>inSufficientPointBalance</td><td>The
            order points cannot be more than available balance of the member</td></tr>
            <tr><td>error</td><td>exceedsMaximumPointsAllowed</td><td>Requested amount
            or points are more than allowed equivalent points.</td></tr><tr><td>error</td><td>notEligibleToRedeem</td><td>Member
            not eligible to order this item</td></tr><tr><td>error</td><td>belowMinimumPointsAllowed</td><td>Requested
            amount or points are less than allowed equivalent points.</td></tr><tr><td>error</td><td>inactiveRewardLinkCode</td><td>Reward
            link code is inactive</td></tr><tr><td>error</td><td>invalidPointsAndAmountCombination</td><td>Points
            and amount combination are invalid</td></tr><tr><td>error</td><td>currencyNotSupported</td><td>Currency
            is not supported</td></tr><tr><td>error</td><td>transactionAlreadyRedeemed</td><td>Transaction
            is already redeemed</td></tr><tr><td>error</td><td>RedemptionNotAllowed</td><td>Redemption
            Not allowed</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</td></tr></table>
          schema:
            $ref: '#/definitions/ErrorResponse'
definitions:
  SelectAndCreditRedemptionRequest:
    properties:
      cardId:
        description: The card id in encrypted format
        type: string
        example: 3255613852316f2b4d4d796c344e38756339654972776f663745446e6d4c32486f455a4165374a476858343d
      transactionReferenceId:
        description: 'Reference Id to uniquely identify the transaction.This array
          is deprecated from version 1.1.0 onwards '
        type: array
        example: "10001278"
        items:
          type: string
      transactions:
        type: array
        items:
          $ref: '#/definitions/Transactions'
    required:
    - cardId
  Transactions:
    properties:
      transactionReferenceId:
        description: Reference Id to uniquely identify the transaction.
        type: string
        example: "10001278"
      transactionAmount:
        description: Transaction amount,This field is required for partial rewards
          redemption.
        type: number
        format: double
        example: 800.910000
      currencyCode:
        description: The currency code of the account in ISO 4217 format
        type: string
        example: SGD
      pointsToRedeem:
        description: The points or miles that needs to redeemed. If both transactionAmount
          and pointsToRedeem are sent, it should be correct combination as per the
          below programConversionRate logic:pointsToRedeem = RoundOf (transactionAmount/programConversionRate)
        type: integer
        format: int64
        example: 2500
      transactionDescription:
        description: Transaction description from the merchant
        type: string
        example: Completed
    required:
    - transactionReferenceId
  SelectAndCreditRedemptionResponse:
    properties:
      redemptionDetails:
        type: array
        items:
          $ref: '#/definitions/RedemptionDetails'
      availablePointBalance:
        description: The new points or miles balance.
        type: integer
        format: int64
        example: 6000
      actualAvailablePointBalance:
        description: The new points or miles balance.
        type: number
        format: double
        example: 6000.250000
    required:
    - redemptionDetails
  RedemptionDetails:
    properties:
      orderId:
        description: The unique order id.
        type: string
        example: T25100025
      transactionReferenceId:
        description: Reference Id to uniquely identify the transaction.
        type: string
        example: "10001278"
      redemptionOrderStatus:
        description: This is the status code of the redemption order. This is a reference
          data field. Please use /v1/utilities/referenceData/{redemptionOrderStatus}
          resource to get valid value of this field with description.
        type: string
        example: SUCCESS
      redemptionOrderFailureReason:
        description: This field is to indicate the reason of the failure of redemption
          order. Applicable only in case of any error in redemption.This is a reference
          data field. Please use /v1/utilities/referenceData/{redemptionOrderFailureReason}
          resource to get valid value of this field with description.
        type: string
        example: REDEMPTION_NOT_ALLOWED
    required:
    - transactionReferenceId
  RewardPointsRedemptionRequest:
    properties:
      transactionReferenceNumber:
        description: This is reference number for the original transaction done at
          merchant side using the card.
        type: string
        example: "10001278"
      redemptionOrder:
        $ref: '#/definitions/RedemptionOrder'
    required:
    - transactionReferenceNumber
    - redemptionOrder
  RedemptionOrder:
    properties:
      transactionAmount:
        description: 'The total transaction amount. If both transactionAmount and
          pointsToRedeem are sent, it should be correct combination as per the below
          programConversionRate logic: pointsToRedeem = RoundOf (transactionAmount/programConversionRate)'
        type: number
        format: double
        example: 100.250000
      currencyCode:
        description: The currency code of the account in ISO 4217 format
        type: string
        example: SGD
      pointsToRedeem:
        description: The points or miles that needs to redeemed. If both transactionAmount
          and pointsToRedeem are sent, it should be correct combination as per the
          below programConversionRate logic:pointsToRedeem = RoundOf (transactionAmount/programConversionRate)
        type: integer
        format: int64
        example: 2500
      transactionDescription:
        description: Transaction description from the merchant
        type: string
        example: Completed
    required:
    - transactionAmount
  RewardPointsRedemptionResponse:
    properties:
      orderId:
        description: The unique order id
        type: string
        example: T25100025
      availablePointBalance:
        description: The new points or miles balance
        type: integer
        format: int64
        example: 6000
    required:
    - orderId
  RetrieveRewardPointTransactionRedemptionHistoryRequest:
    properties:
      cardId:
        description: Card number of the customer
        type: string
        example: 12345678987456
      startDate:
        description: Start Date in ISO 8601 date format YYYY-MM-DD
        type: string
        format: date
        example: 8/2/19
      endDate:
        description: End Date in ISO 8601 date format YYYY-MM-DD
        type: string
        format: date
        example: 9/2/19
      redemptionTransactionIndicator:
        description: Type of request.  Possible values. - EARN - REDEMPTION - ALL
          This is a reference data field. Please use /v1/utilities/referenceData/{redemptionTransactionIndicator}
          resource to get valid value of this field with description.
        type: string
        example: ALL
    required:
    - cardId
    - redemptionTransactionIndicator
  RetrieveRewardPointTransactionRedemptionHistoryResponse:
    properties:
      transactionDetails:
        type: array
        items:
          $ref: '#/definitions/TransactionDetails'
      startDate:
        description: Start Date in ISO 8601 date format YYYY-MM-DD
        type: string
        format: date
        example: "2019-01-01"
      endDate:
        description: End Date in ISO 8601 date format YYYY-MM-DD
        type: string
        format: date
        example: "2019-01-01"
      listRs:
        $ref: '#/definitions/ListRs'
      totalRecordsCount:
        description: This element gives Total Number of records.
        type: integer
        format: int32
        example: 50
  TransactionDetails:
    properties:
      transactionDescription:
        description: Transaction description
        type: string
        example: Referral Program
      transactionReferenceId:
        description: Unique reference Id of the transaction
        type: string
        example: ID235687
      transactionDate:
        description: Transaction Date in ISO 8601 date format YYYY-MM-DD
        type: string
        format: date
        example: "2019-01-01"
      transactionRewardPoints:
        description: For redemption, number of Points redeemed. For earn, number of
          Points earned.
        type: number
        format: integer
        example: 55
      redemptionCategory:
        description: Category of redemption. This is a reference data field. Please
          use /v1/utilities/referenceData/{redemptionCategory} resource to get valid
          value of this field with description.
        type: string
        example: SNC
      redemptionStatus:
        description: For Redemption, fulfillment status - fulfilled/cancelled. For
          transaction, earned/reserved. This is a reference data field. Please use
          /v1/utilities/referenceData/{redemptionStatus} resource to get valid value
          of this field with description.
        type: string
        example: FULFILLED
      redemptionTransactionIndicator:
        description: Type of request.  Possible values. - EARN - REDEMPTION - ALL
          This is a reference data field. Please use /v1/utilities/referenceData/{redemptionTransactionIndicator}
          resource to get valid value of this field with description.
        type: string
        example: EARN or REDEMPTION
      inventoryName:
        description: Inventory name is actually used to identify the texture of the
          merchant name.
        type: string
        example: Travel Insurance
      merchantName:
        description: The merchant name with which this transaction was made with.
        type: string
        example: ABC Corp.
      transactionCashAmount:
        description: Cash amount paid for that  transaction .
        type: number
        format: double
        example: 200
    required:
    - transactionDescription
    - transactionDate
    - transactionRewardPoints
    - redemptionTransactionIndicator
  ListRs:
    properties:
      moreIndicator:
        description: For pagination - indicates that more records are available for
          retrieval. Y = more records are available for retrieval, N = no more records
          are available for retrieval
        type: string
        example: "Y"
      nextStartIndex:
        description: For pagination - the starting index for retrieving the next page/batch
          of records. The value of the previous requests listRs.nextStartIndex is
          echoed back in this field.
        type: string
        example: 51
      size:
        description: For pagination - the number of records requested for the next
          page/batch of records.
        type: integer
        format: int32
        example: 5
  UnusedPayWithPointsOfferListInquiryResponse:
    properties:
      customerId:
        description: Unique Id associated with the customer.
        type: string
        example: P011100000125
      availablePointBalance:
        type: number
        format: int64
        description: Number of rewards points or miles available as per the latest
          statement generated.
        example: 10000
      customerOfferDetails:
        type: array
        items:
          $ref: '#/definitions/CustomerOfferDetails'
    required:
    - availablePointBalance
  CustomerOfferDetails:
    properties:
      accountId:
        type: string
        description: The customer account identifier in encrypted format.
        example: 3255613852316f2b4d4d796c344e38756339654972776f663745446e6d4c32486f455a4165374a476858343d
      cardId:
        description: The card id  in encrypted format.
        type: string
        example: 3255613852316f2b4d4d796c344e38756339654972776f663745446e6d4c32486f455a4165374a476858343d
      productCode:
        type: string
        description: A unique code that identifies the product
        example: 0800_VC601
      offerId:
        description: Unique offer ID associated with the offer
        type: string
        example: 111000125
      transactionAmount:
        description: The total transaction amount.
        type: number
        format: double
        example: 1000.250000
      minimuPointsToRedeem:
        description: The minimum number of points that can be used towards a purchase
        type: number
        format: int64
        example: 10000
      programConversionRate:
        description: Points to currency conversion rate for the rewards program
        type: number
        format: double
        example: 0.252100
      merchantName:
        description: The merchant name with which this transaction was made.
        type: string
        example: LAZADA
      transactionReferenceId:
        description: This is reference id for the original transaction done at merchant
          side using the card.
        type: string
        example: "10001278"
      redemptionType:
        description: It Indicates whether Order is for Subscription or Redemption..
          This is  a reference data field. Please use /v1/utilities/referenceData/{redemptionType}
          resource to get possible values of this field with descriptions.
        type: string
        example: Partial
      minimiumRedemptionAmount:
        type: number
        format: double
        description: Minimum amount available for redemption..
        example: 100.120000
      incrementalRedemptionAmount:
        type: number
        format: double
        description: Incremental redemption amount.
        example: 5.110000
      maximumRedemptionAmount:
        type: number
        format: double
        description: Maximum amount available for redemption.
        example: 1000.150000
      overseasTransactionFlag:
        description: Indicator for overseas Transaction.
        type: boolean
        example: true
      redemptionDateTimeStamp:
        description: Date and time of the redemption.
        type: string
        format: dateTime
        example: "2018-11-23T00:00:02+05:00"
    required:
    - offerId
    - cardId
    - productCode
    - transactionAmount
    - programConversionRate
    - transactionReferenceId
    - redemptionType
  RedeemPayWithPointsUnusedOffersRequest:
    properties:
      cardId:
        description: The card id  in encrypted format.
        type: string
        example: 3255613852316f2b4d4d796f663745446e6d4c32486f455a4165374a476858343d
      redemptionMedia:
        description: This field is used to identify the way the offer is sent. This
          is a reference data field. Please use /v1/utilities/referenceData/{redemptionMedia}
          resource to get valid value of this field with description.
        type: string
        example: COPS_1_WAY_SMS
      redemptionOrder:
        type: array
        items:
          $ref: '#/definitions/RedemptionOrders'
    required:
    - redemptionMedia
    - redemptionOrder
    - cardId
  RedemptionOrders:
    properties:
      pointsToRedeem:
        description: The points or miles that needs to redeemed.
        type: number
        format: int64
        example: 25000
      currencyCode:
        description: The currency code of the account in ISO 4217 format
        type: string
        example: SGD
      transactionReferenceId:
        description: This is reference id for the original transaction done at merchant
          side using the card.
        type: string
        example: "10001278"
    required:
    - pointsToRedeem
    - currencyCode
    - transactionReferenceId
  RedeemPayWithPointsUnusedOffersResponse:
    properties:
      availablePointBalance:
        type: number
        format: double
        description: Available reward points on the credit card
        example: 1500.250000
      redemptionOrderStatusDetails:
        type: array
        items:
          $ref: '#/definitions/RedemptionOrderStatusDetails'
    required:
    - availablePointBalance
    - redemptionOrderStatusDetails
  RedemptionOrderStatusDetails:
    properties:
      transactionReferenceId:
        description: This is reference id for the original transaction done at merchant
          side using the card.
        type: string
        example: "10001278"
      redemptionOrderStatus:
        description: This is the status code of the redemption order. This is a reference
          data field. Please use /v1/utilities/referenceData/{redemptionOrderStatus}
          resource to get valid value of this field with description.
        type: string
        example: SUCCESS
      redemptionOrderFailureReason:
        description: This field is to indicate the reason of the failure of redemption
          order. Applicable only in case of any error in redemption.
        type: string
        example: RedemptionNotAllowed
    required:
    - transactionReferenceId
    - redemptionOrderStatus
  ShopWithPointsRedemtionReversalRequest:
    properties:
      orderId:
        description: The unique order id
        type: string
        example: T25100025
      transactionReferenceNumber:
        description: This is reference number for the original transaction done at
          merchant side using the card
        type: string
        example: CTRRT200
  ShopWithPointsPointRedemptionReversalRequest:
    properties:
      cardId:
        description: The card id  in encrypted format
        type: string
        example: 3255613852316f2b4d4d796c344e38756339654972776f663745446e6d4c32486f455a4165374a476858343d
      orderId:
        description: The unique order id
        type: string
        example: T25100025
      transactionReferenceNumber:
        description: A unique reference number being generated at the time of show
          with points Redemption
        type: string
        example: 10000000
  ShopWithPointsPointRedemptionRequest:
    properties:
      cardId:
        description: The card id in encrypted format
        type: string
        example: 3255613852316f2b4d4d796c344e38756339654972776f663745446e6d4c32486f455a4165374a476858343d
      transactions:
        type: array
        items:
          $ref: '#/definitions/Transactions'
    required:
    - cardId
  ShopWithPointsPointRedemptionResponse:
    properties:
      availablePointBalance:
        description: The new reward points or miles balance after Redemption
        type: integer
        format: int64
        example: 6000
      redemptionDetails:
        type: array
        items:
          $ref: '#/definitions/RedemptionDetails'
  RequestRewardPointsTransactionRewardProgramsEnrollmentRequest:
    properties:
      cardId:
        description: Card number in encrypted format.
        type: string
        example: 1233446dghg67
      rewardsProgramProductId:
        description: Product ID
        type: string
        example: CREDIT_CARD
      agentId:
        description: agent Id
        type: string
        example: ab67899
      bundleDetails:
        type: array
        items:
          $ref: '#/definitions/BundleDetails'
      rewardsProgramType:
        description: Reward Program Type
        type: string
        example: REWARDS_BUNDLE_ENROLLMENT
    required:
    - cardId
    - rewardsProgramProductId
  RequestRewardPointsTransactionRewardProgramsDisenrollmentRequest:
    properties:
      cardId:
        description: Card number in encrypted format.
        type: string
        example: 1233446dghg67
      rewardsProgramProductId:
        description: Product ID
        type: string
        example: CREDIT_CARD
      agentId:
        description: agent Id
        type: string
        example: ab67899
      bundleDetails:
        type: array
        items:
          $ref: '#/definitions/BundleDetails'
      rewardsProgramType:
        description: Reward Program Type
        type: string
        example: REWARDS_BUNDLE_ENROLLMENT
    required:
    - cardId
    - rewardsProgramProductId
  BundleDetails:
    properties:
      bundleId:
        description: Bundle ID defined by Biz for the logo
        type: string
        example: FUN MIL
      bundleName:
        description: Bundle Name (Short Name) defined by Biz
        type: string
        example: Tiered Bundle
      autoRenewalFlag:
        description: Bundle auto renewal indicator.
        type: boolean
        example: true
    required:
    - bundleId
    - bundleName
  RequestRewardPointsTransactionRewardProgramsEnrollmentResponse:
    properties:
      bundleStartDate:
        description: Bundle Subscription start date should be in ISO 8601 format YYYY-MM-DD
        type: string
        format: date
        example: "2020-10-24"
      bundleEndDate:
        description: Bundle Subscription End date should be in ISO 8601 format YYYY-MM-DD
        type: string
        format: date
        example: "2020-10-24"
  ErrorResponse:
    properties:
      type:
        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
        type: string
      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: object
    required:
    - type
    - code
x-ibm-configuration:
  enforced: true
  testable: true
  phase: realized
security:
- client_id: []
securityDefinitions:
  client_id:
    type: apiKey
    description: ""
    in: header
    name: X-IBM-Client-Id
x-ibm-endpoints:
- endpointUrl: https://aspac.sit.api.citi.com/gcbap
  description: ""
  type:
  - production
  - development
...