Barclays Rewards Pay with Points API

openapi: 3.1.0
info:
  title: Benefits Redemption
  description: Enables users to view and redeem their rewards
  version: '3.0'
x-method: searched
x-source: https://developer.barclays.com/api/apis/versions/0ef2bd66-883a-4a03-80e8-e08319f97bfe.bdn/design?specification=oas31
x-harvested: '2026-09-04'
x-harvested-note: Verbatim OpenAPI 3.1 design export from the Barclays API Exchange registry (developer.barclays.com), fetched
  anonymously. The untouched export is in openapi/_original/barclays-benefits-redemption-openapi.json. The UK Open Banking
  documents carry OBIE (openbanking.org.uk) in info.contact/termsOfService because they are the OBIE standard contract as
  Barclays implements and publishes it — the API, the registry record and the host are Barclays'.
tags:
- name: Rewards-Balance
- name: Rewards-Redemption-Eligibility
- name: Rewards-Redemption-Capabilities
- name: Rewards-Redemption
- name: Rewards-Redemption-History
paths:
  /cards/accounts/external/{externalAccountID}/redemption/capabilities:
    summary: Retrieves the available external redemption capabilities for an account.
    description: Retrieves the available external redemption capabilities for an account.
    get:
      tags:
      - Rewards-Redemption-Capabilities
      summary: Get external redemption capabilities
      description: Retrieves the external redemption capabilities for an account.
      operationId: getRedemptionCapabilities
      parameters:
      - name: Correlation-ID
        in: header
        description: 'Unique identifier for each incoming request. The API caller must pass this in the header, which will
          be cascaded through the API call stack.

          This is required to maintain compliance with the current Barclays REST standards.'
        required: true
        deprecated: false
        allowEmptyValue: false
        schema:
          type: string
          maxLength: 36
          minLength: 36
          pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
        example: 7d444840-9dc0-11d1-b245-5ffdce74fad2
      - name: externalAccountID
        in: path
        description: A unique id (similar to UUID) created for each customer account.
        required: true
        deprecated: false
        schema:
          type: string
          maxLength: 36
          minLength: 1
          pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
        example: 0dbcb7ee-6c59-483b-966a-44d11557665b
      - name: Authorization
        in: header
        description: TIAA-US External token
        required: true
        deprecated: false
        schema:
          type: string
        example: Bearer <token>
      responses:
        '200':
          $ref: '#/components/responses/RedemptionCapabilitiesResponse'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '500':
          $ref: '#/components/responses/InternalServerError'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '503':
          $ref: '#/components/responses/ServiceUnavailable'
        '429':
          $ref: '#/components/responses/TooManyRequests'
      deprecated: false
  /cards/accounts/external/{externalAccountID}/rewards/balance:
    summary: Operations by Account ID.
    description: Operations by Account ID.
    get:
      tags:
      - Rewards-Balance
      summary: Get current rewards balance for the given account.
      description: Get current rewards balance for the given account.
      operationId: getRewardsBalanceV3
      parameters:
      - name: externalAccountID
        in: path
        description: A unique id (similar to UUID) created for each customer account.
        required: true
        deprecated: false
        schema:
          type: string
          maxLength: 36
          minLength: 1
          pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
        example: 0dbcb7ee-6c59-483b-966a-44d11557665b
      - name: Correlation-ID
        in: header
        description: 'Unique identifier for each incoming request. The API caller must pass this in the header, which will
          be cascaded through the API call stack.

          This is required to maintain compliance with the current Barclays REST standards.'
        required: true
        deprecated: false
        allowEmptyValue: false
        schema:
          type: string
          maxLength: 36
          minLength: 36
          pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
        example: 7d444840-9dc0-11d1-b245-5ffdce74fad2
      - name: Authorization
        in: header
        description: TIAA-US External token
        required: true
        deprecated: false
        schema:
          type: string
        example: Bearer <token>
      responses:
        '200':
          $ref: '#/components/responses/RewardPointBalanceResponseV3'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '500':
          $ref: '#/components/responses/500_getBalance'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '503':
          $ref: '#/components/responses/ServiceUnavailable'
        '429':
          $ref: '#/components/responses/TooManyRequests'
      deprecated: false
  /cards/accounts/external/{externalAccountID}/rewards/redemption:
    summary: Fulfill statement credit/ACH for the given account and corresponding program attributes.
    description: Deducts rewards from the given account and posts a statement credit/ACH. Returns a redemption id for tracking.
    post:
      tags:
      - Rewards-Redemption
      summary: Fulfill statement credit/ACH for the given account and corresponding program attributes.
      description: Deducts rewards from the given account and posts a statement credit/ACH. Returns a redemption id for tracking.
      operationId: postRewardsRedemption
      parameters:
      - name: Content-Type
        in: header
        description: Content-Type
        required: true
        deprecated: false
        allowEmptyValue: false
        schema:
          type: string
          maxLength: 16
          minLength: 16
          pattern: ^[a-z/]{16}$
        example: application/json
      - name: externalAccountID
        in: path
        description: A unique id (similar to UUID) created for each customer account.
        required: true
        deprecated: false
        schema:
          type: string
          maxLength: 36
          minLength: 1
          pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
        example: 0dbcb7ee-6c59-483b-966a-44d11557665b
      - name: Correlation-ID
        in: header
        description: 'Unique identifier for each incoming request. The API caller must pass this in the header, which will
          be cascaded through the API call stack.

          This is required to maintain compliance with the current Barclays REST standards.'
        required: true
        deprecated: false
        allowEmptyValue: false
        schema:
          type: string
          maxLength: 36
          minLength: 36
          pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
        example: 7d444840-9dc0-11d1-b245-5ffdce74fad2
      - name: X-Channel-Id
        in: header
        description: The channel ID of external entity initiating the call.
        required: false
        deprecated: false
        schema:
          type: string
          maxLength: 40
          minLength: 1
          pattern: ^[A-Za-z0-9\-_]{1,40}$
        example: WALLET
      - name: Authorization
        in: header
        description: TIAA-US External token
        required: true
        deprecated: false
        schema:
          type: string
        example: Bearer <token>
      requestBody:
        description: Contains information required for the redemption operation.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RedemptionRequestDataV3'
            examples:
              RedemptionRequestPayWithPoints:
                $ref: '#/components/examples/RedemptionRequestPayWithPoints'
              RedemptionRequestCashBackStmntCr:
                $ref: '#/components/examples/RedemptionRequestCashBackStmntCr'
              RedemptionRequestCashBackACH:
                $ref: '#/components/examples/RedemptionRequestCashBackACH'
        required: true
      responses:
        '200':
          $ref: '#/components/responses/RedemptionResponseV3'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '500':
          $ref: '#/components/responses/500_redemption'
        '403':
          $ref: '#/components/responses/Forbidden_redemption'
        '404':
          $ref: '#/components/responses/NotFound'
        '503':
          $ref: '#/components/responses/ServiceUnavailable'
        '428':
          $ref: '#/components/responses/FraudChallenge'
        '429':
          $ref: '#/components/responses/TooManyRequests'
      deprecated: false
  /cards/accounts/external/{externalAccountID}/redemption/eligibility:
    summary: Rewards API for fetching redemption eligibility.
    description: Rewards API for fetching redemption eligibility.
    get:
      tags:
      - Rewards-Redemption-Eligibility
      summary: Retrieves redemption eligibility information based on available redemption options for a specific external
        account.
      description: Retrieves redemption eligibility information on available redemption options for a specific external account.
      operationId: getRedemptionEligibility
      parameters:
      - name: Correlation-ID
        in: header
        description: 'Unique identifier for each incoming request. The API caller must pass this in the header, which will
          be cascaded through the API call stack.

          This is required to maintain compliance with the current Barclays REST standards.'
        required: true
        deprecated: false
        allowEmptyValue: false
        schema:
          type: string
          maxLength: 36
          minLength: 36
          pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
        example: 7d444840-9dc0-11d1-b245-5ffdce74fad2
      - name: externalAccountID
        in: path
        description: A unique id (similar to UUID) created for each customer account.
        required: true
        deprecated: false
        schema:
          type: string
          maxLength: 36
          minLength: 1
          pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
        example: 0dbcb7ee-6c59-483b-966a-44d11557665b
      - name: includeCashBackACHEligibility
        in: query
        description: Include Cash Back ACH redemption eligibility information
        required: false
        deprecated: false
        allowEmptyValue: false
        schema:
          type: boolean
          default: true
        example: true
      - name: includeCashBackStmntCrEligibility
        in: query
        description: Include Cash Back Statement credit redemption eligibility information
        required: false
        deprecated: false
        allowEmptyValue: false
        schema:
          type: boolean
          default: true
        example: true
      - name: includePayWithPointsEligibility
        in: query
        description: Include Pay With Points redemption eligibility information
        required: false
        deprecated: false
        allowEmptyValue: false
        schema:
          type: boolean
          default: true
        example: true
      - name: Authorization
        in: header
        description: TIAA-US External token
        required: true
        deprecated: false
        schema:
          type: string
        example: Bearer <token>
      responses:
        '200':
          $ref: '#/components/responses/RedemptionEligibilityResponse'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '500':
          $ref: '#/components/responses/InternalServerError'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '503':
          $ref: '#/components/responses/ServiceUnavailable'
        '429':
          $ref: '#/components/responses/TooManyRequests'
      deprecated: false
  /cards/accounts/external/{externalAccountID}/redemption/history:
    summary: Get rewards redemption history for externalAccountId
    description: Get rewards redemption history for externalAccountId
    get:
      tags:
      - Rewards-Redemption-History
      summary: Get rewards redemption history for externalAccountId
      description: Get rewards redemption history for externalAccountId
      operationId: getRedemptionHistory
      parameters:
      - name: externalAccountID
        in: path
        description: A unique id (similar to UUID) created for each customer account.
        required: true
        deprecated: false
        schema:
          type: string
          maxLength: 36
          minLength: 1
          pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
        example: 0dbcb7ee-6c59-483b-966a-44d11557665b
      - name: Correlation-ID
        in: header
        description: 'Unique identifier for each incoming request. The API caller must pass this in the header, which will
          be cascaded through the API call stack.

          This is required to maintain compliance with the current Barclays REST standards.'
        required: true
        deprecated: false
        allowEmptyValue: false
        schema:
          type: string
          maxLength: 36
          minLength: 36
          pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
        example: 7d444840-9dc0-11d1-b245-5ffdce74fad2
      - name: redemptionType
        in: query
        description: List of redemption types which will be included in response
        required: false
        deprecated: false
        allowEmptyValue: false
        schema:
          type: array
          items:
            type: string
            description: Type of redemption.
            example: CASH_BACK
            maxLength: 50
            minLength: 1
            pattern: ^[a-zA-Z_]{1,50}$
          maxItems: 50
          minItems: 1
        example:
        - CASH_BACK
        - PAY_WITH_POINTS
      - name: includeFailures
        in: query
        description: Include failed redemptions in response
        required: false
        deprecated: false
        allowEmptyValue: false
        schema:
          type: boolean
          default: true
        example: true
      - name: fromDate
        in: query
        description: Fetch redemption history starting from this date
        required: false
        deprecated: false
        allowEmptyValue: false
        schema:
          type: string
          maxLength: 10
          minLength: 10
          pattern: ^\d{4}-\d{2}-\d{2}$
        example: '2024-02-21'
      - name: toDate
        in: query
        description: Fetch redemption history till this date
        required: false
        deprecated: false
        allowEmptyValue: false
        schema:
          type: string
          maxLength: 10
          minLength: 10
          pattern: ^\d{4}-\d{2}-\d{2}$
        example: '2026-02-21'
      - name: Authorization
        in: header
        description: TIAA-US External token
        required: true
        deprecated: false
        schema:
          type: string
        example: Bearer <token>
      responses:
        '200':
          $ref: '#/components/responses/RedemptionHistoryResponse'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '500':
          $ref: '#/components/responses/500_redemption'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '503':
          $ref: '#/components/responses/ServiceUnavailable'
        '429':
          $ref: '#/components/responses/TooManyRequests'
      deprecated: false
components:
  schemas:
    RedemptionRule:
      type: object
      additionalProperties: false
      deprecated: false
      description: Defined rule for the redemption type.
      properties:
        ruleId:
          type: string
          description: Unique identifier for the rule.
          example: '100005000000'
          maxLength: 50
          minLength: 1
          pattern: ^[a-zA-Z0-9]{1,50}$
        ruleName:
          type: string
          description: Name of the rule.
          example: Samsung Cashback Rule
          maxLength: 50
          minLength: 1
          pattern: ^.{1,50}$
        conversionRate:
          type: number
          description: Conversion rate for the redemption.
          example: 1
        minRedeem:
          type: number
          description: Minimum amount that can be redeemed.
          example: 1500
        maxRedeem:
          type: number
          description: Maximum amount that can be redeemed.
          example: 5000
      required:
      - conversionRate
      - maxRedeem
      - minRedeem
      - ruleId
      - ruleName
      nullable: false
    RedemptionResponseDataV3:
      type: object
      additionalProperties: false
      deprecated: false
      description: Root object that holds a redemption id and current rewards balance upon a successful redemption.
      properties:
        data:
          $ref: '#/components/schemas/RedemptionResponseV3'
      required:
      - data
      nullable: false
    Eligibility:
      type: object
      additionalProperties: false
      deprecated: false
      description: Determines eligibility of redemption option
      properties:
        value:
          type: boolean
          description: Redemption type eligibility determination and reasoning
          example: true
        ineligibilityReason:
          type: string
          description: Reason for ineligibility
          example: No configured accounts
          maxLength: 200
          minLength: 1
          pattern: ^.{1,200}$
          nullable: true
      required:
      - value
      nullable: false
    RedemptionHistoryResponseData:
      type: object
      additionalProperties: false
      deprecated: false
      description: Redemption History Response Data
      properties:
        data:
          $ref: '#/components/schemas/RedemptionHistoryResponse'
      required:
      - data
      nullable: false
    FulfillmentMethod:
      type: object
      additionalProperties: false
      deprecated: false
      description: Fulfillment method for the redemption type.
      properties:
        fulfillmentMethod:
          type: string
          description: Method of fulfillment.
          example: STMNT_CR
          maxLength: 50
          minLength: 1
          pattern: ^[a-zA-Z_]{1,50}$
        capAmount:
          type: number
          description: Maximum amount that can be redeemed per cap period.
          example: 50
        capPeriod:
          type: string
          description: Period for the cap amount.
          example: DAY
          maxLength: 50
          minLength: 1
          pattern: ^[a-zA-Z_]{1,50}$
      required:
      - fulfillmentMethod
      nullable: false
    RewardBalanceV3:
      type: object
      additionalProperties: false
      deprecated: false
      description: Contains rewards balance.
      properties:
        availableBalance:
          type: number
          description: Current rewards balance for the given account. Represents the total amount of rewards that can be redeemed.
          example: 1000
        rewardCurrencyDisplayName:
          type: string
          description: User-friendly display name for the reward currency type. This is human-readable name to be shown in
            the user interface.
          example: Rewards
          maxLength: 50
          minLength: 1
          pattern: ^.{1,50}$
        rewardType:
          type: string
          description: Rewards currency type
          example: Cash
          maxLength: 16
          minLength: 1
          pattern: ^.{1,16}$
        isCashBased:
          type: boolean
          description: Indicates if rewards are cash based or non cash based.
          example: true
      required:
      - availableBalance
      - isCashBased
      - rewardCurrencyDisplayName
      - rewardType
      nullable: false
    CashCapability:
      type: object
      additionalProperties: false
      deprecated: false
      description: Details about the cash-based redemption capability.
      properties:
        redemptionType:
          type: string
          description: Type of redemption.
          example: CASH_BACK
          maxLength: 50
          minLength: 1
          pattern: ^[a-zA-Z_]{1,50}$
        redemptionTypeId:
          type: string
          description: Unique identifier for the redemption type.
          example: 6070de43-c712-4902-9077-0a69b691eaea
          maxLength: 36
          minLength: 36
          pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
        redemptionTypeName:
          type: string
          description: Name for the redemption type.
          example: Samsung Cashback
          maxLength: 100
          minLength: 1
          pattern: ^.{1,100}$
        fulfillmentMethods:
          type: array
          description: Available fulfillment methods for the redemption type.
          items:
            $ref: '#/components/schemas/FulfillmentMethod'
          maxItems: 5
          minItems: 1
        rules:
          type: array
          description: Defined rules for the redemption type.
          items:
            $ref: '#/components/schemas/RedemptionRule'
          maxItems: 20
          minItems: 1
      required:
      - fulfillmentMethods
      - redemptionType
      - redemptionTypeId
      - redemptionTypeName
      - rules
      nullable: false
    ACHDetails:
      type: object
      additionalProperties: false
      deprecated: false
      description: Contains details of external bank account to which ACH was applied
      properties:
        accountAlias:
          type: string
          description: User-defined account alias
          example: AAA Bank
          maxLength: 200
          minLength: 1
          pattern: ^.{1,200}$
          nullable: false
        bankName:
          type: string
          description: Name of the bank
          example: Barclays
          maxLength: 200
          minLength: 1
          pattern: ^.{1,200}$
          nullable: false
        last4Digits:
          type: number
          description: Last 4 digits of account number
          example: 1234
      nullable: true
    RedemptionResponseV3:
      type: object
      additionalProperties: false
      deprecated: false
      description: Contains redemption id and status of redemption request.
      properties:
        redemptionReferenceNumber:
          type: string
          description: UUID received in the API request will be sent back in the API response upon a successful redemption.
          example: 1c4717c4-d4a5-e3f3-4a71-b868908763ff
          maxLength: 36
          minLength: 36
          pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
        redemptionId:
          type: string
          description: Unique id generated by Barclays for a redemption.
          example: '142342342'
          maxLength: 20
          minLength: 1
          pattern: ^[a-zA-Z0-9]{1,20}$
        status:
          type: string
          description: Redemption status
          enum:
          - ACCEPTED
          - IN_PROCESS
          - COMPLETED
          - FAILURE
          - CANCELLED
          - RETURNED
          example: COMPLETED
      required:
      - redemptionId
      - redemptionReferenceNumber
      - status
      nullable: false
    RedemptionCapabilitiesResponseData:
      type: object
      additionalProperties: false
      deprecated: false
      description: Redemption Capabilities Response Data
      properties:
        data:
          $ref: '#/components/schemas/RedemptionCapabilitiesResponse'
      required:
      - data
      nullable: false
    RedemptionAmount:
      type: object
      additionalProperties: false
      deprecated: false
      description: Dollar value of rewards to be applied to the account via statement credit or ACH
      properties:
        currency:
          type: string
          description: Currency
          example: USD
          maxLength: 10
          minLength: 1
          pattern: ^.{1,10}$
        amount:
          type: number
          description: Amount
          example: 20
      nullable: true
    ErrorType:
      type: object
      additionalProperties: false
      description: Message details - additional operation execution information.
      properties:
        id:
          type: string
          description: Generated message identifier for particular request, helping to locate server logs.
          example: 1c4717c4-d4a5-e3f3-4a71-b868908763ff
          maxLength: 36
          minLength: 36
          pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
        code:
          type: string
          description: Machine readable, unique code of the message related to particular case within operation execution.
          example: ACCOUNT_NUMBER_NOT_FOUND
          maxLength: 100
          minLength: 1
          pattern: ^[a-zA-Z0-9_]{1,100}$
        title:
          type: string
          description: Short description of the error. Not for displaying purposes.
          example: The authorization credentials required for this request are invalid
          maxLength: 250
          minLength: 1
          pattern: ^[a-zA-Z0-9\s"=,']{1,250}$
        detail:
          type: string
          description: Provides additional low-level details about the error to assist with troubleshooting. Not for displaying
            purposes.
          maxLength: 250
          minLength: 1
          pattern: ^[a-zA-Z0-9\s"=,']{1,250}$
      required:
      - code
      - id
      - title
    RedemptionRequestDataV3:
      type: object
      additionalProperties: false
      deprecated: false
      description: Root object that holds redemption amount and related program attributes.
      properties:
        data:
          $ref: '#/components/schemas/RedemptionRequestV3'
      required:
      - data
      nullable: false
    TransactionInfo:
      type: object
      additionalProperties: false
      description: Optional metadata supplied by partner for pay with points redemption.
      properties:
        authorizationCode:
          type: string
          description: Authorization code generated by merchant at point of sale.
          example: 5R20BK11W6
          maxLength: 50
          minLength: 1
          pattern: ^[a-zA-Z0-9]{1,50}$
        transactionDesc:
          type: string
          description: Free-text description of the source transaction tied to redemption.
          example: Online order placed at Expedia.com for a hotel booking
          maxLength: 200
          minLength: 1
          pattern: ^.{1,200}$
          nullable: true
      nullable: true
    RedemptionEligibilityResponseData:
      type: object
      additionalProperties: false
      deprecated: false
      description: Redemption Eligibility Response Data
      properties:
        data:
          $ref: '#/components/schemas/RedemptionEligibilityResponse'
      required:
      - data
      nullable: false
    RedemptionRequestV3:
      type: object
      additionalProperties: false
      deprecated: false
      description: Redemption amount and related program attributes.
      properties:
        redemptionReferenceNumber:
          type: string
          description: UUID to keep track of each redemption request from a partner. Generated by the partner and passed in
            each request.
          example: 1c4717c4-d4a5-e3f3-4a71-b868908763ff
          maxLength: 36
          minLength: 36
          pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
        redemptionAmount:
          type: number
          description: Dollar value of the rewards to be redeemed. Minimum and Maximum limits depend on program setup.
          example: 50
        conversionRate:
          type: number
          description: 'Denotes the dollar value of rewards (ex: 1 point = $0.01).'
          example: 0.01
        rewards:
          type: number
          description: Quantity of rewards/points consumed for this redemption.
          example: 50
        redemptionTypeId:
          type: string
          description: Unique identifier for the partner product brand.
          maxLength: 36
          minLength: 36
          pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
        redemptionType:
          type: string
          description: Type of redemption.
          example: CASH_BACK
          maxLength: 30
          minLength: 1
          pattern: ^[a-zA-Z_]{1,30}$
        fulfillmentMethod:
          type: string
          description: Method of fulfillment.
          example: STMNT_CR
          maxLength: 20
          minLength: 1
          pattern: ^[a-zA-Z_]{1,20}$
        externalAccountRefId:
          type: string
          description: External account reference ID required for ACH-based fulfillment.
          example: '1214534'
          maxLength: 30
          minLength: 1
          pattern: ^[0-9a-zA-Z]{1,30}$
          nullable: true
        transactionInfo:
          $ref: '#/components/schemas/TransactionInfo'
      required:
      - conversionRate
      - fulfillmentMethod
      - redemptionAmount
      - redemptionReferenceNumber
      - redemptionType
      - redemptionTypeId
      - rewards
      nullable: false
    CashBackACH:
      type: object
      additionalProperties: false
      deprecated: false
      description: Cash Back ACH redemption eligibility information (only present if query parameter includeCashBackACHEligibility=true)
      properties:
        eligibility:
          $ref: '#/components/schemas/Eligibility'
        remainingLimit:
          $ref: '#/components/schemas/RemainingLimit'
        externalAccounts:
          type: array
          description: List of external bank accounts configured for ACH
          items:
            $ref: '#/components/schemas/ExternalAccount'
          maxItems: 100
          minItems: 0
      required:
      - eligibility
      - externalAccounts
      nullable: true
    CashBackStmntCr:
      type: object
      additionalProperties: false
      deprecated: false
      description: Cash Back Statement credit redemption eligibility information (only present if query parameter includeCashBackStmntCrEligibility=true)
      properties:
        eligibility:
          $ref: '#/components/schemas/Eligibility'
        remainingLimit:
          $ref: '#/components/schemas/RemainingLimit'
      required:
      - eligibility
      nullable: true
    LineItem:
      type: object
      additionalProperties: false
      deprecated: false
      properties:
        lineItemId:
          type: string
          description: line item id
          example: S16705z
          maxLength: 36
          minLength: 1
          pattern: ^[a-zA-Z0-9-]{1,36}$
        rewardName:
          type: string
          description: Reward name
          example: Points Payback Credit
          maxLength: 200
          minLength: 1
          pattern: ^.{1,200}$
        rewardsRedeemed:
          type: number
          description: Rewards redeemed
          example: 11
        fulfillmentMethod:
          type: string
          description: Method of fulfillment or delivery
          example: RW_ACH
          maxLength: 20
          minLength: 1
          pattern: ^.{1,20}$
        shippingDate:
          type: string
          description: Delivery date of Non-Cash gift card/merchandise
          example: 07/25/2025
          maxLength: 10
          minLength: 10
          pattern: ^\d{2}/\d{2}/\d{4}$
          nullable: true
        redemptionA

# --- truncated at 32 KB (70 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/barclays/refs/heads/main/openapi/barclays-benefits-redemption-openapi.yml