How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Barclays Rewards Pay with Points API

Enable customers to pay with Barclays Rewards points at merchant point-of-sale.

Barclays Rewards Pay with Points API is one of 30 APIs that Barclays publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Loyalty and Rewards. The published artifact set on APIs.io includes API documentation, an API reference, and an OpenAPI specification.

This API exposes 5 operations across 5 paths, organized into 5 resource areas, and defines 28 schemas. It is described by OpenAPI 3.1.0, at version 3.0.

5 operations 5 paths 28 schemas 4 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
3.0
Authentication
OAuth 2.0
Resource Areas
5

Authentication & Security 1

Barclays Rewards Pay with Points API declares 1 security scheme for authenticating requests. It supports OAuth 2.0 (ExternalTiaaUsCCAuth) using the clientCredentials flow, exposing 2 scopes.

  • ExternalTiaaUsCCAuth — OAuth2.0 Client Credentials Grant authentication using TIAA-US for external APIs

Paths & Operations 5

Across 5 paths, the API surfaces 5 operations — 4 GET, 1 POST. They span 5 resource areas: Rewards-Redemption-Capabilities, Rewards-Balance, Rewards-Redemption, Rewards-Redemption-Eligibility, Rewards-Redemption-History. Each is listed below with its method, path, parameters, and response codes.

Rewards-Redemption-Capabilities 1
GET
/cards/accounts/external/{externalAccountID}/redemption/capabilities
Get external redemption capabilities
getRedemptionCapabilities 3 params → 200400401500403404503429
Rewards-Balance 1
GET
/cards/accounts/external/{externalAccountID}/rewards/balance
Get current rewards balance for the given account.
getRewardsBalanceV3 3 params → 200400401500403404503429
Rewards-Redemption 1
POST
/cards/accounts/external/{externalAccountID}/rewards/redemption
Fulfill statement credit/ACH for the given account and corresponding program attributes.
postRewardsRedemption 5 params body → 200400401500403404503428
Rewards-Redemption-Eligibility 1
GET
/cards/accounts/external/{externalAccountID}/redemption/eligibility
Retrieves redemption eligibility information based on available redemption options for a specific external account.
getRedemptionEligibility 6 params → 200400401500403404503429
Rewards-Redemption-History 1
GET
/cards/accounts/external/{externalAccountID}/redemption/history
Get rewards redemption history for externalAccountId
getRedemptionHistory 7 params → 200400401500403404503429

Schemas 28

The contract defines 28 schemas that model the data the API accepts and returns. The most detailed are LineItem (12 properties), RedemptionRequestV3 (9 properties), RedemptionCapabilitiesResponse (7 properties), CashCapability (5 properties). Each schema is shown below with its type and property counts.

RedemptionRule
object
Defined rule for the redemption type.
5 properties 5 required
RedemptionResponseDataV3
object
Root object that holds a redemption id and current rewards balance upon a successful redemption.
1 property 1 required
Eligibility
object
Determines eligibility of redemption option
2 properties 1 required
RedemptionHistoryResponseData
object
Redemption History Response Data
1 property 1 required
FulfillmentMethod
object
Fulfillment method for the redemption type.
3 properties 1 required
RewardBalanceV3
object
Contains rewards balance.
4 properties 4 required
CashCapability
object
Details about the cash-based redemption capability.
5 properties 5 required
ACHDetails
object
Contains details of external bank account to which ACH was applied
3 properties
RedemptionResponseV3
object
Contains redemption id and status of redemption request.
3 properties 3 required
RedemptionCapabilitiesResponseData
object
Redemption Capabilities Response Data
1 property 1 required
RedemptionAmount
object
Dollar value of rewards to be applied to the account via statement credit or ACH
2 properties
ErrorType
object
Message details - additional operation execution information.
4 properties 3 required
RedemptionRequestDataV3
object
Root object that holds redemption amount and related program attributes.
1 property 1 required
TransactionInfo
object
Optional metadata supplied by partner for pay with points redemption.
2 properties
RedemptionEligibilityResponseData
object
Redemption Eligibility Response Data
1 property 1 required
RedemptionRequestV3
object
Redemption amount and related program attributes.
9 properties 7 required
CashBackACH
object
Cash Back ACH redemption eligibility information (only present if query parameter includeCashBackACHEligibility=true)
3 properties 2 required
CashBackStmntCr
object
Cash Back Statement credit redemption eligibility information (only present if query parameter includeCashBackStmntCrEligibility=true)
2 properties 1 required
LineItem
object
12 properties 6 required
ErrorResponseType
object
An API error response.
2 properties
ExternalAccount
object
Contains details of external bank accounts configured on an account for ACH
5 properties 5 required
RedemptionEligibilityResponse
object
Contains redemption eligibility information based on available redemption options for a specific external account.
4 properties 1 required
PayWithPoints
object
Pay With Points redemption eligibility information (only present if query parameter includePayWithPointsEligibility=true)
2 properties 1 required
RedemptionCapabilitiesResponse
object
Contains redemption eligibility information based on available redemption options for a specific external account.
7 properties 6 required
RewardBalanceDataV3
object
Root object that holds rewards balance.
1 property 1 required
Redemption
object
Contains redemption history information.
4 properties 4 required
RemainingLimit
object
Contains the remaining amount for redemption if a cap amount is configured on redemption option
2 properties 2 required
RedemptionHistoryResponse
object
Redemption history Response
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

barclays-benefits-redemption-openapi.yml Raw ↑

Other APIs Barclays publishes across the network.

Barclays Smartpay Web Payment API
Barclays Bank Ireland Confirmation of Funds API
Barclays Account and Transactions API
Barclays Bank Ireland Account Information API
Barclays Bank Ireland Payment Initiation API
Barclays Confirmation of Funds API
Barclays Dynamic Client Registration API
Barclays Event Notification API
Barclays Payment Initiation API
Barclays ATM Locator API
Barclays Branch Locator API
Barclays FCA Service Metrics API
Where this information came from

This is an independent, third-party profile of Barclays Rewards Pay with Points API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.