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

Hampden & Co Offers API

The Offers API from Hampden & Co — 2 operation(s) for offers.

Hampden & Co Offers API is one of 29 APIs that Hampden & Co publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

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

This API exposes 2 operations across 2 paths, and defines 10 schemas. It is described by OpenAPI 3.2.0, at version 4.0.1.

Requests are made against a single base URL, /open-banking/v4.0/aisp.

2 operations 2 paths 10 schemas 2 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
4.0.1
Base URL
https://developer-sandbox.hampdendigital.com
Authentication
OAuth 2.0, OAuth 2.0
Terms of Service
Resource Areas
1

Authentication & Security 2

Hampden & Co Offers API declares 2 security schemes for authenticating requests. It supports OAuth 2.0 (TPPOAuth2Security) using the clientCredentials flow, exposing 1 scope. It supports OAuth 2.0 (PSUOAuth2Security) using the authorizationCode flow, exposing 1 scope.

  • TPPOAuth2Security — TPP client credential authorisation flow with the ASPSP
  • PSUOAuth2Security — OAuth flow, it is required when the PSU needs to perform SCA with the ASPSP when a TPP wants to access an ASPSP resource owned by the PSU

Paths & Operations 2

Across 2 paths, the API surfaces 2 operations — 2 GET. Each is listed below with its method, path, parameters, and response codes.

Offers 2
GET
/accounts/{AccountId}/offers
Get Offers for an AccountId
GetAccountsAccountIdOffers 7 params → 200400401403404405406429
GET
/offers
Get Offers
GetOffers 6 params → 200400401403404405406429

Schemas 10

The contract defines 10 schemas that model the data the API accepts and returns. The most detailed are Links (5 properties), OBErrorResponse1 (4 properties), OBError1 (4 properties), Meta (3 properties). Each schema is shown below with its type and property counts.

Meta
object
Meta Data relevant to the payload
3 properties
AccountId
string
A unique and immutable identifier used to identify the account resource. This identifier has no meaning to the account owner.
OBError1
object
4 properties 1 required
OBExternalStatusReason1Code
string
Low level textual error code, for all enum values see OBExternalStatusReason1Code in OBInternalCodeSet [here](https://github.com/OpenBankingUK/ExternalInternal…
Links
object
Links relevant to the payload
5 properties 1 required
ActiveOrHistoricCurrencyCode_1
string
A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international st…
OBErrorResponse1
object
An array of detail error codes, and messages, and URLs to documentation to help remediation.
4 properties 1 required
ISODateTime
string
All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below:…
OBActiveCurrencyAndAmount_SimpleType
string
A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.
OBReadOffer1
object
3 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

hampden-and-co-offers-api-openapi.yml Raw ↑

Other APIs Hampden & Co publishes across the network.

Hampden & Co Open Data API
Hampden & Co Account Access Consents API
Hampden & Co Accounts API
Hampden & Co Balances API
Hampden & Co Beneficiaries API
Hampden & Co Direct Debits API
Hampden & Co Domestic Payment Consents API
Hampden & Co Domestic Payments API
Hampden & Co Domestic Scheduled Payment Consents API
Hampden & Co Domestic Scheduled Payments API
Hampden & Co Domestic Standing Order Consents API
Hampden & Co Domestic Standing Orders API
Where this information came from

This is an independent, third-party profile of Hampden & Co Offers 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.