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
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
first direct

first direct Domestic Standing Order Consents API

The Domestic Standing Order Consents API from first direct — 2 operation(s) for domestic standing order consents.

Documentation Provider Profile APIs.io OpenAPI GitHub

first direct Domestic Standing Order Consents API is one of 34 APIs that first direct publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Domestic Standing Order Consents. 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 65 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/pisp.

2 operations 2 paths 65 schemas 1 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
4.0.1
Base URL
https://api.hsbc.com/open-banking/v2.2
Authentication
OAuth 2.0, OAuth 2.0
Contact
Service Desk
License
open-licence
Terms of Service
View terms
Resource Areas
1

Authentication & Security 2

first direct Domestic Standing Order Consents 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 — 1 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.

Domestic Standing Order Consents 2
POST
/domestic-standing-order-consents
Create a Domestic Standing Order Consent
CreateDomesticStandingOrderConsents 8 params body → 201400401403404405406409
GET
/domestic-standing-order-consents/{ConsentId}
Get a Domestic Standing Order Consent
GetDomesticStandingOrderConsentsConsentId 7 params → 200400401403404405406429

Schemas 65

The contract defines 65 schemas that model the data the API accepts and returns. The most detailed are OBPostalAddress7 (18 properties), OBRisk1 (9 properties), OBMandateRelatedInformation1 (8 properties), OBRemittanceInformationStructured (7 properties). Each schema is shown below with its type and property counts.

OBStructuredRegulatoryReporting3
object
Set of elements used to provide details on the regulatory reporting information.
5 properties
Identification_3
string
Identification of the organisation issuing the invoice, when it is different from the creditor or ultimate creditor
OBError1
object
4 properties 1 required
OBMandateRelatedInformation1
object
8 properties 1 required
Identification_0
string
Identification assigned by an institution to identify an account. This identification is known by the account owner.
OBErrorResponse1
object
An array of detail error codes, and messages, and URLs to documentation to help remediation.
4 properties 1 required
Floor
string
Number that identifies the level within a building
PointInTime
string
Exact2NumericText - Further information on the exact point in time the event should take place. Specifies a frequency in terms of an exact point in time or mom…
Frequency_1
string
Individual Definitions: NotKnown - Not Known EvryDay - Every day EvryWorkgDay - Every working day IntrvlDay - An interval specified in number of calendar days…
PostCode
string
Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.
BuildingNumber
string
Number that identifies the position of a building on a street.
ExternalDocumentType1Code
string
Specifies the document type as published in an external document type code list. For more information see ExternalDocumentType1Code in ISOExternalCodeSet [here…
OBRegulatoryAuthority2
object
Entity requiring the regulatory reporting information.
2 properties
Room
string
Information that locates and identifies a room to form part of an address
OBInternalConsentStatus2Code
string
Specifies the status of consent resource in code form. For a full list of values refer to OBInternalConsentStatus2Code in OBInternalCodeSet [here](https://gith…
Links
object
Links relevant to the payload
5 properties 1 required
OBRemittanceInformation2
object
Information supplied to enable the matching of an entry with the items that the transfer is intended to settle, such as commercial invoices in an accounts' rec…
2 properties
OBExternalMandateClassification1Code
string
TownName
string
Name of a built-up area, with defined boundaries, and a local government.
OBInternalChargeBearerType1Code
string
Specifies which party/parties will bear the charges associated with the processing of the payment transaction. For a full list of values refer to OBInternalCha…
OBUltimateDebtor1
object
Ultimate party that owes an amount of money to the (ultimate) creditor.
5 properties
UnitNumber
string
Number that identifies the unit of a specific address .
OBProxy1
object
Specifies an alternate assumed name for the identification of the account.
3 properties 2 required
BuildingName
string
Name of a referenced building.
NumberOfPayments
string
Number of the payments that will be made in completing this frequency sequence including any executed since the sequence start date.
OBSupplementaryData1
object
Additional information that can not be captured in the structured fields and/or any other specific block.
OBInternalAccountIdentification4Code
string
Name of the identification scheme, in a coded form as published in an external list. For a full list of values refer to OBInternalAccountIdentification4Code in…
OBPostalAddress7
object
Information that locates and identifies a specific address, as defined by postal services.
18 properties
CareOf
string
The 'care of' address is used whenever sending mail to a person or organisation who does not actually live or work at the address. They will receive the mail f…
OBUltimateCreditor1
object
Ultimate party to which an amount of money is due.
5 properties
OBFrequency6
object
Regularity with which credit transfer instructions are to be created and processed
3 properties 1 required
OBInternalPaymentChargeType1Code
string
Charge type, in a coded form. For a full list of values refer to OBInternalPaymentChargeType1Code in OBInternalCodeSet [here](https://github.com/OpenBankingUK/…
CountrySubDivision
string
Identifies a subdivision of a country such as state, region, county.
LEI
string
Legal entity identification as an alternate identification for a party. Legal Entity Identifier is a code allocated to a party as described in ISO 17442 "Finan…
ExternalCategoryPurpose1Code
string
Enumeration of codes that outlines the type of purpose behind a transaction, payment or risk. For all enum values see ExternalCategoryPurpose1Code [here](https…
Department
string
Identification of a division of a large organisation or building.
SubDepartment
string
Identification of a sub-division of a large organisation or building.
SecondaryIdentification
string
This is secondary identification of the account, as assigned by the account servicing institution. This can be used by building societies to additionally ident…
OBRemittanceInformationStructured
object
7 properties
OBCashAccountDebtor4
object
^ Only included in the response if Data. ReadRefundAccount is set to Yes in the consent.
5 properties
OBFrequency6Code
string
For a full list of values see OBFrequency6Code in OBInternalCodeSet [here](https://github.com/OpenBankingUK/ExternalInternalCodeSets)
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:…
ExternalCreditorReferenceType1Code
string
Specifies the type of creditor reference as published in an external creditor reference type code set. For more information see ExternalCreditorReferenceType1C…
OBInternalExtendedAccountType1Code
string
Specifies the extended type of account.
Meta
object
Meta Data relevant to the payload
3 properties
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.
OBActiveOrHistoricCurrencyAndAmount
object
Amount of money associated with the charge type.
2 properties 2 required
OBWriteDomesticStandingOrderConsent5
object
2 properties 2 required
OBStatusReason
object
3 properties
OBExternalStatusReason1Code
string
Low level textual error code, for all enum values see OBExternalStatusReason1Code in OBInternalCodeSet [here](https://github.com/OpenBankingUK/ExternalInternal…
PostBox
string
Information that locates and identifies a box in a post office assigned to a person or organization, where letters for them are kept until called for.
OBReferredDocumentInformation
object
5 properties
ExternalProxyAccountType1Code
string
Specifies the external proxy account type code, as published in the proxy account type external code set. For a full list of values see ExternalProxyAccountTyp…
OBRisk1
object
The Risk section is sent by the initiating party to the ASPSP. It is used to specify additional details for risk scoring for Payments.
9 properties
OBAddressType2Code
string
Identifies the nature of the postal address. For a full set of codes see OBAddressType2Code [here](https://github.com/OpenBankingUK/ExternalInternalCodeSets).
DistrictName
string
Number that of the regional area, known as a district, which forms part of an address
Identification_1
string
Unique identification, as assigned by the creditor, to unambiguously identify the mandate.
CountryCode
string
Nation with its own government.
Identification_4
string
Identification of the party to whom an invoice is issued, when it is different from the debtor or ultimate debtor.
ActiveOrHistoricCurrencyCode
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…
StreetName
string
Name of a street or thoroughfare.
OBWriteDomesticStandingOrderConsentResponse6
object
4 properties 2 required
OBRegulatoryReporting1
object
Information needed due to regulatory and statutory requirements
3 properties
ExternalPurpose1Code
string
This is a partial list, For a full list see ExternalPurpose1Code [here](https://github.com/OpenBankingUK/ExternalInternalCodeSets)
OBSCASupportData1
object
Supporting Data provided by TPP, when requesting SCA Exemption.
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

first-direct-domestic-standing-order-consents-api-openapi.yml Raw ↑

Other APIs first direct publishes across the network.

first direct Account Access Consents API
AE Profile APIs.io
first direct Accounts API
AE Profile APIs.io
first direct ATM API
AE Profile APIs.io
first direct Balances API
AE Profile APIs.io
first direct BCA API
AE Profile APIs.io
first direct Beneficiaries API
AE Profile APIs.io
first direct Branch API
AE Profile APIs.io
first direct CCC API
AE Profile APIs.io
first direct Direct Debits API
AE Profile APIs.io
first direct Domestic Payment Consents API
AE Profile APIs.io
first direct Domestic Payments API
AE Profile APIs.io
first direct Domestic Scheduled Payment Consents API
AE Profile APIs.io
#Domestic Standing Order Consents
← Back to F APIs
API Details
ID
first-direct:first-direct-domestic-standing-order-consents-api
Base URL
https://api.hsbc.com/open-banking/v2.2
Docs
https://develop.hsbc.com/knowledge-article/get-started-open-banking-apis
Provider
first direct
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=first-direct-domestic-standing-order-consents-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/first-direct-domestic-standing-order-consents-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of first direct Domestic Standing Order Consents 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.