The Domestic Payment Consents API from Hampden & Co — 3 operation(s) for domestic payment consents.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.curl "https://apis.io/api/v1/apis/hampden-and-co-domestic-payment-consents-api"curl "https://apis.io/api/v1/apis?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
openapi: 3.2.0
info:
title: Payment Initiation Domestic Payment Consents API
description: 'Swagger for Payment Initiation API Specification.
**Please Note**: There are no optional fields, if a field is not marked as “Required” it is a Conditional field.
'
termsOfService: https://www.openbanking.org.uk/terms
contact:
name: Service Desk
email: ServiceDesk@openbanking.org.uk
license:
name: open-licence
url: https://www.openbanking.org.uk/open-licence
version: 4.0.1
servers:
- url: /open-banking/v4.0/pisp
tags:
- name: Domestic Payment Consents
paths:
/domestic-payment-consents:
post:
tags:
- Domestic Payment Consents
summary: Create a Domestic Payment Consent
description: Enables a PISP to register an intent to initiate a Domestic Payment.
operationId: CreateDomesticPaymentConsents
parameters:
- $ref: '#/components/parameters/x-fapi-auth-date'
- $ref: '#/components/parameters/x-fapi-customer-ip-address'
- $ref: '#/components/parameters/x-fapi-interaction-id'
- $ref: '#/components/parameters/Authorization'
- $ref: '#/components/parameters/x-idempotency-key'
- $ref: '#/components/parameters/x-jws-signature'
- $ref: '#/components/parameters/x-customer-user-agent'
- $ref: '#/components/parameters/x-client-id'
requestBody:
content:
application/json; charset=utf-8:
schema:
$ref: '#/components/schemas/OBWriteDomesticConsent4'
application/json:
schema:
$ref: '#/components/schemas/OBWriteDomesticConsent4'
application/jose+jwe:
schema:
$ref: '#/components/schemas/OBWriteDomesticConsent4'
description: Default
required: true
responses:
'201':
$ref: '#/components/responses/201DomesticPaymentConsentsCreated'
'400':
$ref: '#/components/responses/400Error'
'401':
$ref: '#/components/responses/401Error'
'403':
$ref: '#/components/responses/403Error'
'405':
$ref: '#/components/responses/405Error'
'406':
$ref: '#/components/responses/406Error'
'415':
$ref: '#/components/responses/415Error'
'422':
$ref: '#/components/responses/422Error'
'429':
$ref: '#/components/responses/429Error'
'500':
$ref: '#/components/responses/500Error'
security:
- TPPOAuth2Security:
- payments
/domestic-payment-consents/{ConsentId}:
get:
tags:
- Domestic Payment Consents
summary: Get a Domestic Payment Consent
description: Enables a PISP to retrieve the status of an intent to initiate a Domestic Payment.
operationId: GetDomesticPaymentConsentsConsentId
parameters:
- $ref: '#/components/parameters/ConsentId'
- $ref: '#/components/parameters/x-fapi-auth-date'
- $ref: '#/components/parameters/x-fapi-customer-ip-address'
- $ref: '#/components/parameters/x-fapi-interaction-id'
- $ref: '#/components/parameters/Authorization'
- $ref: '#/components/parameters/x-customer-user-agent'
- $ref: '#/components/parameters/x-client-id'
responses:
'200':
$ref: '#/components/responses/200DomesticPaymentConsentsConsentIdRead'
'400':
$ref: '#/components/responses/400Error'
'401':
$ref: '#/components/responses/401Error'
'403':
$ref: '#/components/responses/403Error'
'405':
$ref: '#/components/responses/405Error'
'406':
$ref: '#/components/responses/406Error'
'429':
$ref: '#/components/responses/429Error'
'500':
$ref: '#/components/responses/500Error'
security:
- TPPOAuth2Security:
- payments
/domestic-payment-consents/{ConsentId}/funds-confirmation:
get:
tags:
- Domestic Payment Consents
summary: Confirm availability of funds for a Domestic Payment
description: Enables a PISP to check whether a PSU has sufficient available funds for a Domestic Payment.
operationId: GetDomesticPaymentConsentsConsentIdFundsConfirmation
parameters:
- $ref: '#/components/parameters/ConsentId'
- $ref: '#/components/parameters/x-fapi-auth-date'
- $ref: '#/components/parameters/x-fapi-customer-ip-address'
- $ref: '#/components/parameters/x-fapi-interaction-id'
- $ref: '#/components/parameters/Authorization'
- $ref: '#/components/parameters/x-customer-user-agent'
- $ref: '#/components/parameters/x-client-id'
responses:
'200':
$ref: '#/components/responses/200DomesticPaymentConsentsConsentIdFundsConfirmationRead'
'400':
$ref: '#/components/responses/400Error'
'401':
$ref: '#/components/responses/401Error'
'403':
$ref: '#/components/responses/403Error'
'405':
$ref: '#/components/responses/405Error'
'406':
$ref: '#/components/responses/406Error'
'429':
$ref: '#/components/responses/429Error'
'500':
$ref: '#/components/responses/500Error'
security:
- PSUOAuth2Security:
- payments
components:
responses:
500Error:
description: Internal Server Error
headers:
x-fapi-interaction-id:
description: An RFC4122 UID used as a correlation id.
required: true
schema:
type: string
x-jws-signature:
description: 'Header containing a detached JWS signature of the body of the payload.
'
required: true
schema:
type: string
content:
application/json; charset=utf-8:
schema:
$ref: '#/components/schemas/OBErrorResponse1'
application/json:
schema:
$ref: '#/components/schemas/OBErrorResponse1'
application/jose+jwe:
schema:
$ref: '#/components/schemas/OBErrorResponse1'
415Error:
description: Unsupported Media Type
headers:
x-fapi-interaction-id:
description: An RFC4122 UID used as a correlation id.
required: true
schema:
type: string
422Error:
description: Duplicate Idempotency key
headers:
x-fapi-interaction-id:
description: An RFC4122 UID used as a correlation id.
required: true
schema:
type: string
x-jws-signature:
description: Header containing a detached JWS signature of the body of the payload.
required: true
schema:
type: string
content:
application/json; charset=utf-8:
schema:
$ref: '#/components/schemas/OBErrorResponse1'
application/json:
schema:
$ref: '#/components/schemas/OBErrorResponse1'
application/jose+jwe:
schema:
$ref: '#/components/schemas/OBErrorResponse1'
403Error:
description: Forbidden
headers:
x-fapi-interaction-id:
description: An RFC4122 UID used as a correlation id.
required: true
schema:
type: string
x-jws-signature:
description: 'Header containing a detached JWS signature of the body of the payload.
'
required: true
schema:
type: string
content:
application/json; charset=utf-8:
schema:
$ref: '#/components/schemas/OBErrorResponse1'
application/json:
schema:
$ref: '#/components/schemas/OBErrorResponse1'
application/jose+jwe:
schema:
$ref: '#/components/schemas/OBErrorResponse1'
405Error:
description: Method Not Allowed
headers:
x-fapi-interaction-id:
description: An RFC4122 UID used as a correlation id.
required: true
schema:
type: string
200DomesticPaymentConsentsConsentIdFundsConfirmationRead:
description: Domestic Payment Consents Read
headers:
x-fapi-interaction-id:
description: An RFC4122 UID used as a correlation id.
required: true
schema:
type: string
x-jws-signature:
description: 'Header containing a detached JWS signature of the body of the payload.
'
required: true
schema:
type: string
RateLimit-Policy:
$ref: '#/components/headers/RateLimit-Policy'
RateLimit:
$ref: '#/components/headers/RateLimit'
content:
application/json; charset=utf-8:
schema:
$ref: '#/components/schemas/OBWriteFundsConfirmationResponse1'
application/json:
schema:
$ref: '#/components/schemas/OBWriteFundsConfirmationResponse1'
application/jose+jwe:
schema:
$ref: '#/components/schemas/OBWriteFundsConfirmationResponse1'
429Error:
description: Too Many Requests
headers:
Retry-After:
description: Number in seconds to wait
schema:
type: integer
x-fapi-interaction-id:
description: An RFC4122 UID used as a correlation id.
required: true
schema:
type: string
201DomesticPaymentConsentsCreated:
description: Domestic Payment Consents Created
headers:
x-fapi-interaction-id:
description: An RFC4122 UID used as a correlation id.
required: true
schema:
type: string
x-jws-signature:
description: 'Header containing a detached JWS signature of the body of the payload.
'
required: true
schema:
type: string
RateLimit-Policy:
$ref: '#/components/headers/RateLimit-Policy'
RateLimit:
$ref: '#/components/headers/RateLimit'
content:
application/json; charset=utf-8:
schema:
$ref: '#/components/schemas/OBWriteDomesticConsentResponse5'
application/json:
schema:
$ref: '#/components/schemas/OBWriteDomesticConsentResponse5'
application/jose+jwe:
schema:
$ref: '#/components/schemas/OBWriteDomesticConsentResponse5'
406Error:
description: Not Acceptable
headers:
x-fapi-interaction-id:
description: An RFC4122 UID used as a correlation id.
required: true
schema:
type: string
200DomesticPaymentConsentsConsentIdRead:
description: Domestic Payment Consents Read
headers:
x-fapi-interaction-id:
description: An RFC4122 UID used as a correlation id.
required: true
schema:
type: string
x-jws-signature:
description: 'Header containing a detached JWS signature of the body of the payload.
'
required: true
schema:
type: string
RateLimit-Policy:
$ref: '#/components/headers/RateLimit-Policy'
RateLimit:
$ref: '#/components/headers/RateLimit'
content:
application/json; charset=utf-8:
schema:
$ref: '#/components/schemas/OBWriteDomesticConsentResponse5'
application/json:
schema:
$ref: '#/components/schemas/OBWriteDomesticConsentResponse5'
application/jose+jwe:
schema:
$ref: '#/components/schemas/OBWriteDomesticConsentResponse5'
401Error:
description: Unauthorized
headers:
x-fapi-interaction-id:
description: An RFC4122 UID used as a correlation id.
required: true
schema:
type: string
400Error:
description: Bad request
headers:
x-fapi-interaction-id:
description: An RFC4122 UID used as a correlation id.
required: true
schema:
type: string
x-jws-signature:
description: 'Header containing a detached JWS signature of the body of the payload.
'
required: true
schema:
type: string
content:
application/json; charset=utf-8:
schema:
$ref: '#/components/schemas/OBErrorResponse1'
application/json:
schema:
$ref: '#/components/schemas/OBErrorResponse1'
application/jose+jwe:
schema:
$ref: '#/components/schemas/OBErrorResponse1'
parameters:
x-fapi-customer-ip-address:
in: header
name: x-fapi-customer-ip-address
required: false
description: The PSU's IP address if the PSU is currently logged in with the TPP.
schema:
type: string
x-fapi-auth-date:
in: header
name: x-fapi-auth-date
required: false
description: "The time when the PSU last logged in with the TPP. \nAll dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: \nSun, 10 Sep 2017 19:43:31 UTC"
schema:
type: string
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-idempotency-key:
name: x-idempotency-key
in: header
description: 'Every request will be processed only once per x-idempotency-key. The
Idempotency Key will be valid for 24 hours.
'
required: true
schema:
type: string
maxLength: 40
pattern: ^(?!\s)(.*)(\S)$
x-fapi-interaction-id:
in: header
name: x-fapi-interaction-id
required: false
description: An RFC4122 UID used as a correlation id.
schema:
type: string
Authorization:
in: header
name: Authorization
required: true
description: An Authorisation Token as per https://tools.ietf.org/html/rfc6750
schema:
type: string
x-customer-user-agent:
in: header
name: x-customer-user-agent
description: Indicates the user-agent that the PSU is using.
required: false
schema:
type: string
x-jws-signature:
in: header
name: x-jws-signature
required: true
description: A detached JWS signature of the body of the payload.
schema:
type: string
ConsentId:
name: ConsentId
in: path
description: ConsentId
required: true
schema:
type: string
x-client-id:
in: header
name: x-client-id
required: false
description: "Only used if an ASPSP requires the client ID in order to return rate limit headers. \n\nTPPs __must__ refer to ASPSP developer portals for further information on any rate limit policies, if the headers are supported and any additional requirements.\n\nThis header __must not__ be used for client authentication\n"
schema:
type: string
schemas:
OBInternalChargeBearerType1Code:
description: Specifies which party/parties will bear the charges associated with the processing of the payment transaction. For a full list of values refer to `OBInternalChargeBearerType1Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets)
type: string
enum:
- BorneByCreditor
- BorneByDebtor
- FollowingServiceLevel
- Shared
CareOf:
description: 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 for the individual.
type: string
minLength: 1
maxLength: 140
OBProxy1:
description: Specifies an alternate assumed name for the identification of the account.
type: object
required:
- Identification
- Code
properties:
Identification:
description: Identification used to indicate the account identification under another specified name.
type: string
minLength: 1
maxLength: 2048
Code:
$ref: '#/components/schemas/ExternalProxyAccountType1Code'
Type:
type: string
description: Type of the proxy identification.
minLength: 1
maxLength: 35
Floor:
description: Number that identifies the level within a building
type: string
minLength: 1
maxLength: 70
ExternalProxyAccountType1Code:
description: Specifies the external proxy account type code, as published in the proxy account type external code set.<br /> For a full list of values see `ExternalProxyAccountType1Code` in *ISO_External_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets)
type: string
enum:
- TELE
- EMAL
- DNAM
- CINC
- COTX
- COID
- CUST
- DRLC
- EIDN
- EWAL
- PVTX
- LEIC
- MBNO
- NIDN
- CCPT
- SHID
- SOSE
- TOKN
- UBIL
- VIPN
- BIID
OBInternalLocalInstrument1Code:
description: 'User community specific instrument.
Usage: This element is used to specify a local instrument, local clearing option and/or further qualify the service or service level. For a full list of values refer to `OBInternalLocalInstrument1Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets)'
type: string
x-namespaced-enum:
- UK.OBIE.BACS
- UK.OBIE.BalanceTransfer
- UK.OBIE.CHAPS
- UK.OBIE.Euro1
- UK.OBIE.FPS
- UK.OBIE.Link
- UK.OBIE.MoneyTransfer
- UK.OBIE.Paym
- UK.OBIE.SEPACreditTransfer
- UK.OBIE.SEPAInstantCreditTransfer
- UK.OBIE.SWIFT
- UK.OBIE.Target2
SubDepartment:
description: Identification of a sub-division of a large organisation or building.
type: string
minLength: 1
maxLength: 70
Department:
description: Identification of a division of a large organisation or building.
type: string
minLength: 1
maxLength: 70
UnitNumber:
description: Number that identifies the unit of a specific address .
type: string
minLength: 1
maxLength: 16
OBAddressType2Code:
description: Identifies the nature of the postal address. For a full set of codes see `OBAddressType2Code` [here](https://github.com/OpenBankingUK/External_Internal_CodeSets).
type: string
enum:
- BIZZ
- DLVY
- MLTO
- PBOX
- ADDR
- HOME
- CORR
- STAT
OBInternalPaymentChargeType1Code:
description: Charge type, in a coded form. For a full list of values refer to `OBInternalPaymentChargeType1Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets)
type: string
x-namespaced-enum:
- UK.OBIE.CHAPSOut
OBWriteDomesticConsentResponse5:
type: object
additionalProperties: false
required:
- Data
- Risk
properties:
Data:
type: object
additionalProperties: false
required:
- ConsentId
- CreationDateTime
- Status
- StatusUpdateDateTime
- Initiation
properties:
ConsentId:
description: 'OB: Unique identification as assigned by the ASPSP to uniquely identify the consent resource.'
type: string
minLength: 1
maxLength: 128
CreationDateTime:
description: "Date and time at which the resource was created. All dates in the JSON payloads are represented in ISO 8601 date-time format. \nAll date-time fields in responses must include the timezone. An example is below:\n2017-04-05T10:43:07+00:00"
type: string
format: date-time
Status:
$ref: '#/components/schemas/OBInternalConsentStatus2Code'
StatusReason:
type: array
items:
$ref: '#/components/schemas/OBStatusReason'
StatusUpdateDateTime:
description: "Date and time at which the resource status was updated. All dates in the JSON payloads are represented in ISO 8601 date-time format. \nAll date-time fields in responses must include the timezone. An example is below:\n2017-04-05T10:43:07+00:00"
type: string
format: date-time
ReadRefundAccount:
description: Specifies to share the refund account details with PISP. For a full list of values refer to `OBInternalReadRefundAccount1Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets)
type: string
enum:
- 'No'
- 'Yes'
CutOffDateTime:
description: "Specified cut-off date and time for the payment consent. All dates in the JSON payloads are represented in ISO 8601 date-time format. \nAll date-time fields in responses must include the timezone. An example is below:\n2017-04-05T10:43:07+00:00"
type: string
format: date-time
ExpectedExecutionDateTime:
description: "Expected execution date and time for the payment resource. All dates in the JSON payloads are represented in ISO 8601 date-time format. \nAll date-time fields in responses must include the timezone. An example is below:\n2017-04-05T10:43:07+00:00"
type: string
format: date-time
ExpectedSettlementDateTime:
description: "Expected settlement date and time for the payment resource. All dates in the JSON payloads are represented in ISO 8601 date-time format. \nAll date-time fields in responses must include the timezone. An example is below:\n2017-04-05T10:43:07+00:00"
type: string
format: date-time
Charges:
type: array
items:
type: object
additionalProperties: false
description: Set of elements used to provide details of a charge for the payment initiation.
required:
- ChargeBearer
- Type
- Amount
properties:
ChargeBearer:
$ref: '#/components/schemas/OBInternalChargeBearerType1Code'
Type:
$ref: '#/components/schemas/OBInternalPaymentChargeType1Code'
Amount:
$ref: '#/components/schemas/OBActiveOrHistoricCurrencyAndAmount'
Initiation:
type: object
additionalProperties: false
required:
- InstructionIdentification
- EndToEndIdentification
- InstructedAmount
- CreditorAccount
description: 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 domestic payment.
properties:
InstructionIdentification:
description: 'Unique identification as assigned by an instructing party for an instructed party to unambiguously identify the instruction.
Usage: the instruction identification is a point to point reference that can be used between the instructing party and the instructed party to refer to the individual instruction. It can be included in several messages related to the instruction.'
type: string
minLength: 1
maxLength: 35
EndToEndIdentification:
description: 'Unique identification assigned by the initiating party to unambiguously identify the transaction. This identification is passed on, unchanged, throughout the entire end-to-end chain.
Usage: The end-to-end identification can be used for reconciliation or to link tasks relating to the transaction. It can be included in several messages related to the transaction.
OB: The Faster Payments Scheme can only access 31 characters for the EndToEndIdentification field.'
type: string
minLength: 1
maxLength: 35
LocalInstrument:
$ref: '#/components/schemas/OBInternalLocalInstrument1Code'
InstructedAmount:
type: object
additionalProperties: false
required:
- Amount
- Currency
description: 'Amount of money to be moved between the debtor and creditor, before deduction of charges, expressed in the currency as ordered by the initiating party.
Usage: This amount has to be transported unchanged through the transaction chain.'
properties:
Amount:
$ref: '#/components/schemas/OBActiveCurrencyAndAmount_SimpleType'
Currency:
$ref: '#/components/schemas/ActiveOrHistoricCurrencyCode'
DebtorAccount:
type: object
additionalProperties: false
required:
- SchemeName
- Identification
description: Unambiguous identification of the account of the debtor to which a debit entry will be made as a result of the transaction.
properties:
SchemeName:
$ref: '#/components/schemas/OBInternalAccountIdentification4Code'
Identification:
$ref: '#/components/schemas/Identification_0'
Name:
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.'
type: string
minLength: 1
maxLength: 350
SecondaryIdentification:
$ref: '#/components/schemas/SecondaryIdentification'
Proxy:
$ref: '#/components/schemas/OBProxy1'
CreditorAgent:
type: object
additionalProperties: false
description: Financial institution servicing an account for the creditor.
properties:
SchemeName:
$ref: '#/components/schemas/OBInternalFinancialInstitutionIdentification4Code'
Identification:
$ref: '#/components/schemas/Identification_1'
Name:
$ref: '#/components/schemas/Name'
LEI:
$ref: '#/components/schemas/LEI'
PostalAddress:
$ref: '#/components/schemas/OBPostalAddress7'
CreditorAccount:
type: object
additionalProperties: false
required:
- SchemeName
- Identification
- Name
description: Unambiguous identification of the account of the creditor to which a credit entry will be posted as a result of the payment transaction.
properties:
SchemeName:
$ref: '#/components/schemas/OBInternalAccountIdentification4Code'
Identification:
$ref: '#/components/schemas/Identification_0'
Name:
description: 'The account name is the name or names of the account owner(s) represented at an account level.
Note, the account name is not the product name or the nickname of the account.
OB: ASPSPs may carry out name validation for Confirmation of Payee, but it is not mandatory.'
type: string
minLength: 1
maxLength: 350
SecondaryIdentification:
$ref: '#/components/schemas/SecondaryIdentification'
Proxy:
$ref: '#/components/schemas/OBProxy1'
CreditorPostalAddress:
$ref: '#/components/schemas/OBPostalAddress7'
UltimateCreditor:
$ref: '#/components/schemas/OBUltimateCreditor1'
UltimateDebtor:
$ref: '#/components/schemas/OBUltimateDebtor1'
RegulatoryReporting:
type: array
items:
$ref: '#/components/schemas/OBRegulatoryReporting1'
maxItems: 10
RemittanceInformation:
$ref: '#/components/schemas/OBRemittanceInformation2'
SupplementaryData:
$ref: '#/components/schemas/OBSupplementaryData1'
Authorisation:
type: object
additionalProperties: false
required:
- AuthorisationType
description: The authorisation type request from the TPP.
properties:
AuthorisationType:
description: Type of authorisation flow requested. For a full list of values refer to `OBInternalAuthorisation1Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets)
type: string
enum:
- Any
- Single
- Multiple
CompletionDateTime:
description: "Date and time at which the requested authorisation flow must be completed. All dates in the JSON payloads are represented in ISO 8601 date-time format. \nAll date-time fields in responses must include the timezone. An example is below:\n2017-04-05T10:43:07+00:00"
type: string
format: date-time
SCASupportData:
$ref: '#/components/schemas/OBSCASupportData1'
Debtor:
$ref: '#/components/schemas/OBCashAccountDebtor4'
Risk:
$ref: '#/components/schemas/OBRisk1'
Links:
$ref: '#/components/schemas/Links'
Meta:
$ref: '#/components/schemas/Meta'
LEI:
description: 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 "Financial Services - Legal Entity Identifier (LEI)".
type: string
example: IZ9Q00LZEVUKWCQY6X15
minLength: 1
maxLength: 20
pattern: ^[A-Z0-9]{18,18}[0-9]{2,2}$
Identification_1:
description: Unique identification, as assigned by the creditor, to unambiguously identify the mandate.
type: string
minLength: 1
maxLength: 35
OBInternalAccountIdentification4Code:
description: 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 *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets)
type: string
x-namespaced-enum:
- UK.OBIE.BBAN
- UK.OBIE.IBAN
- UK.OBIE.PAN
- UK.OBIE.Paym
- UK.OBIE.SortCodeAccountNumber
- UK.OBIE.Wallet
OBInternalConsentStatus2Code:
type: string
description: Specifies the status of consent resource in code form. For a full list of values refer to `OBInternalConsentStatus2Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets)
enum:
- AWAU
- RJCT
- AUTH
- COND
OBWriteFundsConfirmationResponse1:
type: object
additionalProperties: false
required:
- Data
properties:
Data:
type: object
additionalProperties: false
properties:
FundsAvailableResult:
type: object
additionalProperties: false
required:
- FundsAvailableDateTime
# --- truncated at 32 KB (71 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/hampden-and-co/refs/heads/main/openapi/hampden-and-co-domestic-payment-consents-api-openapi.yml