OPopenbankinguk
Offers

Get Offers

Changed on

Enables an AISP to retrieve any offer information for account(s) that the PSU has consented to.

get/offers

Request

  • Base URL
    /open-banking/v4.0/aisp (relative, and the document was published on a file host, not at the API’s origin)
  • URL
    /open-banking/v4.0/aisp/offers
  • Auth
    OAuth 2
    Authorization code: https://authserver.example/authorization
    Token URL: https://authserver.example/token scopes: accounts

Headers

x-fapi-auth-datestring

The time when the PSU last logged in with the TPP. All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: Sun, 10 Sep 2017 19:43:31 UTC

x-fapi-customer-ip-addressstring

The PSU's IP address if the PSU is currently logged in with the TPP.

x-fapi-interaction-idstring

An RFC4122 UID used as a correlation id.

Authorizationstring required

An Authorisation Token as per https://tools.ietf.org/html/rfc6750

x-customer-user-agentstring

Indicates the user-agent that the PSU is using.

x-client-idstring

Only used if an ASPSP requires the client ID in order to return rate limit headers.

TPPs must refer to ASPSP developer portals for further information on any rate limit policies, if the headers are supported and any additional requirements.

This header must not be used for client authentication

Response

Offers Read

Example response

{
  "Data": {
    "Offer": [
      {
        "AccountId": "22289",
        "OfferId": "Offer1",
        "OfferType": "LimitIncrease",
        "Description": "Credit limit increase for the account up to £10000.00",
        "StartDateTime": "2024-05-29T00:00:00Z",
        "EndDateTime": "2024-06-29T00:00:00Z",
        "Rate": "100.00",
        "Value": 10,
        "Term": "Starting first of the month and ending at the end of year",
        "URL": "http://modelbank.com/offer/offer1",
        "Amount": {
          "Amount": "1209.06",
          "Currency": "GBP"
        },
        "Fee": {
          "Amount": "1209.06",
          "Currency": "GBP"
        }
      }
    ]
  }
}

Changes