Service Desk
https://www.openbanking.org.uk/terms
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
/domestic-standing-order-consents
/domestic-standing-order-consents/{ConsentId}
/domestic-standing-orders
post /domestic-standing-orders
Domestic Standing Orders
Create a domestic standing order
Create a domestic standing order
PSUOAuth2Security
PSUOAuth2Security
(oauth2 accessCode)
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. The below example Authorization URL shows the personal channel. For business and commercial specific authorization URLs please refer to the well known endpoint or the Technical Implementation Guide.
Authorization URL
https://authorise-api.bankofscotland.co.uk/prod01/lbg/bos/personal/oidc-api/v1.1/authorize
Token URL
https://secure-api.bankofscotland.co.uk/prod01/lbg/bos/oidc-api/v1.1/token
Scopes
payments
Generic payment scope
x-fapi-financial-id
Required in header
string
The unique id of the ASPSP to which the request is issued. The unique id will be issued by OB.
x-fapi-customer-last-logged-time
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 IP address of the customer
x-fapi-interaction-id
Optional in header
string
An RFC4122 UID used as a correlation ID.
{
"pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"
}x-idempotency-key
Required in header
string
Every request will be processed only once per x-idempotency-key.
x-jws-signature
Required in header
string
A detached JWS signature of the body of the payload.
body
Required in body
object
Domestic standing order request body
{
"schema": {
"type": "object",
"required": [
"Data",
"Risk"
],
"properties": {
"Data": {
"$ref": "#\/definitions\/DomesticStandingOrderRequestData"
},
"Risk": {
"$ref": "#\/definitions\/Risk"
}
}
}
}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
Accept
Optional in header
string
application/json;charset=UTF-8
201
Created
400
Bad request
401
Unauthorized
403
Forbidden
404
Not found
500
Internal server error
Example Request
Example Response
POST https://secure-api.lloydsbank.com/prod01/lbg/bos/open-banking/v3.1/pisp/domestic-standing-orders
Try this operation
/domestic-standing-orders/{DomesticStandingOrderId}
get /domestic-standing-orders/{DomesticStandingOrderId}
Domestic Standing Orders
Get a domestic standing order
Get a domestic standing order
TPPOAuth2Security
TPPOAuth2Security
(oauth2 application)
TPP client credential authorisation flow with the ASPSP
Token URL
https://secure-api.bankofscotland.co.uk/prod01/lbg/bos/oidc-api/v1.1/token
Scopes
payments
Generic payment scopes
DomesticStandingOrderId
Required in path
string
A unique identifier used to identify the domestic standing order
x-fapi-financial-id
Required in header
string
The unique id of the ASPSP to which the request is issued. The unique id will be issued by OB.
x-fapi-customer-last-logged-time
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 IP address of the customer
x-fapi-interaction-id
Optional in header
string
An RFC4122 UID used as a correlation ID.
{
"pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"
}Authorization
Required in header
string
An Authorisation Token as per https://tools.ietf.org/html/rfc6750
Accept
Optional in header
string
application/json;charset=UTF-8
400
Bad request
401
Unauthorized
403
Forbidden
404
Not found
500
Internal server error
Example Request
Example Response
GET https://secure-api.lloydsbank.com/prod01/lbg/bos/open-banking/v3.1/pisp/domestic-standing-orders/{DomesticStandingOrderId}
Try this operation
Definitions
{
"type": "object",
"required": [
"Data",
"Risk"
],
"properties": {
"Data": {
"$ref": "#/definitions/DomesticStandingOrderConsentRequestData"
},
"Risk": {
"$ref": "#/definitions/Risk"
}
}
}
{
"type": "object",
"required": [
"Permission",
"Initiation"
],
"properties": {
"Permission": {
"$ref": "#/definitions/Permission"
},
"ReadRefundAccount": {
"description": "Specifies to share the refund account details with PISP",
"type": "string",
"enum": [
"No",
"Yes"
]
},
"Initiation": {
"$ref": "#/definitions/Initiation"
},
"Authorisation": {
"$ref": "#/definitions/Authorisation"
},
"SCASupportData": {
"type": "object",
"additionalProperties": false,
"description": "Supporting Data provided by TPP, when requesting SCA Exemption.",
"properties": {
"RequestedSCAExemptionType": {
"description": "This field allows a PISP to request specific SCA Exemption for a Payment Initiation",
"type": "string",
"enum": [
"BillPayment",
"ContactlessTravel",
"EcommerceGoods",
"EcommerceServices",
"Kiosk",
"Parking",
"PartyToParty"
]
},
"AppliedAuthenticationApproach": {
"description": "Specifies a character string with a maximum length of 40 characters.\nUsage: This field indicates whether the PSU was subject to SCA performed by the TPP",
"type": "string",
"maxLength": 40,
"enum": [
"CA",
"SCA"
]
},
"ReferencePaymentOrderId": {
"description": "Specifies a character string with a maximum length of 140 characters.\nUsage: If the payment is recurring then the transaction identifier of the previous payment occurrence so that the ASPSP can verify that the PISP, amount and the payee are the same as the previous occurrence.",
"type": "string",
"minLength": 1,
"maxLength": 40
}
}
}
}
}
{
"type": "object",
"required": [
"Data",
"Risk"
],
"properties": {
"Data": {
"$ref": "#/definitions/DomesticStandingOrderRequestData"
},
"Risk": {
"$ref": "#/definitions/Risk"
}
}
}
{
"type": "object",
"required": [
"ConsentId",
"Initiation"
],
"properties": {
"ConsentId": {
"type": "string",
"minLength": 1,
"maxLength": 128
},
"Initiation": {
"$ref": "#/definitions/Initiation"
}
}
}
{
"type": "string",
"enum": [
"Create"
]
}
{
"type": "object",
"required": [
"Frequency",
"FirstPaymentDateTime",
"FirstPaymentAmount",
"CreditorAccount"
],
"properties": {
"Frequency": {
"$ref": "#/definitions/Frequency"
},
"Reference": {
"$ref": "#/definitions/Reference"
},
"FirstPaymentDateTime": {
"$ref": "#/definitions/DateTime"
},
"RecurringPaymentDateTime": {
"$ref": "#/definitions/DateTime"
},
"FinalPaymentDateTime": {
"$ref": "#/definitions/DateTime"
},
"FirstPaymentAmount": {
"$ref": "#/definitions/Amount"
},
"RecurringPaymentAmount": {
"$ref": "#/definitions/Amount"
},
"FinalPaymentAmount": {
"$ref": "#/definitions/Amount"
},
"DebtorAccount": {
"$ref": "#/definitions/DebtorAccount"
},
"CreditorAccount": {
"$ref": "#/definitions/CreditorAccount"
}
}
}
{
"type": "string",
"minLength": 1,
"maxLength": 35,
"pattern": "^(IntrvlWkDay:(01|04):0[1-5])$|^(IntrvlMnthDay:(01|03|06|12|02):(-0[1-5]|0[1-9]|[12][0-9]|3[01]))$"
}
{
"type": "string",
"minLength": 1,
"maxLength": 35
}
{
"type": "string",
"format": "date-time"
}
{
"type": "object",
"required": [
"Amount",
"Currency"
],
"properties": {
"Amount": {
"type": "string",
"pattern": "^\\d{1,13}$|^\\d{1,13}\\.\\d{1,2}$"
},
"Currency": {
"type": "string",
"enum": [
"GBP"
]
}
}
}
{
"type": "object",
"required": [
"SchemeName",
"Identification"
],
"properties": {
"SchemeName": {
"type": "string",
"enum": [
"IBAN",
"SortCodeAccountNumber",
"BBAN"
]
},
"Identification": {
"type": "string",
"minLength": 1,
"maxLength": 256
},
"Name": {
"type": "string",
"minLength": 1,
"maxLength": 350
},
"SecondaryIdentification": {
"type": "string",
"minLength": 1,
"maxLength": 34
}
}
}
{
"type": "object",
"required": [
"SchemeName",
"Identification",
"Name"
],
"properties": {
"SchemeName": {
"type": "string",
"enum": [
"IBAN",
"SortCodeAccountNumber"
]
},
"Identification": {
"type": "string",
"minLength": 1,
"maxLength": 256
},
"Name": {
"type": "string",
"minLength": 1,
"maxLength": 350
},
"SecondaryIdentification": {
"type": "string",
"minLength": 1,
"maxLength": 34
}
}
}
{
"type": "object",
"required": [
"AuthorisationType"
],
"properties": {
"AuthorisationType": {
"type": "string",
"enum": [
"Any",
"Single"
]
},
"CompletionDateTime": {
"type": "string",
"format": "date-time"
}
}
}
{
"type": "object",
"required": [
"PaymentContextCode"
],
"properties": {
"PaymentContextCode": {
"type": "string",
"enum": [
"BillPayment",
"EcommerceGoods",
"EcommerceServices",
"Other",
"PartyToParty",
"BillingGoodsAndServicesInAdvance",
"BillingGoodsAndServicesInArrears",
"PispPayee",
"EcommerceMerchantInitiatedPayment",
"FaceToFacePointOfSale",
"TransferToSelf",
"TransferToThirdParty"
]
},
"MerchantCategoryCode": {
"type": "string",
"minLength": 3,
"maxLength": 4
},
"MerchantCustomerIdentification": {
"type": "string",
"minLength": 1,
"maxLength": 70
},
"ContractPresentInidicator": {
"type": "boolean",
"description": "Indicates if Payee has a contractual relationship with the PISP."
},
"BeneficiaryPrepopulatedIndicator": {
"type": "boolean",
"description": "Indicates if PISP has immutably prepopulated payment details in for the PSU."
},
"PaymentPurposeCode": {
"type": "string",
"minLength": 3,
"maxLength": 4,
"description": "Category code, related to the type of services or goods that corresponds to the underlying purpose of the payment that conforms to Recommended UK Purpose Code in ISO 20022 Payment Messaging List"
},
"BeneficiaryAccountType": {
"$ref": "#/definitions/OBExternalExtendedAccountType1Code"
},
"DeliveryAddress": {
"$ref": "#/definitions/DeliveryAddress"
}
}
}
Specifies the extended type of account.
{
"type": "string",
"enum": [
"Business",
"BusinessSavingsAccount",
"Charity",
"Collection",
"Corporate",
"Ewallet",
"Government",
"Investment",
"ISA",
"JointPersonal",
"Pension",
"Personal",
"PersonalSavingsAccount",
"Premier",
"Wealth"
]
}
{
"type": "object",
"required": [
"TownName",
"Country"
],
"properties": {
"AddressLine": {
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 70
},
"minItems": 0,
"maxItems": 2
},
"StreetName": {
"type": "string",
"minLength": 1,
"maxLength": 70
},
"BuildingNumber": {
"type": "string",
"minLength": 1,
"maxLength": 16
},
"PostCode": {
"type": "string",
"minLength": 1,
"maxLength": 16
},
"TownName": {
"type": "string",
"minLength": 1,
"maxLength": 35
},
"CountrySubDivision": {
"type": "string",
"minLength": 1,
"maxLength": 35
},
"Country": {
"type": "string",
"pattern": "[A-Z]{2}"
}
}
}
{
"type": "array",
"items": {
"$ref": "#/definitions/DomesticStandingOrderConsentResponse"
}
}
{
"type": "object",
"required": [
"Data",
"Risk"
],
"properties": {
"Data": {
"$ref": "#/definitions/DomesticStandingOrderConsentResponseData"
},
"Risk": {
"$ref": "#/definitions/Risk"
}
}
}
{
"type": "object",
"required": [
"ConsentId",
"CreationDateTime",
"Status",
"StatusUpdateDateTime",
"Permission",
"Initiation"
],
"properties": {
"ConsentId": {
"type": "string",
"minLength": 1,
"maxLength": 128
},
"CreationDateTime": {
"type": "string",
"format": "date-time"
},
"Status": {
"$ref": "#/definitions/Status"
},
"StatusUpdateDateTime": {
"type": "string",
"format": "date-time"
},
"Permission": {
"$ref": "#/definitions/Permission"
},
"CutOffDateTime": {
"type": "string",
"format": "date-time"
},
"Charges": {
"items": {
"$ref": "#/definitions/Charge"
},
"type": "array"
},
"ReadRefundAccount": {
"description": "Specifies to share the refund account details with PISP",
"type": "string",
"enum": [
"No",
"Yes"
]
},
"Initiation": {
"$ref": "#/definitions/Initiation"
},
"Authorisation": {
"$ref": "#/definitions/Authorisation"
},
"SCASupportData": {
"type": "object",
"additionalProperties": false,
"description": "Supporting Data provided by TPP, when requesting SCA Exemption.",
"properties": {
"RequestedSCAExemptionType": {
"description": "This field allows a PISP to request specific SCA Exemption for a Payment Initiation",
"type": "string",
"enum": [
"BillPayment",
"ContactlessTravel",
"EcommerceGoods",
"EcommerceServices",
"Kiosk",
"Parking",
"PartyToParty"
]
},
"AppliedAuthenticationApproach": {
"description": "Specifies a character string with a maximum length of 40 characters.\nUsage: This field indicates whether the PSU was subject to SCA performed by the TPP",
"type": "string",
"enum": [
"CA",
"SCA"
]
},
"ReferencePaymentOrderId": {
"description": "Specifies a character string with a maximum length of 140 characters.\nUsage: If the payment is recurring then the transaction identifier of the previous payment occurrence so that the ASPSP can verify that the PISP, amount and the payee are the same as the previous occurrence.",
"type": "string",
"minLength": 1,
"maxLength": 40
}
}
},
"Debtor": {
"$ref": "#/definitions/OBDebtorIdentification1"
}
}
}
Set of elements used to identify a person or an organisation.
{
"type": "object",
"additionalProperties": false,
"properties": {
"Name": {
"type": "string",
"description": "The account name is the name or names of the account owner(s) represented at an account level, as displayed by the ASPSP's online channels. Note, the account name is not the product name or the nickname of the account."
},
"SchemeName": {
"type": "string",
"enum": [
"IBAN",
"SortCodeAccountNumber",
"BBAN"
]
},
"Identification": {
"type": "string"
},
"SecondaryIdentification": {
"type": "string"
}
}
}
{
"type": "object",
"required": [
"Data"
],
"properties": {
"Data": {
"$ref": "#/definitions/DomesticStandingOrderResponseData"
}
}
}
{
"type": "object",
"required": [
"DomesticStandingOrderId",
"ConsentId",
"CreationDateTime",
"Status",
"StatusUpdateDateTime",
"Initiation"
],
"properties": {
"DomesticStandingOrderId": {
"type": "string",
"minLength": 1,
"maxLength": 40
},
"ConsentId": {
"type": "string",
"minLength": 1,
"maxLength": 128
},
"CreationDateTime": {
"type": "string",
"format": "date-time"
},
"Status": {
"$ref": "#/definitions/Status"
},
"StatusUpdateDateTime": {
"type": "string",
"format": "date-time"
},
"Charges": {
"items": {
"$ref": "#/definitions/Charge"
},
"type": "array"
},
"Refund": {
"type": "object",
"additionalProperties": false,
"required": [
"Account"
],
"description": "Unambiguous identification of the refund account to which a refund will be made as a result of the transaction.",
"properties": {
"Account": {
"type": "object",
"additionalProperties": false,
"required": [
"SchemeName",
"Identification",
"Name"
],
"description": "Provides the details to identify an account.",
"properties": {
"SchemeName": {
"type": "string",
"enum": [
"IBAN",
"SortCodeAccountNumber"
]
},
"Identification": {
"type": "string",
"minLength": 1,
"maxLength": 256
},
"Name": {
"description": "Name of the account, as assigned by the account servicing institution.\nUsage: The account name is the name or names of the account owner(s) represented at an account level. The account name is not the product name or the nickname of the account.\nOB: ASPSPs may carry out name validation for Confirmation of Payee, but it is not mandatory.",
"type": "string",
"minLength": 1,
"maxLength": 350
},
"SecondaryIdentification": {
"type": "string",
"minLength": 1,
"maxLength": 34
}
}
}
}
},
"Initiation": {
"$ref": "#/definitions/Initiation"
},
"MultiAuthorisation": {
"$ref": "#/definitions/MultiAuthorisation"
},
"Debtor": {
"type": "object",
"additionalProperties": false,
"description": "Set of elements used to identify a person or an organisation.",
"properties": {
"Name": {
"type": "string",
"description": "The account name is the name or names of the account owner(s) represented at an account level, as displayed by the ASPSP's online channels. Note, the account name is not the product name or the nickname of the account.",
"minLength": 0,
"maxLength": 350
}
}
}
}
}
{
"type": "string",
"enum": [
"Authorised",
"AwaitingAuthorisation",
"Consumed",
"Rejected"
]
}
{
"required": [
"ChargeBearer",
"Type",
"Amount"
],
"properties": {
"ChargeBearer": {
"type": "string",
"enum": [
"BorneByCreditor",
"BorneByDebtor",
"FollowingServiceLevel",
"Shared"
]
},
"Type": {
"type": "string",
"minLength": 1,
"maxLength": 40
},
"Amount": {
"$ref": "#/definitions/Amount"
}
}
}
{
"type": "object",
"required": [
"Status"
],
"properties": {
"Status": {
"type": "string",
"enum": [
"Authorised",
"AwaitingFurtherAuthorisation",
"Rejected"
]
},
"NumberRequired": {
"type": "integer",
"format": "int32"
},
"NumberReceived": {
"type": "integer",
"format": "int32"
},
"LastUpdateDateTime": {
"type": "string",
"format": "date-time"
},
"ExpirationDateTime": {
"type": "string",
"format": "date-time"
}
}
}
{
"type": "object",
"required": [
"Code",
"Message",
"Errors"
],
"properties": {
"Code": {
"type": "string",
"minLength": 1,
"maxLength": 40
},
"Id": {
"type": "string",
"minLength": 1,
"maxLength": 40
},
"Message": {
"type": "string",
"minLength": 1,
"maxLength": 500
},
"Errors": {
"items": {
"$ref": "#/definitions/Error"
},
"type": "array",
"minItems": 1
}
}
}
{
"type": "object",
"required": [
"ErrorCode",
"Message"
],
"properties": {
"ErrorCode": {
"type": "string",
"minLength": 1,
"maxLength": 128
},
"Message": {
"type": "string",
"minLength": 1,
"maxLength": 500
},
"Path": {
"type": "string",
"minLength": 1,
"maxLength": 500
},
"Url": {
"type": "string"
}
}
}