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

C. Hoare & Co. Domestic Scheduled Payments API

The Domestic Scheduled Payments API from C. Hoare & Co. — 4 operation(s) for domestic scheduled payments.

C. Hoare & Co. Domestic Scheduled Payments API is one of 20 APIs that C. Hoare & Co. publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

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

This API exposes 4 operations across 4 paths, and defines 35 schemas. It is described by OpenAPI 3.2.0, at version v3.1.0.

Requests are made against a single base URL, https://api.hoaresbank.co.uk/open-banking/v3.1/pisp.

4 operations 4 paths 35 schemas 2 GET2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
v3.1.0
Base URL
https://api.hoaresbank.co.uk/open-banking/v3.1/aisp
Authentication
OAuth 2.0, OAuth 2.0
Terms of Service
Resource Areas
1

Authentication & Security 2

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

  • 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
  • TPPOAuth2Security — TPP client credential authorisation flow with the ASPSP

Paths & Operations 4

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

Domestic Scheduled Payments 4
POST
/domestic-scheduled-payment-consents
Create Domestic Scheduled Payment Consents
CreateDomesticScheduledPaymentConsents 8 params body → 201400401403404405406415
GET
/domestic-scheduled-payment-consents/{ConsentId}
Get Domestic Scheduled Payment Consents
GetDomesticScheduledPaymentConsentsConsentId 7 params → 200400401403404405406429
POST
/domestic-scheduled-payments
Create Domestic Scheduled Payments
CreateDomesticScheduledPayments 8 params body → 201400401403404405406415
GET
/domestic-scheduled-payments/{DomesticScheduledPaymentId}
Get Domestic Scheduled Payments
GetDomesticScheduledPaymentsDomesticScheduledPaymentId 7 params → 200400401403404405406429

Schemas 35

The contract defines 35 schemas that model the data the API accepts and returns. The most detailed are OBWriteDataDomesticScheduledConsentResponse2 (11 properties), OBDomesticScheduled2 (10 properties), OBWriteDataDomesticScheduledResponse2 (10 properties), OBPostalAddress6 (10 properties). Each schema is shown below with its type and property counts.

OBCharge2
object
Set of elements used to provide details of a charge for the payment initiation.
3 properties 3 required
Links
object
Links relevant to the payload
5 properties 1 required
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.
4 properties
OBSupplementaryData1
object
Additional information that can not be captured in the structured fields and/or any other specific block.
OBExternalPaymentChargeType1Code
string
Charge type, in a coded form.
OBRemittanceInformation1
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
OBWriteDataDomesticScheduledConsent2
object
3 properties 2 required
OBMultiAuthorisation1
object
The multiple authorisation flow response from the ASPSP.
5 properties 1 required
OBWriteDataDomesticScheduled2
object
2 properties 2 required
Meta
object
Meta Data relevant to the payload
3 properties
OBError1
object
4 properties 2 required
OBExternalConsentStatus1Code
string
Specifies the status of resource in code form.
OBWriteDataDomesticScheduledConsentResponse2
object
11 properties 6 required
OBCashAccountDebtor4
object
Provides the details to identify the debtor account.
4 properties 2 required
OBErrorResponse1
object
An array of detail error codes, and messages, and URLs to documentation to help remediation.
4 properties 3 required
OBAddressTypeCode
string
Identifies the nature of the postal address.
OBCashAccountCreditor3
object
Provides the details to identify the beneficiary account.
4 properties 3 required
OBExternalAuthorisation1Code
string
Type of authorisation flow requested.
OBWriteDomesticScheduledConsentResponse2
object
4 properties 4 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:…
OBExternalPaymentContext1Code
string
Specifies the payment context
OBExternalPermissions2Code
string
Specifies the Open Banking service request types.
OBChargeBearerType1Code
string
Specifies which party/parties will bear the charges associated with the processing of the payment transaction.
OBWriteDataDomesticScheduledResponse2
object
10 properties 6 required
OBExternalStatus2Code
string
Specifies the status of the authorisation flow in code form.
OBDomesticScheduled2
object
The Initiation payload is sent by the initiating party to the ASPSP. It is used to request movement of funds from the debtor account to a creditor for a single…
10 properties 4 required
OBWriteDomesticScheduled2
object
2 properties 2 required
OBExternalAccountIdentification4Code
string
Name of the identification scheme, in a coded form as published in an external list.
OBExternalLocalInstrument1Code
string
User community specific instrument. Usage: This element is used to specify a local instrument, local clearing option and/or further qualify the service or serv…
OBExternalStatus1Code
string
Specifies the status of resource in code form.
OBPostalAddress6
object
Information that locates and identifies a specific address, as defined by postal services.
10 properties
OBWriteDomesticScheduledConsent2
object
2 properties 2 required
OBWriteDomesticScheduledResponse2
object
3 properties 3 required
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.
OBAuthorisation1
object
The authorisation type request from the TPP.
2 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

c-hoare-and-co-domestic-scheduled-payments-api-openapi.yml Raw ↑

Other APIs C. Hoare & Co. publishes across the network.

C. Hoare & Co. Account Access API
C. Hoare & Co. Accounts API
C. Hoare & Co. Balances API
C. Hoare & Co. Beneficiaries API
C. Hoare & Co. Client Registration API
C. Hoare & Co. Direct Debits API
C. Hoare & Co. Domestic Payments API
C. Hoare & Co. Domestic Standing Orders API
C. Hoare & Co. File Payments API
C. Hoare & Co. International Payments API
C. Hoare & Co. International Scheduled Payments API
C. Hoare & Co. International Standing Orders API
Where this information came from

This is an independent, third-party profile of C. Hoare & Co. Domestic Scheduled Payments 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.