Aggregated Event Polling API (LYDS)

Aggregated Event Polling API (LYDS) v3.1.10

0
No votes yet

Aggregated Event Polling API

production
https://secure-api.lloydsbank.com/prod01/lbg
production
https://secure-api-eidas.halifax.co.uk/prod01/lbg
production
https://secure-api-eidas.bankofscotland.co.uk/prod01/lbg
production
https://secure-api.mbna.co.uk/prod01/lbg
production
https://secure-api.halifax.co.uk/prod01/lbg
production
https://secure-api.bankofscotland.co.uk/prod01/lbg
production
https://secure-api-eidas.mbna.co.uk/prod01/lbg
production
https://secure-api-eidas.lloydsbank.com/prod01/lbg

Paths

/events

post /events
Events

Create Events

To use this operation you must use one of the following sets of security requirements.
TPPOAuth2Security
TPPOAuth2Security
(oauth2 application)

TPP client credential authorisation flow with the ASPSP

Token URL
https://authorise-api.lloydsbank.co.uk/prod01/lbg/lyds/oidc-api/v1.1/token
Scopes
eventpolling
Ability to poll for, acknowledge and receive Security Event Tokens
payments
Generic payments scope
accounts
Generic Account scope
fundsconfirmations
Scope for COF
TPPOAuth2Security
TPPOAuth2Security
(oauth2 application)

TPP client credential authorisation flow with the ASPSP

Token URL
https://authorise-api.lloydsbank.co.uk/prod01/lbg/lyds/oidc-api/v1.1/token
Scopes
eventpolling
Ability to poll for, acknowledge and receive Security Event Tokens
payments
Generic payments scope
accounts
Generic Account scope
fundsconfirmations
Scope for COF
TPPOAuth2Security
TPPOAuth2Security
(oauth2 application)

TPP client credential authorisation flow with the ASPSP

Token URL
https://authorise-api.lloydsbank.co.uk/prod01/lbg/lyds/oidc-api/v1.1/token
Scopes
eventpolling
Ability to poll for, acknowledge and receive Security Event Tokens
payments
Generic payments scope
accounts
Generic Account scope
fundsconfirmations
Scope for COF
TPPOAuth2Security
TPPOAuth2Security
(oauth2 application)

TPP client credential authorisation flow with the ASPSP

Token URL
https://authorise-api.lloydsbank.co.uk/prod01/lbg/lyds/oidc-api/v1.1/token
Scopes
eventpolling
Ability to poll for, acknowledge and receive Security Event Tokens
payments
Generic payments scope
accounts
Generic Account scope
fundsconfirmations
Scope for COF
OBEventPolling1Param
Required in body
object

Default

{
    "schema": {
        "type": "object",
        "properties": {
            "maxEvents": {
                "description": "Maximum number of events to be returned. A value of zero indicates the ASPSP should not return events even if available",
                "type": "integer"
            },
            "returnImmediately": {
                "description": "Indicates whether an ASPSP should return a response immediately or provide a long poll",
                "type": "boolean"
            },
            "ack": {
                "type": "array",
                "items": {
                    "description": "An array of jti values indicating event notifications positively acknowledged by the TPP",
                    "type": "string",
                    "minLength": 1,
                    "maxLength": 50
                }
            },
            "setErrs": {
                "type": "object",
                "description": "An object that encapsulates all negative acknowledgements transmitted by the TPP",
                "properties": [],
                "additionalProperties": {
                    "type": "object",
                    "required": [
                        "err",
                        "description"
                    ],
                    "properties": {
                        "err": {
                            "description": "A value from the IANA \"Security Event Token Delivery Error Codes\" registry that identifies the error as defined here\nhttps:\/\/tools.ietf.org\/id\/draft-ietf-secevent-http-push-03.html#error_codes",
                            "type": "string",
                            "minLength": 1,
                            "maxLength": 40
                        },
                        "description": {
                            "description": "A human-readable string that provides additional diagnostic information",
                            "type": "string",
                            "minLength": 1,
                            "maxLength": 256
                        }
                    }
                }
            }
        }
    }
}
x-fapi-auth-date
Optional in header
string

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

{
    "pattern": "^(Mon|Tue|Wed|Thu|Fri|Sat|Sun), \\d{2} (Jan|Feb|Mar|Apr|May|Jun|Jul|Aug|Sep|Oct|Nov|Dec) \\d{4} \\d{2}:\\d{2}:\\d{2} (GMT|UTC)$"
}
x-fapi-customer-ip-address
Optional in header
string

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

x-fapi-interaction-id
Optional in header
string

An RFC4122 UID used as a correlation id.

Authorization
Required in header
string

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

Content-Type
Optional in header
string
application/json; charset=utf-8
application/jose+jwe
Accept
Optional in header
string
application/json; charset=utf-8
application/jose+jwe
201

Attribute description not found

OBEventPollingResponse1
400

Attribute description not found

OBErrorResponse1
401

Attribute description not found

403

Attribute description not found

OBErrorResponse1
404

Attribute description not found

405

Attribute description not found

406

Attribute description not found

415

Attribute description not found

429

Attribute description not found

500

Attribute description not found

OBErrorResponse1
Example Request
curl --request POST \
  --url https://secure-api.lloydsbank.com/prod01/lbg/lyds/open-banking/v3.1/events \
  --header 'Authorization: REPLACE_THIS_VALUE' \
  --header 'accept: application/json; charset=utf-8' \
  --header 'content-type: application/json; charset=utf-8' \
  --header 'x-fapi-auth-date: REPLACE_THIS_VALUE' \
  --header 'x-fapi-customer-ip-address: REPLACE_THIS_VALUE' \
  --header 'x-fapi-interaction-id: REPLACE_THIS_VALUE' \
  --data '{"maxEvents":47968525,"returnImmediately":false,"ack":["hajegvoz","jusuvirirmuweploejwuujezuvutrawekomingowwirajd","hipduitidilejcehwijwejhiubonesbukulukhocvizuavap"],"setErrs":{}}'
require 'uri'
require 'net/http'
require 'openssl'

url = URI("https://secure-api.lloydsbank.com/prod01/lbg/lyds/open-banking/v3.1/events")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
http.verify_mode = OpenSSL::SSL::VERIFY_NONE

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'REPLACE_THIS_VALUE'
request["x-fapi-auth-date"] = 'REPLACE_THIS_VALUE'
request["x-fapi-customer-ip-address"] = 'REPLACE_THIS_VALUE'
request["x-fapi-interaction-id"] = 'REPLACE_THIS_VALUE'
request["content-type"] = 'application/json; charset=utf-8'
request["accept"] = 'application/json; charset=utf-8'
request.body = "{\"maxEvents\":47968525,\"returnImmediately\":false,\"ack\":[\"hajegvoz\",\"jusuvirirmuweploejwuujezuvutrawekomingowwirajd\",\"hipduitidilejcehwijwejhiubonesbukulukhocvizuavap\"],\"setErrs\":{}}"

response = http.request(request)
puts response.read_body
import http.client

conn = http.client.HTTPSConnection("secure-api.lloydsbank.com")

payload = "{\"maxEvents\":47968525,\"returnImmediately\":false,\"ack\":[\"hajegvoz\",\"jusuvirirmuweploejwuujezuvutrawekomingowwirajd\",\"hipduitidilejcehwijwejhiubonesbukulukhocvizuavap\"],\"setErrs\":{}}"

headers = {
    'Authorization': "REPLACE_THIS_VALUE",
    'x-fapi-auth-date': "REPLACE_THIS_VALUE",
    'x-fapi-customer-ip-address': "REPLACE_THIS_VALUE",
    'x-fapi-interaction-id': "REPLACE_THIS_VALUE",
    'content-type': "application/json; charset=utf-8",
    'accept': "application/json; charset=utf-8"
    }

conn.request("POST", "/prod01/lbg/lyds/open-banking/v3.1/events", payload, headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://secure-api.lloydsbank.com/prod01/lbg/lyds/open-banking/v3.1/events",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => "{\"maxEvents\":47968525,\"returnImmediately\":false,\"ack\":[\"hajegvoz\",\"jusuvirirmuweploejwuujezuvutrawekomingowwirajd\",\"hipduitidilejcehwijwejhiubonesbukulukhocvizuavap\"],\"setErrs\":{}}",
  CURLOPT_HTTPHEADER => [
    "Authorization: REPLACE_THIS_VALUE",
    "accept: application/json; charset=utf-8",
    "content-type: application/json; charset=utf-8",
    "x-fapi-auth-date: REPLACE_THIS_VALUE",
    "x-fapi-customer-ip-address: REPLACE_THIS_VALUE",
    "x-fapi-interaction-id: REPLACE_THIS_VALUE"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
OkHttpClient client = new OkHttpClient();

MediaType mediaType = MediaType.parse("application/json; charset=utf-8");
RequestBody body = RequestBody.create(mediaType, "{\"maxEvents\":47968525,\"returnImmediately\":false,\"ack\":[\"hajegvoz\",\"jusuvirirmuweploejwuujezuvutrawekomingowwirajd\",\"hipduitidilejcehwijwejhiubonesbukulukhocvizuavap\"],\"setErrs\":{}}");
Request request = new Request.Builder()
  .url("https://secure-api.lloydsbank.com/prod01/lbg/lyds/open-banking/v3.1/events")
  .post(body)
  .addHeader("Authorization", "REPLACE_THIS_VALUE")
  .addHeader("x-fapi-auth-date", "REPLACE_THIS_VALUE")
  .addHeader("x-fapi-customer-ip-address", "REPLACE_THIS_VALUE")
  .addHeader("x-fapi-interaction-id", "REPLACE_THIS_VALUE")
  .addHeader("content-type", "application/json; charset=utf-8")
  .addHeader("accept", "application/json; charset=utf-8")
  .build();

Response response = client.newCall(request).execute();
const request = require('request');

const options = {
  method: 'POST',
  url: 'https://secure-api.lloydsbank.com/prod01/lbg/lyds/open-banking/v3.1/events',
  headers: {
    Authorization: 'REPLACE_THIS_VALUE',
    'x-fapi-auth-date': 'REPLACE_THIS_VALUE',
    'x-fapi-customer-ip-address': 'REPLACE_THIS_VALUE',
    'x-fapi-interaction-id': 'REPLACE_THIS_VALUE',
    'content-type': 'application/json; charset=utf-8',
    accept: 'application/json; charset=utf-8'
  },
  body: '{"maxEvents":47968525,"returnImmediately":false,"ack":["hajegvoz","jusuvirirmuweploejwuujezuvutrawekomingowwirajd","hipduitidilejcehwijwejhiubonesbukulukhocvizuavap"],"setErrs":{}}'
};

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "https://secure-api.lloydsbank.com/prod01/lbg/lyds/open-banking/v3.1/events"

	payload := strings.NewReader("{\"maxEvents\":47968525,\"returnImmediately\":false,\"ack\":[\"hajegvoz\",\"jusuvirirmuweploejwuujezuvutrawekomingowwirajd\",\"hipduitidilejcehwijwejhiubonesbukulukhocvizuavap\"],\"setErrs\":{}}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "REPLACE_THIS_VALUE")
	req.Header.Add("x-fapi-auth-date", "REPLACE_THIS_VALUE")
	req.Header.Add("x-fapi-customer-ip-address", "REPLACE_THIS_VALUE")
	req.Header.Add("x-fapi-interaction-id", "REPLACE_THIS_VALUE")
	req.Header.Add("content-type", "application/json; charset=utf-8")
	req.Header.Add("accept", "application/json; charset=utf-8")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
import Foundation

let headers = [
  "Authorization": "REPLACE_THIS_VALUE",
  "x-fapi-auth-date": "REPLACE_THIS_VALUE",
  "x-fapi-customer-ip-address": "REPLACE_THIS_VALUE",
  "x-fapi-interaction-id": "REPLACE_THIS_VALUE",
  "content-type": "application/json; charset=utf-8",
  "accept": "application/json; charset=utf-8"
]

let postData = NSData(data: "{"maxEvents":47968525,"returnImmediately":false,"ack":["hajegvoz","jusuvirirmuweploejwuujezuvutrawekomingowwirajd","hipduitidilejcehwijwejhiubonesbukulukhocvizuavap"],"setErrs":{}}".data(using: String.Encoding.utf8)!)

let request = NSMutableURLRequest(url: NSURL(string: "https://secure-api.lloydsbank.com/prod01/lbg/lyds/open-banking/v3.1/events")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
Example Response
POST https://secure-api.lloydsbank.com/prod01/lbg/lyds/open-banking/v3.1/events
{
  "moreAvailable": true,
  "sets": {}
}
Try this operation
https://secure-api.lloydsbank.com/prod01/lbg/lyds/open-banking/v3.1/events
Login to test this API.
eventpolling
payments
accounts
fundsconfirmations
content-type
accept
x-fapi-auth-date
x-fapi-customer-ip-address
x-fapi-interaction-id
Authorization

Definitions 

{
    "type": "object",
    "properties": {
        "ErrorCode": {
            "description": "Low level textual error code, e.g., UK.OBIE.Field.Missing",
            "type": "string",
            "x-namespaced-enum": [
                "UK.OBIE.Field.Expected",
                "UK.OBIE.Field.Invalid",
                "UK.OBIE.Field.InvalidDate",
                "UK.OBIE.Field.Missing",
                "UK.OBIE.Field.Unexpected",
                "UK.OBIE.Header.Invalid",
                "UK.OBIE.Header.Missing",
                "UK.OBIE.Reauthenticate",
                "UK.OBIE.Resource.ConsentMismatch",
                "UK.OBIE.Resource.InvalidConsentStatus",
                "UK.OBIE.Resource.InvalidFormat",
                "UK.OBIE.Resource.NotFound",
                "UK.OBIE.Rules.AfterCutOffDateTime",
                "UK.OBIE.Rules.DuplicateReference",
                "UK.OBIE.Signature.Invalid",
                "UK.OBIE.Signature.InvalidClaim",
                "UK.OBIE.Signature.Malformed",
                "UK.OBIE.Signature.Missing",
                "UK.OBIE.Signature.MissingClaim",
                "UK.OBIE.Signature.Unexpected",
                "UK.OBIE.UnexpectedError",
                "UK.OBIE.Unsupported.AccountIdentifier",
                "UK.OBIE.Unsupported.AccountSecondaryIdentifier",
                "UK.OBIE.Unsupported.Currency",
                "UK.OBIE.Unsupported.Frequency",
                "UK.OBIE.Unsupported.LocalInstrument",
                "UK.OBIE.Unsupported.Scheme"
            ]
        },
        "Message": {
            "description": "A description of the error that occurred. e.g., 'A mandatory field isn't supplied' or 'RequestedExecutionDateTime must be in future'\nOBIE doesn't standardise this field",
            "type": "string",
            "minLength": 1,
            "maxLength": 500
        },
        "Path": {
            "description": "Recommended but optional reference to the JSON Path of the field with error, e.g., Data.Initiation.InstructedAmount.Currency",
            "type": "string",
            "minLength": 1,
            "maxLength": 500
        },
        "Url": {
            "description": "URL to help remediate the problem, or provide more information, or to API Reference, or help etc",
            "type": "string"
        }
    },
    "required": [
        "ErrorCode",
        "Message"
    ],
    "additionalProperties": false,
    "minProperties": 1
}

An array of detail error codes, and messages, and URLs to documentation to help remediation.

{
    "type": "object",
    "properties": {
        "Code": {
            "description": "High level textual error code, to help categorize the errors.",
            "type": "string",
            "minLength": 1,
            "maxLength": 40
        },
        "Id": {
            "description": "A unique reference for the error instance, for audit purposes, in case of unknown/unclassified errors.",
            "type": "string",
            "minLength": 1,
            "maxLength": 40
        },
        "Message": {
            "description": "Brief Error message, e.g., 'There is something wrong with the request parameters provided'",
            "type": "string",
            "minLength": 1,
            "maxLength": 500
        },
        "Errors": {
            "items": {
                "$ref": "#/definitions/OBError1"
            },
            "type": "array",
            "minItems": 1
        }
    },
    "required": [
        "Code",
        "Message",
        "Errors"
    ],
    "additionalProperties": false
}
              
{
    "type": "object",
    "properties": {
        "maxEvents": {
            "description": "Maximum number of events to be returned. A value of zero indicates the ASPSP should not return events even if available",
            "type": "integer"
        },
        "returnImmediately": {
            "description": "Indicates whether an ASPSP should return a response immediately or provide a long poll",
            "type": "boolean"
        },
        "ack": {
            "type": "array",
            "items": {
                "description": "An array of jti values indicating event notifications positively acknowledged by the TPP",
                "type": "string",
                "minLength": 1,
                "maxLength": 50
            }
        },
        "setErrs": {
            "type": "object",
            "description": "An object that encapsulates all negative acknowledgements transmitted by the TPP",
            "properties": [],
            "additionalProperties": {
                "type": "object",
                "required": [
                    "err",
                    "description"
                ],
                "properties": {
                    "err": {
                        "description": "A value from the IANA \"Security Event Token Delivery Error Codes\" registry that identifies the error as defined here\nhttps://tools.ietf.org/id/draft-ietf-secevent-http-push-03.html#error_codes",
                        "type": "string",
                        "minLength": 1,
                        "maxLength": 40
                    },
                    "description": {
                        "description": "A human-readable string that provides additional diagnostic information",
                        "type": "string",
                        "minLength": 1,
                        "maxLength": 256
                    }
                }
            }
        }
    }
}
              
{
    "type": "object",
    "required": [
        "moreAvailable",
        "sets"
    ],
    "properties": {
        "moreAvailable": {
            "description": "A JSON boolean value that indicates if more unacknowledged event notifications are available to be returned.",
            "type": "boolean"
        },
        "sets": {
            "type": "object",
            "description": "A JSON object that contains zero or more nested JSON attributes. If there are no outstanding event notifications to be transmitted, the JSON object SHALL be empty.",
            "properties": [],
            "additionalProperties": {
                "description": "An object named with the jti of the event notification to be delivered. The value is the event notification, expressed as a string.\nThe payload of the event should be defined in the OBEventNotification2 format.",
                "type": "string"
            }
        }
    },
    "additionalProperties": false
}