Implementation Guide: Adam & Company

This page has been created and maintained by the relevant ASPSP, and OBIE takes no liability for the completeness nor accuracy of this data.

Note to ASPSP: Please indicate which brands this applies to and/or duplicate this page per brand if relevant.


ASPSPAdam & Company
BrandAdam & Company
Date 
Developer portal (s)https://www.bankofapis.com/
Developer Sandbox

https://developer.coutts.useinfinite.io/ (Sandbox is shared with Coutts & Company)

Announcements:

TPP Info

As communicated two weeks ago, Adam & Co. has deployed and verified a new major release of our Open Banking solution stack. We request all TPPs to re-onboard starting 26.09.2019. In case of issues or questions, please contact our service desk as indicated on the developer portal.

Planned Improvements
Delivery date

App-to-App enhancements: Adam & Co plans to implement app-to-app enhancements for Open Banking journeys by mid November.

17.11.2019
File Payments v3.117.11.2019

Change to Production:

Improvement
Delivery date
n/a-

On-boarding

Supports dynamic client registration (Y/N)Y
Instructions for manual onboardingAdam & Co. does not support manual registration. Only dynamic registration is supported.
OIDC .well-known endpoint

https://secure1.adambank.com/.well-known/openid-configuration

Notes on testing

Follow the instructions on the ‘Sandbox’ page in our developer portal to get started. For all other testing related support queries, raise a testing related request using the service desk on our developer portal ‘Launch the Service Desk’ page. Until September 14th, Adam & Co. is in a phase of live proving with a limited number of customers. If a TPP should plan to integrate with Adam productively and test the APIs, then please contact us via the service desk mentioned above.

Other on-boarding notes

Currently, Adam & Co. supports certificates issued by Open Banking. Support of eIDAS certificates is planned to be available by end of November 2019.

Documentation URL

https://www.bankofapis.com/products/accounts/documentation/adam/3.0.0

Account Information API

Swagger version3.1
Base URI

https://api.adambank.com:8446/open-banking/v3.1/aisp/

General variances to specification Bulk endpoints not implemented
Non-functional limitations

Global as well as individual TPP rate limiting will be applied for API calls in production and in sandbox.

List of endpoints


Resource
Endpoint
Available (Y/N)
Mandatory?
1account-access-consents

POST /account-access-consents

Y

Mandatory

2account-access-consents

GET /account-requests/{AccountRequestId}

Y

Mandatory

3account-access-consents

DELETE /account-requests/{AccountRequestId}

Y

Mandatory

4accounts

GET /accounts

Y

Mandatory

5accountsGET /accounts/{AccountId}YMandatory
6balancesGET /accounts/{AccountId}/balancesYMandatory
7balancesGET /balancesNOptional
8transactionsGET /accounts/{AccountId}/transactionsYMandatory
9transactionsGET /transactionsNOptional
10beneficiariesGET /accounts/{AccountId}/beneficiariesYConditional
11beneficiariesGET /beneficiariesNOptional
12direct-debitsGET /accounts/{AccountId}/direct-debitsYConditional
13direct-debitsGET /direct-debitsNOptional
14standing-ordersGET /accounts/{AccountId}/standing-ordersYConditional
15standing-ordersGET /standing-ordersNOptional
16productsGET /accounts/{AccountId}/productYConditional
17productsGET /productsNOptional
18offersGET /accounts/{AccountId}/offersNConditional
19offersGET /offersNOptional
20partyGET /accounts/{AccountId}/partyNConditional
21partyGET /partyNOptional
22scheduled-paymentsGET /accounts/{AccountId}/scheduled-paymentsYConditional
23scheduled-paymentsGET /scheduled-paymentsNOptional
24statementsGET /accounts/{AccountId}/statementsNConditional
25statementsGET /accounts/{AccountId}/statements/{StatementId}NConditional
26statementsGET /accounts/{AccountId}/statements/{StatementId}/fileNOptional
27transactionsGET /accounts/{AccountId}/statements/{StatementId}/transactionsNConditional
28statementsGET /statementsNConditional

Fields information

The information struck through are not valid for the current implementation, see the red text for the implementation differences/details.

Account Access Consents - Request - Data Dictionary

Name
Occurrence
XPath
EnhancedDefinition
Class
Codes
OBReadConsent1
OBReadConsent1
OBReadConsent1
Data1..1OBReadConsent1/Data
OBReadData1
Permissions1..nOBReadConsent1/Data/PermissionsSpecifies the Open Banking account access data types. This is a list of the data clusters being consented by the PSU, and requested for authorisation with the ASPSP.OBExternalPermissions1CodeReadAccountsBasic
ReadAccountsDetail
ReadBalances
ReadBeneficiariesBasic
ReadBeneficiariesDetail
ReadDirectDebits
ReadOffers
ReadPAN
ReadParty
ReadPartyPSU
ReadProducts
ReadScheduledPaymentsBasic
ReadScheduledPaymentsDetail
ReadStandingOrdersBasic
ReadStandingOrdersDetail
ReadStatementsBasic
ReadStatementsDetail
ReadTransactionsBasic
ReadTransactionsCredits
ReadTransactionsDebits
ReadTransactionsDetail
ExpirationDateTime0..1OBReadConsent1/Data/ExpirationDateTimeSpecified date and time the permissions will expire.
If this is not populated, the permissions will be open ended.
ISODateTime
TransactionFromDateTime0..1OBReadConsent1/Data/TransactionFromDateTimeSpecified start date and time for the transaction query period.
If this is not populated, the start date will be open ended, and data will be returned from the earliest available transaction.
ISODateTime
TransactionToDateTime0..1OBReadConsent1/Data/TransactionToDateTimeSpecified end date and time for the transaction query period.
If this is not populated, the end date will be open ended, and data will be returned to the latest available transaction.
ISODateTime
Risk1..1OBReadConsent1/RiskThe Risk section is sent by the initiating party to the ASPSP. It is used to specify additional details for risk scoring for Account Info.OBRisk2

Account Access Consents - Response - Data Dictionary

Name
Occurrence
XPath
EnhancedDefinition
Class
Codes
OBReadConsentResponse1OBReadConsentResponse1OBReadConsentResponse1


Data1..1OBReadConsentResponse1/DataOBReadDataConsentResponse1

ConsentId1..1OBReadConsentResponse1/Data/ConsentIdUnique identification as assigned to identify the account access consent resource.Max128Text
CreationDateTime1..1OBReadConsentResponse1/Data/CreationDateTimeDate and time at which the resource was created.ISODateTime
Status1..1OBReadConsentResponse1/Data/StatusSpecifies the status of consent resource in code form.OBExternalRequestStatus1CodeAuthorised
AwaitingAuthorisation
Rejected
Revoked
StatusUpdateDateTime1..1OBReadConsentResponse1/Data/StatusUpdateDateTimeDate and time at which the resource status was updated.ISODateTime
Permissions1..nOBReadConsentResponse1/Data/PermissionsSpecifies the Open Banking account access data types. This is a list of the data clusters being consented by the PSU, and requested for authorisation with the ASPSP.OBExternalPermissions1CodeReadAccountsBasic
ReadAccountsDetail
ReadBalances
ReadBeneficiariesBasic
ReadBeneficiariesDetail
ReadDirectDebits
ReadOffers
ReadPAN
ReadParty
ReadPartyPSU
ReadProducts
ReadScheduledPaymentsBasic
ReadScheduledPaymentsDetail
ReadStandingOrdersBasic
ReadStandingOrdersDetail
ReadStatementsBasic
ReadStatementsDetail
ReadTransactionsBasic
ReadTransactionsCredits
ReadTransactionsDebits
ReadTransactionsDetail
ExpirationDateTime0..1OBReadConsentResponse1/Data/ExpirationDateTimeSpecified date and time the permissions will expire.
If this is not populated, the permissions will be open ended.
ISODateTime
TransactionFromDateTime0..1OBReadConsentResponse1/Data/TransactionFromDateTimeSpecified start date and time for the transaction query period.
If this is not populated, the start date will be open ended, and data will be returned from the earliest available transaction.
ISODateTime
TransactionToDateTime0..1OBReadConsentResponse1/Data/TransactionToDateTimeSpecified end date and time for the transaction query period.
If this is not populated, the end date will be open ended, and data will be returned to the latest available transaction.
ISODateTime
Risk1..1OBReadConsentResponse1/RiskThe Risk section is sent by the initiating party to the ASPSP. It is used to specify additional details for risk scoring for Account Info.OBRisk2

Account - Data Dictionary

Name
Occurrence
XPath
EnhancedDefinition
Class
Codes
Pattern

OBReadAccount3


OBReadAccount3


OBReadAccount3



Data

1..1

OBReadAccount3/Data


OBReadDataAccount3



Account

0..n

OBReadAccount3/Data/Account

Unambiguous identification of the account to which credit and debit entries are made.

OBAccount3



AccountId

1..1

OBReadAccount3/Data/Account/AccountId

A unique and immutable identifier used to identify the account resource. This identifier has no meaning to the account owner.

Max40Text



Currency

1..1

OBReadAccount3/Data/Account/Currency

Identification of the currency in which the account is held.


Usage: Currency should only be used in case one and the same account number covers several currencies

and the initiating party needs to identify which currency needs to be used for settlement on the account.

ActiveOrHistoricCurrencyCode


^[A-Z]{3,3}$

AccountType

1..1

OBReadAccount3/Data/Account/AccountType

Specifies the type of account (personal or business).

OBExternalAccountType1Code

Business

Personal


AccountSubType

1..1

OBReadAccount3/Data/Account/AccountSubType

Specifies the sub type of account (product family group).

OBExternalAccountSubType1Code

ChargeCard

CreditCard

CurrentAccount

EMoney

Loan

Mortgage

PrePaidCard

Savings


Description

0..1

OBReadAccount3/Data/Account/Description

Specifies the description of the account type.

Max35Text



Nickname

0..1

OBReadAccount3/Data/Account/Nickname

The nickname of the account, assigned by the account owner in order to provide an additional means of identification of the account.

Max70Text



Account

0..n

OBReadAccount3/Data/Account/Account

Provides the details to identify an account.

OBCashAccount5



SchemeName

1..1

OBReadAccount3/Data/Account/Account/SchemeName

Name of the identification scheme, in a coded form as published in an external list.

OBExternalAccountIdentification4Code



Identification

1..1

OBReadAccount3/Data/Account/Account/Identification

Identification assigned by an institution to identify an account. This identification is known by the account owner.

Max256Text



Name

0..1

OBReadAccount3/Data/Account/Account/Name

Name of the account, as assigned by the account servicing institution.


Usage: 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.

Max70Text



SecondaryIdentification

0..1

OBReadAccount3/Data/Account/Account/SecondaryIdentification

This is secondary identification of the account, as assigned by the account servicing institution.

This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination).

Max34Text



Servicer

0..1

OBReadAccount3/Data/Account/Servicer

Party that manages the account on behalf of the account owner, that is manages the registration and booking of entries on the account, calculates balances on the account and provides information about the account.

OBBranchAndFinancialInstitutionIdentification5



SchemeName

1..1

OBReadAccount3/Data/Account/Servicer/SchemeName

Name of the identification scheme, in a coded form as published in an external list.

OBExternalFinancialInstitutionIdentification4Code



Identification

1..1

OBReadAccount3/Data/Account/Servicer/Identification

Unique and unambiguous identification of the servicing institution.

Max35Text



Balances - Data Dictionary

Name
Occurrence
XPath
EnhancedDefinition
Class
Codes
Pattern

OBReadBalance1


OBReadBalance1


OBReadBalance1



Data

1..1

OBReadBalance1/Data


OBReadDataBalance1



Balance

1..n

OBReadBalance1/Data/Balance

Set of elements used to define the balance details.

OBCashBalance1



AccountId

1..1

OBReadBalance1/Data/Balance/AccountId

A unique and immutable identifier used to identify the account resource. This identifier has no meaning to the account owner.

Max40Text



CreditDebitIndicator

1..1

OBReadBalance1/Data/Balance/CreditDebitIndicator

Indicates whether the balance is a credit or a debit balance.

Usage: A zero balance is considered to be a credit balance.

OBCreditDebitCode

Credit

Debit


Type

1..1

OBReadBalance1/Data/Balance/Type

Balance type, in a coded form.

OBBalanceType1Code

ClosingAvailable

ClosingBooked

ClosingCleared

Expected

ForwardAvailable

Information

InterimAvailable

InterimBooked

InterimCleared

OpeningAvailable

OpeningBooked

OpeningCleared

PreviouslyClosedBooked


DateTime

1..1

OBReadBalance1/Data/Balance/DateTime

Indicates the date (and time) of the balance.

ISODateTime



Amount

1..1

OBReadBalance1/Data/Balance/Amount

Amount of money of the cash balance.

OBActiveOrHistoricCurrencyAndAmount



Amount

1..1

OBReadBalance1/Data/Balance/Amount/Amount

A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.

OBActiveCurrencyAndAmount_SimpleType


^\d{1,13}\.\d{1,5}$

Currency

1..1

OBReadBalance1/Data/Balance/Amount/Currency

A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".

ActiveOrHistoricCurrencyCode


^[A-Z]{3,3}$

CreditLine

0..n

OBReadBalance1/Data/Balance/CreditLine

Set of elements used to provide details on the credit line.

OBCreditLine1



Included

1..1

OBReadBalance1/Data/Balance/CreditLine/Included

Indicates whether or not the credit line is included in the balance of the account.


Usage: If not present, credit line is not included in the balance amount of the account.

xs:boolean



Type

0..1

OBReadBalance1/Data/Balance/CreditLine/Type

Limit type, in a coded form.

OBExternalLimitType1Code

Available

Credit

Emergency

Pre-Agreed

Temporary


Amount

0..1

OBReadBalance1/Data/Balance/CreditLine/Amount

Amount of money of the credit line.

OBActiveOrHistoricCurrencyAndAmount



Amount

1..1

OBReadBalance1/Data/Balance/CreditLine/Amount/Amount

A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.

OBActiveCurrencyAndAmount_SimpleType


^\d{1,13}\.\d{1,5}$

Currency

1..1

OBReadBalance1/Data/Balance/CreditLine/Amount/Currency

A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".

ActiveOrHistoricCurrencyCode


^[A-Z]{3,3}$

Transactions - Data Dictionary

Name
Occurrence
XPath
EnhancedDefinition
Class
Codes
Pattern

OBReadTransaction4


OBReadTransaction4


OBReadTransaction4



Data

1..1

OBReadTransaction4/Data


OBReadDataTransaction4



Transaction

0..n

OBReadTransaction4/Data/Transaction

Provides further details on an entry in the report.

OBTransaction4



AccountId

1..1

OBReadTransaction4/Data/Transaction/AccountId

A unique and immutable identifier used to identify the account resource. This identifier has no meaning to the account owner.

Max40Text



TransactionId

0..1

OBReadTransaction4/Data/Transaction/TransactionId

Unique identifier for the transaction within an servicing institution. This identifier is both unique and immutable.

Max40Text



TransactionReference

0..1

OBReadTransaction4/Data/Transaction/TransactionReference

Unique reference for the transaction. This reference is optionally populated, and may as an example be the FPID in the Faster Payments context.

Max35Text



StatementReference

0..n

OBReadTransaction4/Data/Transaction/StatementReference

Unique reference for the statement. This reference may be optionally populated if available.

Max35Text



CreditDebitIndicator

1..1

OBReadTransaction4/Data/Transaction/CreditDebitIndicator

Indicates whether the transaction is a credit or a debit entry.

OBCreditDebitCode

Credit

Debit


Status

1..1

OBReadTransaction4/Data/Transaction/Status

Status of a transaction entry on the books of the account servicer.

OBEntryStatus1Code

Booked

Pending


BookingDateTime

1..1

OBReadTransaction4/Data/Transaction/BookingDateTime

Date and time when a transaction entry is posted to an account on the account servicer's books.


Usage: Booking date is the expected booking date, unless the status is booked, in which case it is the actual booking date.

ISODateTime



ValueDateTime

0..1

OBReadTransaction4/Data/Transaction/ValueDateTime

Date and time at which assets become available to the account owner in case of a credit entry, or cease to be available to the account owner in case of a debit transaction entry.

Usage: If transaction entry status is pending and value date is present, then the value date refers to an expected/requested value date.

For transaction entries subject to availability/float and for which availability information is provided, the value date must not be used. In this case the availability component identifies the number of availability days.

ISODateTime



TransactionInformation

0..1

OBReadTransaction4/Data/Transaction/TransactionInformation

Further details of the transaction.

This is the transaction narrative, which is unstructured text.

Max500Text



AddressLine

0..1

OBReadTransaction4/Data/Transaction/AddressLine

Information that locates and identifies a specific address for a transaction entry, that is presented in free format text.

Max70Text



Amount

1..1

OBReadTransaction4/Data/Transaction/Amount

Amount of money in the cash transaction entry.

OBActiveOrHistoricCurrencyAndAmount



Amount

1..1

OBReadTransaction4/Data/Transaction/Amount/Amount

A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.

OBActiveCurrencyAndAmount_SimpleType


^\d{1,13}\.\d{1,5}$

Currency

1..1

OBReadTransaction4/Data/Transaction/Amount/Currency

A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".

ActiveOrHistoricCurrencyCode


^[A-Z]{3,3}$

ChargeAmount

0..1

OBReadTransaction4/Data/Transaction/ChargeAmount

Transaction charges to be paid by the charge bearer.

OBActiveOrHistoricCurrencyAndAmount



Amount

1..1

OBReadTransaction4/Data/Transaction/ChargeAmount/Amount

A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.

OBActiveCurrencyAndAmount_SimpleType


^\d{1,13}\.\d{1,5}$

Currency

1..1

OBReadTransaction4/Data/Transaction/ChargeAmount/Currency

A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".

ActiveOrHistoricCurrencyCode


^[A-Z]{3,3}$

CurrencyExchange

0..1

OBReadTransaction4/Data/Transaction/CurrencyExchange

Set of elements used to provide details on the currency exchange.

OBCurrencyExchange5



SourceCurrency

1..1

OBReadTransaction4/Data/Transaction/CurrencyExchange/SourceCurrency

Currency from which an amount is to be converted in a currency conversion.

ActiveOrHistoricCurrencyCode


^[A-Z]{3,3}$

TargetCurrency

0..1

OBReadTransaction4/Data/Transaction/CurrencyExchange/TargetCurrency

Currency into which an amount is to be converted in a currency conversion.

ActiveOrHistoricCurrencyCode


^[A-Z]{3,3}$

UnitCurrency

0..1

OBReadTransaction4/Data/Transaction/CurrencyExchange/UnitCurrency

Currency in which the rate of exchange is expressed in a currency exchange. In the example 1GBP = xxxCUR, the unit currency is GBP.

ActiveOrHistoricCurrencyCode


^[A-Z]{3,3}$

ExchangeRate

1..1

OBReadTransaction4/Data/Transaction/CurrencyExchange/ExchangeRate

Factor used to convert an amount from one currency into another. This reflects the price at which one currency was bought with another currency.


Usage: ExchangeRate expresses the ratio between UnitCurrency and QuotedCurrency (ExchangeRate = UnitCurrency/QuotedCurrency).

BaseOneRate



ContractIdentification

0..1

OBReadTransaction4/Data/Transaction/CurrencyExchange/ContractIdentification

Unique identification to unambiguously identify the foreign exchange contract.

Max35Text



QuotationDate

0..1

OBReadTransaction4/Data/Transaction/CurrencyExchange/QuotationDate

Date and time at which an exchange rate is quoted.

ISODateTime



InstructedAmount

0..1

OBReadTransaction4/Data/Transaction/CurrencyExchange/InstructedAmount

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.

OBActiveOrHistoricCurrencyAndAmount



Amount

1..1

OBReadTransaction4/Data/Transaction/CurrencyExchange/InstructedAmount/Amount

A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.

OBActiveCurrencyAndAmount_SimpleType


^\d{1,13}\.\d{1,5}$

Currency

1..1

OBReadTransaction4/Data/Transaction/CurrencyExchange/InstructedAmount/Currency

A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".

ActiveOrHistoricCurrencyCode


^[A-Z]{3,3}$

BankTransactionCode

0..1

OBReadTransaction4/Data/Transaction/BankTransactionCode

Set of elements used to fully identify the type of underlying transaction resulting in an entry.

OBBankTransactionCodeStructure1



Code

1..1

OBReadTransaction4/Data/Transaction/BankTransactionCode/Code

Specifies the family within a domain.

ExternalBankTransactionFamily1Code



SubCode

1..1

OBReadTransaction4/Data/Transaction/BankTransactionCode/SubCode

Specifies the sub-product family within a specific family.

ExternalBankTransactionSubFamily1Code



ProprietaryBankTransactionCode

0..1

OBReadTransaction4/Data/Transaction/ProprietaryBankTransactionCode

Set of elements to fully identify a proprietary bank transaction code.

ProprietaryBankTransactionCodeStructure1



Code

1..1

OBReadTransaction4/Data/Transaction/ProprietaryBankTransactionCode/Code

Proprietary bank transaction code to identify the underlying transaction.

Max35Text



Issuer

0..1

OBReadTransaction4/Data/Transaction/ProprietaryBankTransactionCode/Issuer

Identification of the issuer of the proprietary bank transaction code.

Max35Text



Balance

0..1

OBReadTransaction4/Data/Transaction/Balance

Set of elements used to define the balance as a numerical representation of the net increases and decreases in an account after a transaction entry is applied to the account.

OBTransactionCashBalance



CreditDebitIndicator

1..1

OBReadTransaction4/Data/Transaction/Balance/CreditDebitIndicator

Indicates whether the balance is a credit or a debit balance.

Usage: A zero balance is considered to be a credit balance.

OBCreditDebitCode

Credit

Debit


Type

1..1

OBReadTransaction4/Data/Transaction/Balance/Type

Balance type, in a coded form.

OBBalanceType1Code

ClosingAvailable

ClosingBooked

ClosingCleared

Expected

ForwardAvailable

Information

InterimAvailable

InterimBooked

InterimCleared

OpeningAvailable

OpeningBooked

OpeningCleared

PreviouslyClosedBooked


Amount

1..1

OBReadTransaction4/Data/Transaction/Balance/Amount

Amount of money of the cash balance after a transaction entry is applied to the account..

OBActiveOrHistoricCurrencyAndAmount



Amount

1..1

OBReadTransaction4/Data/Transaction/Balance/Amount/Amount

A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.

OBActiveCurrencyAndAmount_SimpleType


^\d{1,13}\.\d{1,5}$

Currency

1..1

OBReadTransaction4/Data/Transaction/Balance/Amount/Currency

A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".

ActiveOrHistoricCurrencyCode


^[A-Z]{3,3}$

MerchantDetails

0..1

OBReadTransaction4/Data/Transaction/MerchantDetails

Details of the merchant involved in the transaction.

OBMerchantDetails1



MerchantName

0..1

OBReadTransaction4/Data/Transaction/MerchantDetails/MerchantName

Name by which the merchant is known.

Max350Text



MerchantCategoryCode

0..1

OBReadTransaction4/Data/Transaction/MerchantDetails/MerchantCategoryCode

Category code conform to ISO 18245, related to the type of services or goods the merchant provides for the transaction.

Min3Max4Text



CreditorAgent

0..1

OBReadTransaction4/Data/Transaction/CreditorAgent

Financial institution servicing an account for the creditor.

OBBranchAndFinancialInstitutionIdentification6



SchemeName

0..1

OBReadTransaction4/Data/Transaction/CreditorAgent/SchemeName

Name of the identification scheme, in a coded form as published in an external list.

OBExternalFinancialInstitutionIdentification4Code



Identification

0..1

OBReadTransaction4/Data/Transaction/CreditorAgent/Identification

Unique and unambiguous identification of a financial institution or a branch of a financial institution.

Max35Text



Name

0..1

OBReadTransaction4/Data/Transaction/CreditorAgent/Name

Name by which an agent is known and which is usually used to identify that agent.

Max140Text



PostalAddress

0..1

OBReadTransaction4/Data/Transaction/CreditorAgent/PostalAddress

Information that locates and identifies a specific address, as defined by postal services.

OBPostalAddress6



AddressType

0..1

OBReadTransaction4/Data/Transaction/CreditorAgent/PostalAddress/AddressType

Identifies the nature of the postal address.

OBAddressTypeCode

Business

Correspondence

DeliveryTo

MailTo

POBox

Postal

Residential

Statement


Department

0..1

OBReadTransaction4/Data/Transaction/CreditorAgent/PostalAddress/Department

Identification of a division of a large organisation or building.

Max70Text



SubDepartment

0..1

OBReadTransaction4/Data/Transaction/CreditorAgent/PostalAddress/SubDepartment

Identification of a sub-division of a large organisation or building.

Max70Text



StreetName

0..1

OBReadTransaction4/Data/Transaction/CreditorAgent/PostalAddress/StreetName

Name of a street or thoroughfare.

Max70Text



BuildingNumber

0..1

OBReadTransaction4/Data/Transaction/CreditorAgent/PostalAddress/BuildingNumber

Number that identifies the position of a building on a street.

Max16Text



PostCode

0..1

OBReadTransaction4/Data/Transaction/CreditorAgent/PostalAddress/PostCode

Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.

Max16Text



TownName

0..1

OBReadTransaction4/Data/Transaction/CreditorAgent/PostalAddress/TownName

Name of a built-up area, with defined boundaries, and a local government.

Max35Text



CountrySubDivision

0..1

OBReadTransaction4/Data/Transaction/CreditorAgent/PostalAddress/CountrySubDivision

Identifies a subdivision of a country such as state, region, county.

Max35Text



Country

0..1

OBReadTransaction4/Data/Transaction/CreditorAgent/PostalAddress/Country

Nation with its own government.

CountryCode


^[A-Z]{2,2}$

AddressLine

0..7

OBReadTransaction4/Data/Transaction/CreditorAgent/PostalAddress/AddressLine

Information that locates and identifies a specific address, as defined by postal services, presented in free format text.

Max70Text



CreditorAccount

0..1

OBReadTransaction4/Data/Transaction/CreditorAccount

Unambiguous identification of the account of the creditor, in the case of a debit transaction.

OBCashAccount6



SchemeName

0..1

OBReadTransaction4/Data/Transaction/CreditorAccount/SchemeName

Name of the identification scheme, in a coded form as published in an external list.

OBExternalAccountIdentification4Code



Identification

0..1

OBReadTransaction4/Data/Transaction/CreditorAccount/Identification

Identification assigned by an institution to identify an account. This identification is known by the account owner.

Max256Text



Name

0..1

OBReadTransaction4/Data/Transaction/CreditorAccount/Name

Name of the account, as assigned by the account servicing institution.


Usage: 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.

Max70Text



SecondaryIdentification

0..1

OBReadTransaction4/Data/Transaction/CreditorAccount/SecondaryIdentification

This is secondary identification of the account, as assigned by the account servicing institution.

This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination).

Max34Text



DebtorAgent

0..1

OBReadTransaction4/Data/Transaction/DebtorAgent

Financial institution servicing an account for the debtor.

OBBranchAndFinancialInstitutionIdentification6



SchemeName

0..1

OBReadTransaction4/Data/Transaction/DebtorAgent/SchemeName

Name of the identification scheme, in a coded form as published in an external list.

OBExternalFinancialInstitutionIdentification4Code



Identification

0..1

OBReadTransaction4/Data/Transaction/DebtorAgent/Identification

Unique and unambiguous identification of a financial institution or a branch of a financial institution.

Max35Text



Name

0..1

OBReadTransaction4/Data/Transaction/DebtorAgent/Name

Name by which an agent is known and which is usually used to identify that agent.

Max140Text



PostalAddress

0..1

OBReadTransaction4/Data/Transaction/DebtorAgent/PostalAddress

Information that locates and identifies a specific address, as defined by postal services.

OBPostalAddress6



AddressType

0..1

OBReadTransaction4/Data/Transaction/DebtorAgent/PostalAddress/AddressType

Identifies the nature of the postal address.

OBAddressTypeCode

Business

Correspondence

DeliveryTo

MailTo

POBox

Postal

Residential

Statement


Department

0..1

OBReadTransaction4/Data/Transaction/DebtorAgent/PostalAddress/Department

Identification of a division of a large organisation or building.

Max70Text



SubDepartment

0..1

OBReadTransaction4/Data/Transaction/DebtorAgent/PostalAddress/SubDepartment

Identification of a sub-division of a large organisation or building.

Max70Text



StreetName

0..1

OBReadTransaction4/Data/Transaction/DebtorAgent/PostalAddress/StreetName

Name of a street or thoroughfare.

Max70Text



BuildingNumber

0..1

OBReadTransaction4/Data/Transaction/DebtorAgent/PostalAddress/BuildingNumber

Number that identifies the position of a building on a street.

Max16Text



PostCode

0..1

OBReadTransaction4/Data/Transaction/DebtorAgent/PostalAddress/PostCode

Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.

Max16Text



TownName

0..1

OBReadTransaction4/Data/Transaction/DebtorAgent/PostalAddress/TownName

Name of a built-up area, with defined boundaries, and a local government.

Max35Text



CountrySubDivision

0..1

OBReadTransaction4/Data/Transaction/DebtorAgent/PostalAddress/CountrySubDivision

Identifies a subdivision of a country such as state, region, county.

Max35Text



Country

0..1

OBReadTransaction4/Data/Transaction/DebtorAgent/PostalAddress/Country

Nation with its own government.

CountryCode


^[A-Z]{2,2}$

AddressLine

0..7

OBReadTransaction4/Data/Transaction/DebtorAgent/PostalAddress/AddressLine

Information that locates and identifies a specific address, as defined by postal services, presented in free format text.

Max70Text



DebtorAccount

0..1

OBReadTransaction4/Data/Transaction/DebtorAccount

Unambiguous identification of the account of the debtor, in the case of a credit transaction.

OBCashAccount6



SchemeName

0..1

OBReadTransaction4/Data/Transaction/DebtorAccount/SchemeName

Name of the identification scheme, in a coded form as published in an external list.

OBExternalAccountIdentification4Code



Identification

0..1

OBReadTransaction4/Data/Transaction/DebtorAccount/Identification

Identification assigned by an institution to identify an account. This identification is known by the account owner.

Max256Text



Name

0..1

OBReadTransaction4/Data/Transaction/DebtorAccount/Name

Name of the account, as assigned by the account servicing institution.


Usage: 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.

Max70Text



SecondaryIdentification

0..1

OBReadTransaction4/Data/Transaction/DebtorAccount/SecondaryIdentification

This is secondary identification of the account, as assigned by the account servicing institution.

This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination).

Max34Text



CardInstrument

0..1

OBReadTransaction4/Data/Transaction/CardInstrument

Set of elements to describe the card instrument used in the transaction.

OBTransactionCardInstrument1



CardSchemeName

1..1

OBReadTransaction4/Data/Transaction/CardInstrument/CardSchemeName

Name of the card scheme.

OBExternalCardSchemeType1Code

AmericanExpress

Diners

Discover

MasterCard

VISA


AuthorisationType

0..1

OBReadTransaction4/Data/Transaction/CardInstrument/AuthorisationType

The card authorisation type.

OBExternalCardAuthorisationType1Code

ConsumerDevice

Contactless

None

PIN


Name

0..1

OBReadTransaction4/Data/Transaction/CardInstrument/Name

Name of the cardholder using the card instrument.

Max70Text



Identification

0..1

OBReadTransaction4/Data/Transaction/CardInstrument/Identification

Identification assigned by an institution to identify the card instrument used in the transaction. This identification is known by the account owner, and may be masked.

Max34Text



SupplementaryData

0..1

OBReadTransaction4/Data/Transaction/SupplementaryData

Additional information that can not be captured in the structured fields and/or any other specific block.

OBSupplementaryData1



Direct Debits - Data Dictionary

Name
Occurrence
XPath
EnhancedDefinition
Class
Codes
Pattern

OBReadDirectDebit1


OBReadDirectDebit1


OBReadDirectDebit1



Data

1..1

OBReadDirectDebit1/Data


OBReadDataDirectDebit1



DirectDebit

0..n

OBReadDirectDebit1/Data/DirectDebit

Account to or from which a cash entry is made.

OBDirectDebit1



AccountId

1..1

OBReadDirectDebit1/Data/DirectDebit/AccountId

A unique and immutable identifier used to identify the account resource. This identifier has no meaning to the account owner.

Max40Text



DirectDebitId

0..1

OBReadDirectDebit1/Data/DirectDebit/DirectDebitId

A unique and immutable identifier used to identify the direct debit resource. This identifier has no meaning to the account owner.

Max40Text



MandateIdentification

1..1

OBReadDirectDebit1/Data/DirectDebit/MandateIdentification

Direct Debit reference. For AUDDIS service users provide Core Reference. For non AUDDIS service users provide Core reference if possible or last used reference.

Max35Text



DirectDebitStatusCode

0..1

OBReadDirectDebit1/Data/DirectDebit/DirectDebitStatusCode

Specifies the status of the direct debit in code form.

OBExternalDirectDebitStatus1Code

Active

Inactive


Name

1..1

OBReadDirectDebit1/Data/DirectDebit/Name

Name of Service User.

Max70Text



PreviousPaymentDateTime

0..1

OBReadDirectDebit1/Data/DirectDebit/PreviousPaymentDateTime

Date of most recent direct debit collection.

ISODateTime



PreviousPaymentAmount

0..1

OBReadDirectDebit1/Data/DirectDebit/PreviousPaymentAmount

The amount of the most recent direct debit collection.

OBActiveOrHistoricCurrencyAndAmount



Amount

1..1

OBReadDirectDebit1/Data/DirectDebit/PreviousPaymentAmount/Amount

A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.

OBActiveCurrencyAndAmount_SimpleType


^\d{1,13}\.\d{1,5}$

Currency

1..1

OBReadDirectDebit1/Data/DirectDebit/PreviousPaymentAmount/Currency

A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".

ActiveOrHistoricCurrencyCode


^[A-Z]{3,3}$

Standing Orders - Data Dictionary

Name
Occurrence
XPath
EnhancedDefinition
Class
Codes
Pattern

OBReadStandingOrder4


OBReadStandingOrder4


OBReadStandingOrder4



Data

1..1

OBReadStandingOrder4/Data


OBReadDataStandingOrder4



StandingOrder

0..n

OBReadStandingOrder4/Data/StandingOrder


OBStandingOrder4



AccountId

1..1

OBReadStandingOrder4/Data/StandingOrder/AccountId

A unique and immutable identifier used to identify the account resource. This identifier has no meaning to the account owner.

Max40Text



StandingOrderId

0..1

OBReadStandingOrder4/Data/StandingOrder/StandingOrderId

A unique and immutable identifier used to identify the standing order resource. This identifier has no meaning to the account owner.

Max40Text



Frequency

1..1

OBReadStandingOrder4/Data/StandingOrder/Frequency

Individual Definitions:

EvryDay - Every day

EvryWorkgDay - Every working day

IntrvlWkDay - An interval specified in weeks (01 to 09) (01 to 02), and the day within the week (01 to 07)

WkInMnthDay - A monthly interval, specifying the week of the month (01 to 05) and day within the week (01 to 07)

IntrvlMnthDay - An interval specified in months (between 01 to 06, 12, 24) (between 01 to 03, 06, 12), specifying the day within the month (-5 to -1, 1 to 31) (-1, 1 to 31)

QtrDay - Quarterly (either ENGLISH, SCOTTISH, or RECEIVED).

ENGLISH = Paid on the 25th March, 24th June, 29th September and 25th December.

SCOTTISH = Paid on the 2nd February, 15th May, 1st August and 11th November.

RECEIVED = Paid on the 20th March, 19th June, 24th September and 20th December.


Individual Patterns:

EvryDay (ScheduleCode)

EvryWorkgDay (ScheduleCode)

IntrvlWkDay:IntervalInWeeks:DayInWeek (ScheduleCode + IntervalInWeeks + DayInWeek)

WkInMnthDay:WeekInMonth:DayInWeek (ScheduleCode + WeekInMonth + DayInWeek)

IntrvlMnthDay:IntervalInMonths:DayInMonth (ScheduleCode + IntervalInMonths + DayInMonth)

QtrDay: + either (ENGLISH, SCOTTISH or RECEIVED) ScheduleCode + QuarterDay


The regular expression for this element combines five smaller versions for each permitted pattern. To aid legibility - the components are presented individually here:

EvryDay

EvryWorkgDay

IntrvlWkDay:0[1-9]:0[1-7]

WkInMnthDay:0[1-5]:0[1-7]

WkInMnthDay:0[1-2]:0[1-7]

IntrvlMnthDay:(0[1-6]|12|24):(-0[1-5]|0[1-9]|[12][0-9]|3[01])

IntrvlMnthDay:(0[1-3]|06|12):(-0[1-5]|0[1-9]|[12][0-9]|3[01])

QtrDay:(ENGLISH|SCOTTISH|RECEIVED)


Full Regular Expression:

^(EvryDay)$|^(EvryWorkgDay)$|^(IntrvlWkDay:0[1-9]:0[1-7])$|^(WkInMnthDay:0[1-5]:0[1-7])$|^(IntrvlMnthDay:(0[1-6]|12|24):(-0[1-5]|0[1-9]|[12][0-9]|3[01]))$|^(QtrDay:(ENGLISH|SCOTTISH|RECEIVED))$

^(IntrvlWkDay:0[1-2]:0[1-7])$|^(IntrvlMnthDay:(0[1-3]|06|12):(-01|0[1-9]|[12][0-9]|3[01]))$

Max35Text


^(EvryDay)$|^(EvryWorkgDay)$|^(IntrvlWkDay:0[1-9]:0[1-7])$|^(WkInMnthDay:0[1-5]:0[1-7])$|^(IntrvlMnthDay:(0[1-6]|12|24):(-0[1-5]|0[1-9]|[12][0-9]|3[01]))$|^(QtrDay:(ENGLISH|SCOTTISH|RECEIVED))$

^(IntrvlWkDay:0[1-2]:0[1-7])$|^(IntrvlMnthDay:(0[1-3]|06|12):(-01|0[1-9]|[12][0-9]|3[01]))$

Reference

0..1

OBReadStandingOrder4/Data/StandingOrder/Reference

Unique reference, as assigned by the creditor, to unambiguously refer to the payment transaction.


Usage: If available, the initiating party should provide this reference in the structured remittance information, to enable reconciliation by the creditor upon receipt of the amount of money.


If the business context requires the use of a creditor reference or a payment remit identification, and only one identifier can be passed through the end-to-end chain, the creditor's reference or payment remittance identification should be quoted in the end-to-end transaction identification.

Max35Text



FirstPaymentDateTime

0..1

OBReadStandingOrder4/Data/StandingOrder/FirstPaymentDateTime

The date on which the first payment for a Standing Order schedule will be made.

ISODateTime



NextPaymentDateTime

0..1

OBReadStandingOrder4/Data/StandingOrder/NextPaymentDateTime

The date on which the next payment for a Standing Order schedule will be made.

ISODateTime



FinalPaymentDateTime

0..1

OBReadStandingOrder4/Data/StandingOrder/FinalPaymentDateTime

The date on which the final payment for a Standing Order schedule will be made.

ISODateTime



StandingOrderStatusCode

0..1

OBReadStandingOrder4/Data/StandingOrder/StandingOrderStatusCode

Specifies the status of the standing order in code form.

OBExternalStandingOrderStatus1Code

Active

Inactive


FirstPaymentAmount

0..1

OBReadStandingOrder4/Data/StandingOrder/FirstPaymentAmount

The amount of the first Standing Order

OBActiveOrHistoricCurrencyAndAmount



Amount

1..1

OBReadStandingOrder4/Data/StandingOrder/FirstPaymentAmount/Amount

A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.

OBActiveCurrencyAndAmount_SimpleType


^\d{1,13}\.\d{1,5}$

Currency

1..1

OBReadStandingOrder4/Data/StandingOrder/FirstPaymentAmount/Currency

A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".

ActiveOrHistoricCurrencyCode


^[A-Z]{3,3}$

NextPaymentAmount

0..1

OBReadStandingOrder4/Data/StandingOrder/NextPaymentAmount

The amount of the next Standing Order.

OBActiveOrHistoricCurrencyAndAmount



Amount

1..1

OBReadStandingOrder4/Data/StandingOrder/NextPaymentAmount/Amount

A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.

OBActiveCurrencyAndAmount_SimpleType


^\d{1,13}\.\d{1,5}$

Currency

1..1

OBReadStandingOrder4/Data/StandingOrder/NextPaymentAmount/Currency

A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".

ActiveOrHistoricCurrencyCode


^[A-Z]{3,3}$

FinalPaymentAmount

0..1

OBReadStandingOrder4/Data/StandingOrder/FinalPaymentAmount

The amount of the final Standing Order

OBActiveOrHistoricCurrencyAndAmount



Amount

1..1

OBReadStandingOrder4/Data/StandingOrder/FinalPaymentAmount/Amount

A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.

OBActiveCurrencyAndAmount_SimpleType


^\d{1,13}\.\d{1,5}$

Currency

1..1

OBReadStandingOrder4/Data/StandingOrder/FinalPaymentAmount/Currency

A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".

ActiveOrHistoricCurrencyCode


^[A-Z]{3,3}$

CreditorAgent

0..1

OBReadStandingOrder4/Data/StandingOrder/CreditorAgent

Party that manages the account on behalf of the account owner, that is manages the registration and booking of entries on the account, calculates balances on the account and provides information about the account.

This is the servicer of the beneficiary account.

OBBranchAndFinancialInstitutionIdentification5



SchemeName

1..1

OBReadStandingOrder4/Data/StandingOrder/CreditorAgent/SchemeName

Name of the identification scheme, in a coded form as published in an external list.

OBExternalFinancialInstitutionIdentification4Code



Identification

1..1

OBReadStandingOrder4/Data/StandingOrder/CreditorAgent/Identification

Unique and unambiguous identification of the servicing institution.

Max35Text



CreditorAccount

0..1

OBReadStandingOrder4/Data/StandingOrder/CreditorAccount

Provides the details to identify the beneficiary account.

OBCashAccount5



SchemeName

1..1

OBReadStandingOrder4/Data/StandingOrder/CreditorAccount/SchemeName

Name of the identification scheme, in a coded form as published in an external list.

OBExternalAccountIdentification4Code



Identification

1..1

OBReadStandingOrder4/Data/StandingOrder/CreditorAccount/Identification

Beneficiary account identification.

Max256Text



Name

0..1

OBReadStandingOrder4/Data/StandingOrder/CreditorAccount/Name

Name of the account, as assigned by the account servicing institution.


Usage: 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.

Max70Text



SecondaryIdentification

0..1

OBReadStandingOrder4/Data/StandingOrder/CreditorAccount/SecondaryIdentification

This is secondary identification of the account, as assigned by the account servicing institution.

This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination).

Max34Text



SupplementaryData

0..1

OBReadStandingOrder4/Data/StandingOrder/SupplementaryData

Additional information that can not be captured in the structured fields and/or any other specific block.

OBSupplementaryData1



Payment Initiation API

Swagger version3.1
Base URI

https://api.adambank.com:8446/open-banking/v3.1/pisp/

General variances to specificationFile Payments APIs are not implemented, but Adam & Co. plans to support these as of November 17th 2019
Non-functional limitationsGlobal as well as individual TPP rate limiting will be applied for API calls in production and in sandbox.

List of endpoints


Resource
Endpoint
Available (Y/N)
Mandatory?
1domestic-payment-consents

POST /domestic-payment-consents

Y

Mandatory

2domestic-payment-consents

GET /domestic-payment-consents/{ConsentId}

Y

Mandatory

3domestic-payment-consents

GET /domestic-payment-consents/{ConsentId}/funds-confirmation

Y

Mandatory

4domestic-payments

POST /domestic-payments

Y

Mandatory

5domestic-paymentsGET /domestic-payments/{DomesticPaymentId}YMandatory
6domestic-scheduled-payment-consentsPOST /domestic-scheduled-payment-consentsYConditional
7domestic-scheduled-payment-consentsGET /domestic-scheduled-payment-consents/{ConsentId}YMandatory (if resource POST implemented)
8domestic-scheduled-paymentsPOST /domestic-scheduled-paymentsYConditional
9domestic-scheduled-paymentsGET /domestic-scheduled-payments/{DomesticScheduledPaymentId}YMandatory (if resource POST implemented)
10domestic-standing-order-consentsPOST /domestic-standing-order-consentsYConditional
11domestic-standing-order-consentsGET /domestic-standing-order-consents/{ConsentId}YMandatory (if resource POST implemented)
12domestic-standing-ordersPOST /domestic-standing-ordersYConditional
13domestic-standing-ordersGET /domestic-standing-orders/{DomesticStandingOrderId}YMandatory (if resource POST implemented)
14international-payment-consentsPOST /international-payment-consentsYConditional
15international-payment-consentsGET /international-payment-consents/{ConsentId}YMandatory (if resource POST implemented)
16international-payment-consentsGET /international-payment-consents/{ConsentId}/funds-confirmationYMandatory (if resource POST implemented)
17international-paymentsPOST /international-paymentsYConditional
18international-paymentsGET /international-payments/{InternationalPaymentId}YMandatory (if resource POST implemented)
19international-scheduled-payment-consentsPOST /international-scheduled-payment-consentsYConditional
20international-scheduled-payment-consentsGET /international-scheduled-payment-consents/{ConsentId}YMandatory (if resource POST implemented)
21international-scheduled-payment-consentsGET /international-scheduled-payment-consents/{ConsentId}/funds-confirmationYMandatory (if immediate debit supported)
22international-scheduled-paymentsPOST /international-scheduled-paymentsYConditional
23international-scheduled-paymentsGET /international-scheduled-payments/{InternationalScheduledPaymentId}YMandatory (if resource POST implemented)
24international-standing-order-consentsPOST /international-standing-order-consentsYConditional
25international-standing-order-consentsGET /international-standing-order-consents/{ConsentId}YMandatory (if resource POST implemented)
26international-standing-ordersPOST /international-standing-ordersYConditional
27international-standing-ordersGET /international-standing-orders/{InternationalStandingOrderPaymentId}YMandatory (if resource POST implemented)
28file-payment-consentsPOST /file-payment-consentsNConditional
29file-payment-consentsPOST /file-payment-consents/{ConsentId}/fileNConditional
30file-payment-consentsGET /file-payment-consents/{ConsentId}NMandatory (if resource POST implemented)
31file-payment-consentsGET /file-payment-consents/{ConsentId}/fileNConditional
32file-paymentsPOST /file-paymentsNConditional
33file-paymentsGET /file-payments/{FilePaymentId}NMandatory (if resource POST implemented)
34file-paymentsGET /file-payments/{FilePaymentId}/report-fileNConditional

Fields information

The information struck through are not valid for the current implementation, see the red text for the implementation differences/details.

Domestic Payment Data Dictionary

Name
Occurrence
XPath
EnhancedDefinition
Class
Codes
Pattern

OBDomestic2


OBDomestic2

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.

OBDomestic2



InstructionIdentification

1..1

OBDomestic2/InstructionIdentification

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.

Max35Text



EndToEndIdentification

1..1

OBDomestic2/EndToEndIdentification

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.

Max35Text



LocalInstrument

0..1

OBDomestic2/LocalInstrument

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.

OBExternalLocalInstrument1Code



InstructedAmount

1..1

OBDomestic2/InstructedAmount

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.

OBActiveOrHistoricCurrencyAndAmount



Amount

1..1

OBDomestic2/InstructedAmount/Amount

A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.

Only up to two decimal places are supported.

OBActiveCurrencyAndAmount_SimpleType


^\d{1,13}\.\d{1,5}$

^\d{1,13}\.\d{1,2}$

Currency

1..1

OBDomestic2/InstructedAmount/Currency

A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".

Only GBP is supported.

ActiveOrHistoricCurrencyCode


^[A-Z]{3,3}$

GBP

DebtorAccount

0..1

OBDomestic2/DebtorAccount

Unambiguous identification of the account of the debtor to which a debit entry will be made as a result of the transaction.

OBCashAccountDebtor4



SchemeName

1..1

OBDomestic2/DebtorAccount/SchemeName

Name of the identification scheme, in a coded form as published in an external list.

OBExternalAccountIdentification4Code

SortCodeAccountNumber 

UK.OBIE.SortCodeAccountNumber

IBAN

UK.OBIE.IBAN


Identification

1..1

OBDomestic2/DebtorAccount/Identification

Identification assigned by an institution to identify an account. This identification is known by the account owner.

Max256Text



Name

0..1

OBDomestic2/DebtorAccount/Name

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.

Max70Text



SecondaryIdentification

0..1

OBDomestic2/DebtorAccount/SecondaryIdentification

This is secondary identification of the account, as assigned by the account servicing institution.

This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination).

Max34Text



CreditorAccount

1..1

OBDomestic2/CreditorAccount

Unambiguous identification of the account of the creditor to which a credit entry will be posted as a result of the payment transaction.

OBCashAccountCreditor3



SchemeName

1..1

OBDomestic2/CreditorAccount/SchemeName

Name of the identification scheme, in a coded form as published in an external list.

OBExternalAccountIdentification4Code

SortCodeAccountNumber (UK only)

UK.OBIE.SortCodeAccountNumber (UK only)

IBAN

UK.OBIE.IBAN


Identification

1..1

OBDomestic2/CreditorAccount/Identification

Identification assigned by an institution to identify an account. This identification is known by the account owner.

Max256Text



Name

1..1

OBDomestic2/CreditorAccount/Name

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.

OB: ASPSPs may carry out name validation for Confirmation of Payee, but it is not mandatory.

Max70Text



SecondaryIdentification

0..1

OBDomestic2/CreditorAccount/SecondaryIdentification

This is secondary identification of the account, as assigned by the account servicing institution.

This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination).

Max34Text



CreditorPostalAddress

0..1

OBDomestic2/CreditorPostalAddress

Information that locates and identifies a specific address, as defined by postal services.

OBPostalAddress6



AddressType

0..1

OBDomestic2/CreditorPostalAddress/AddressType

Identifies the nature of the postal address.

OBAddressTypeCode

Business

Correspondence

DeliveryTo

MailTo

POBox

Postal

Residential

Statement


Department

0..1

OBDomestic2/CreditorPostalAddress/Department

Identification of a division of a large organisation or building.

Max70Text



SubDepartment

0..1

OBDomestic2/CreditorPostalAddress/SubDepartment

Identification of a sub-division of a large organisation or building.

Max70Text



StreetName

0..1

OBDomestic2/CreditorPostalAddress/StreetName

Name of a street or thoroughfare.

Max70Text



BuildingNumber

0..1

OBDomestic2/CreditorPostalAddress/BuildingNumber

Number that identifies the position of a building on a street.

Max16Text



PostCode

0..1

OBDomestic2/CreditorPostalAddress/PostCode

Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.

Max16Text



TownName

0..1

OBDomestic2/CreditorPostalAddress/TownName

Name of a built-up area, with defined boundaries, and a local government.

Max35Text



CountrySubDivision

0..1

OBDomestic2/CreditorPostalAddress/CountrySubDivision

Identifies a subdivision of a country such as state, region, county.

Max35Text



Country

0..1

OBDomestic2/CreditorPostalAddress/Country

Nation with its own government.

CountryCode


^[A-Z]{2,2}$

AddressLine

0..7

OBDomestic2/CreditorPostalAddress/AddressLine

Information that locates and identifies a specific address, as defined by postal services, presented in free format text.

Max70Text



RemittanceInformation

0..1

OBDomestic2/RemittanceInformation

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' receivable system.

OBRemittanceInformation1



Unstructured

0..1

OBDomestic2/RemittanceInformation/Unstructured

Information supplied to enable the matching/reconciliation of an entry with the items that the payment is intended to settle, such as commercial invoices in an accounts' receivable system, in an unstructured form.

Max140Text



Reference

0..1

OBDomestic2/RemittanceInformation/Reference

Unique reference, as assigned by the creditor, to unambiguously refer to the payment transaction.


Usage: If available, the initiating party should provide this reference in the structured remittance information, to enable reconciliation by the creditor upon receipt of the amount of money.


If the business context requires the use of a creditor reference or a payment remit identification, and only one identifier can be passed through the end-to-end chain, the creditor's reference or payment remittance identification should be quoted in the end-to-end transaction identification.

OB: The Faster Payments Scheme can only accept 18 characters for the ReferenceInformation field - which is where this ISO field will be mapped.

Max35Text



SupplementaryData

0..1

OBDomestic2/SupplementaryData

Additional information that can not be captured in the structured fields and/or any other specific block.

OBSupplementaryData1



Domestic Scheduled Payment Data Dictionary

Name
Occurrence
XPath
EnhancedDefinition
Class
Codes
Pattern

OBDomesticScheduled2


OBDomesticScheduled2

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 scheduled domestic payment.

OBDomesticScheduled2



InstructionIdentification

1..1

OBDomesticScheduled2/InstructionIdentification

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.

Max35Text



EndToEndIdentification

0..1

OBDomesticScheduled2/EndToEndIdentification

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.

Max35Text



LocalInstrument

0..1

OBDomesticScheduled2/LocalInstrument

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.

OBExternalLocalInstrument1Code



RequestedExecutionDateTime

1..1

OBDomesticScheduled2/RequestedExecutionDateTime

Date at which the initiating party requests the clearing agent to process the payment.

Usage: This is the date on which the debtor's account is to be debited.

ISODateTime



InstructedAmount

1..1

OBDomesticScheduled2/InstructedAmount

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.

OBActiveOrHistoricCurrencyAndAmount



Amount

1..1

OBDomesticScheduled2/InstructedAmount/Amount

A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.

Only up to two decimal places are supported.

OBActiveCurrencyAndAmount_SimpleType


^\d{1,13}\.\d{1,5}$

^\d{1,13}\.\d{1,2}$

Currency

1..1

OBDomesticScheduled2/InstructedAmount/Currency

A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".

Only GBP is supported.

ActiveOrHistoricCurrencyCode


^[A-Z]{3,3}$

GBP

DebtorAccount

0..1

OBDomesticScheduled2/DebtorAccount

Unambiguous identification of the account of the debtor to which a debit entry will be made as a result of the transaction.

OBCashAccountDebtor4



SchemeName

1..1

OBDomesticScheduled2/DebtorAccount/SchemeName

Name of the identification scheme, in a coded form as published in an external list.

OBExternalAccountIdentification4Code

SortCodeAccountNumber

UK.OBIE.SortCodeAccountNumber

IBAN

UK.OBIE.IBAN


Identification

1..1

OBDomesticScheduled2/DebtorAccount/Identification

Identification assigned by an institution to identify an account. This identification is known by the account owner.

Max256Text



Name

0..1

OBDomesticScheduled2/DebtorAccount/Name

Name of the account, as assigned by the account servicing institution.


Usage: 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.

Max70Text



SecondaryIdentification

0..1

OBDomesticScheduled2/DebtorAccount/SecondaryIdentification

This is secondary identification of the account, as assigned by the account servicing institution.

This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination).

Max34Text



CreditorAccount

1..1

OBDomesticScheduled2/CreditorAccount

Unambiguous identification of the account of the creditor to which a credit entry will be posted as a result of the payment transaction.

OBCashAccountCreditor3



SchemeName

1..1

OBDomesticScheduled2/CreditorAccount/SchemeName

Name of the identification scheme, in a coded form as published in an external list.

OBExternalAccountIdentification4Code

SortCodeAccountNumber (UK only)

UK.OBIE.SortCodeAccountNumber (UK only)

IBAN

UK.OBIE.IBAN


Identification

1..1

OBDomesticScheduled2/CreditorAccount/Identification

Identification assigned by an institution to identify an account. This identification is known by the account owner.

Max256Text



Name

1..1

OBDomesticScheduled2/CreditorAccount/Name

Name of the account, as assigned by the account servicing institution.


Usage: 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.

OB: ASPSPs may carry out name validation for Confirmation of Payee, but it is not mandatory.

Max70Text



SecondaryIdentification

0..1

OBDomesticScheduled2/CreditorAccount/SecondaryIdentification

This is secondary identification of the account, as assigned by the account servicing institution.

This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination).

Max34Text



CreditorPostalAddress

0..1

OBDomesticScheduled2/CreditorPostalAddress

Information that locates and identifies a specific address, as defined by postal services.

OBPostalAddress6



AddressType

0..1

OBDomesticScheduled2/CreditorPostalAddress/AddressType

Identifies the nature of the postal address.

OBAddressTypeCode

Business

Correspondence

DeliveryTo

MailTo

POBox

Postal

Residential

Statement


Department

0..1

OBDomesticScheduled2/CreditorPostalAddress/Department

Identification of a division of a large organisation or building.

Max70Text



SubDepartment

0..1

OBDomesticScheduled2/CreditorPostalAddress/SubDepartment

Identification of a sub-division of a large organisation or building.

Max70Text



StreetName

0..1

OBDomesticScheduled2/CreditorPostalAddress/StreetName

Name of a street or thoroughfare.

Max70Text



BuildingNumber

0..1

OBDomesticScheduled2/CreditorPostalAddress/BuildingNumber

Number that identifies the position of a building on a street.

Max16Text



PostCode

0..1

OBDomesticScheduled2/CreditorPostalAddress/PostCode

Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.

Max16Text



TownName

0..1

OBDomesticScheduled2/CreditorPostalAddress/TownName

Name of a built-up area, with defined boundaries, and a local government.

Max35Text



CountrySubDivision

0..1

OBDomesticScheduled2/CreditorPostalAddress/CountrySubDivision

Identifies a subdivision of a country such as state, region, county.

Max35Text



Country

0..1

OBDomesticScheduled2/CreditorPostalAddress/Country

Nation with its own government.

CountryCode


^[A-Z]{2,2}$

AddressLine

0..7

OBDomesticScheduled2/CreditorPostalAddress/AddressLine

Information that locates and identifies a specific address, as defined by postal services, presented in free format text.

Max70Text



RemittanceInformation

0..1

OBDomesticScheduled2/RemittanceInformation

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' receivable system.

OBRemittanceInformation1



Unstructured

0..1

OBDomesticScheduled2/RemittanceInformation/Unstructured

Information supplied to enable the matching/reconciliation of an entry with the items that the payment is intended to settle, such as commercial invoices in an accounts' receivable system, in an unstructured form.

Max140Text



Reference

0..1

OBDomesticScheduled2/RemittanceInformation/Reference

Unique reference, as assigned by the creditor, to unambiguously refer to the payment transaction.


Usage: If available, the initiating party should provide this reference in the structured remittance information, to enable reconciliation by the creditor upon receipt of the amount of money.


If the business context requires the use of a creditor reference or a payment remit identification, and only one identifier can be passed through the end-to-end chain, the creditor's reference or payment remittance identification should be quoted in the end-to-end transaction identification.

OB: The Faster Payments Scheme can only accept 18 characters for the ReferenceInformation field - which is where this ISO field will be mapped.

Max35Text



SupplementaryData

0..1

OBDomesticScheduled2/SupplementaryData

Additional information that can not be captured in the structured fields and/or any other specific block.

OBSupplementaryData1



Domestic Standing Orders Data Dictionary

Name
Occurrence
XPath
EnhancedDefinition
Class
Codes
Pattern

OBDomesticStandingOrder2


OBDomesticStandingOrder2

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 domestic standing order.

OBDomesticStandingOrder2



Frequency

1..1

OBDomesticStandingOrder2/Frequency

Individual Definitions:

EvryDay - Every day

EvryWorkgDay - Every working day

IntrvlWkDay - An interval specified in weeks (01 to 09) (01 to 02), and the day within the week (01 to 07)

WkInMnthDay - A monthly interval, specifying the week of the month (01 to 05) and day within the week (01 to 07)

IntrvlMnthDay - An interval specified in months (between 01 to 06, 12, 24) (between 01 to 03, 06, 12), specifying the day within the month (-5 to -1, 1 to 31) (-1, 1 to 31)

QtrDay - Quarterly (either ENGLISH, SCOTTISH, or RECEIVED).

ENGLISH = Paid on the 25th March, 24th June, 29th September and 25th December.

SCOTTISH = Paid on the 2nd February, 15th May, 1st August and 11th November.

RECEIVED = Paid on the 20th March, 19th June, 24th September and 20th December.


Individual Patterns:

EvryDay (ScheduleCode)

EvryWorkgDay (ScheduleCode)

IntrvlWkDay:IntervalInWeeks:DayInWeek (ScheduleCode + IntervalInWeeks + DayInWeek)

WkInMnthDay:WeekInMonth:DayInWeek (ScheduleCode + WeekInMonth + DayInWeek)

IntrvlMnthDay:IntervalInMonths:DayInMonth (ScheduleCode + IntervalInMonths + DayInMonth)

QtrDay: + either (ENGLISH, SCOTTISH or RECEIVED) ScheduleCode + QuarterDay


The regular expression for this element combines five smaller versions for each permitted pattern. To aid legibility - the components are presented individually here:

EvryDay

EvryWorkgDay

IntrvlWkDay:0[1-9]:0[1-7]

WkInMnthDay:0[1-5]:0[1-7]

WkInMnthDay:0[1-2]:0[1-7]

IntrvlMnthDay:(0[1-6]|12|24):(-0[1-5]|0[1-9]|[12][0-9]|3[01])

IntrvlMnthDay:(0[1-3]|06|12):(-0[1-5]|0[1-9]|[12][0-9]|3[01])

QtrDay:(ENGLISH|SCOTTISH|RECEIVED)


Full Regular Expression:

^(EvryDay)$|^(EvryWorkgDay)$|^(IntrvlWkDay:0[1-9]:0[1-7])$|^(WkInMnthDay:0[1-5]:0[1-7])$|^(IntrvlMnthDay:(0[1-6]|12|24):(-0[1-5]|0[1-9]|[12][0-9]|3[01]))$|^(QtrDay:(ENGLISH|SCOTTISH|RECEIVED))$

^(IntrvlWkDay:0[1-2]:0[1-7])$|^(IntrvlMnthDay:(0[1-3]|06|12):(-01|0[1-9]|[12][0-9]|3[01]))$

Max35Text


^(EvryDay)$|^(EvryWorkgDay)$|^(IntrvlWkDay:0[1-9]:0[1-7])$|^(WkInMnthDay:0[1-5]:0[1-7])$|^(IntrvlMnthDay:(0[1-6]|12|24):(-0[1-5]|0[1-9]|[12][0-9]|3[01]))$|^(QtrDay:(ENGLISH|SCOTTISH|RECEIVED))$

^(IntrvlWkDay:0[1-2]:0[1-7])$|^(IntrvlMnthDay:(0[1-3]|06|12):(-01|0[1-9]|[12][0-9]|3[01]))$

Reference

0..1

OBDomesticStandingOrder2/Reference

Unique reference, as assigned by the creditor, to unambiguously refer to the payment transaction.


Usage: If available, the initiating party should provide this reference in the structured remittance information, to enable reconciliation by the creditor upon receipt of the amount of money.


If the business context requires the use of a creditor reference or a payment remit identification, and only one identifier can be passed through the end-to-end chain, the creditor's reference or payment remittance identification should be quoted in the end-to-end transaction identification.

Max35Text



NumberOfPayments

0..1

OBDomesticStandingOrder2/NumberOfPayments

Number of the payments that will be made in completing this frequency sequence including any executed since the sequence start date.

Must be between 1 and 50.

Max35Text



FirstPaymentDateTime

1..1

OBDomesticStandingOrder2/FirstPaymentDateTime

The date on which the first payment for a Standing Order schedule will be made.

Can be up to one year in the future.

If a specific time is given, it will be ignored.

If the FirstPaymentDateTime doesn't match the given frequency, the FirstPaymentDateTime will be set to the next matching one.

Example:

"FirstPaymentDateTime": "2020-11-15T14:00:00+00:00"

"Frequency": "IntrvlMnthDay:01:29"

The first payment date will be the 29th of November.

ISODateTime



RecurringPaymentDateTime

0..1

OBDomesticStandingOrder2/RecurringPaymentDateTime

The date on which the first recurring payment for a Standing Order schedule will be made.

Usage: This must be populated only if the first recurring date is different to the first payment date.

ISODateTime



FinalPaymentDateTime

0..1

OBDomesticStandingOrder2/FinalPaymentDateTime

The date on which the final payment for a Standing Order schedule will be made.

If a specific time is given, it will be ignored, only the date is considered.

Cannot be more than one year in the future.

ISODateTime



FirstPaymentAmount

1..1

OBDomesticStandingOrder2/FirstPaymentAmount

The amount of the first Standing Order

OBActiveOrHistoricCurrencyAndAmount



Amount

1..1

OBDomesticStandingOrder2/FirstPaymentAmount/Amount

A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.

Only up to two decimal places are supported.

OBActiveCurrencyAndAmount_SimpleType


^\d{1,13}\.\d{1,5}$

^\d{1,13}\.\d{1,2}$

Currency

1..1

OBDomesticStandingOrder2/FirstPaymentAmount/Currency

A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".

Only GBP is supported.

ActiveOrHistoricCurrencyCode


^[A-Z]{3,3}$

GBP

RecurringPaymentAmount

0..1

OBDomesticStandingOrder2/RecurringPaymentAmount

The amount of the recurring Standing Order

OBActiveOrHistoricCurrencyAndAmount



Amount

1..1

OBDomesticStandingOrder2/RecurringPaymentAmount/Amount

A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.

OBActiveCurrencyAndAmount_SimpleType


^\d{1,13}\.\d{1,5}$

Currency

1..1

OBDomesticStandingOrder2/RecurringPaymentAmount/Currency

A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".

ActiveOrHistoricCurrencyCode


^[A-Z]{3,3}$

FinalPaymentAmount

0..1

OBDomesticStandingOrder2/FinalPaymentAmount

The amount of the final Standing Order

OBActiveOrHistoricCurrencyAndAmount



Amount

1..1

OBDomesticStandingOrder2/FinalPaymentAmount/Amount

A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.

OBActiveCurrencyAndAmount_SimpleType


^\d{1,13}\.\d{1,5}$

Currency

1..1

OBDomesticStandingOrder2/FinalPaymentAmount/Currency

A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".

ActiveOrHistoricCurrencyCode


^[A-Z]{3,3}$

DebtorAccount

0..1

OBDomesticStandingOrder2/DebtorAccount

Provides the details to identify the debtor account.

OBCashAccountDebtor4



SchemeName

1..1

OBDomesticStandingOrder2/DebtorAccount/SchemeName

Name of the identification scheme, in a coded form as published in an external list.

OBExternalAccountIdentification4Code

SortCodeAccountNumber

UK.OBIE.SortCodeAccountNumber

IBAN

UK.OBIE.IBAN


Identification

1..1

OBDomesticStandingOrder2/DebtorAccount/Identification

Identification assigned by an institution to identify an account. This identification is known by the account owner.

Max256Text



Name

0..1

OBDomesticStandingOrder2/DebtorAccount/Name

Name of the account, as assigned by the account servicing institution.


Usage: 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.

Max70Text



SecondaryIdentification

0..1

OBDomesticStandingOrder2/DebtorAccount/SecondaryIdentification

This is secondary identification of the account, as assigned by the account servicing institution.

This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination).

Max34Text



CreditorAccount

1..1

OBDomesticStandingOrder2/CreditorAccount

Identification assigned by an institution to identify an account. This identification is known by the account owner.

OBBranchAndFinancialInstitutionIdentification6



SchemeName

1..1

OBDomesticStandingOrder2/CreditorAccount/SchemeName

Name of the identification scheme, in a coded form as published in an external list.

OBExternalFinancialInstitutionIdentification4Code

SortCodeAccountNumber (UK only)

UK.OBIE.SortCodeAccountNumber (UK only)

IBAN

UK.OBIE.IBAN


Identification

1..1

OBDomesticStandingOrder2/CreditorAccount/Identification

Identification assigned by an institution to identify an account. This identification is known by the account owner.

Max256Text



Name

1..1

OBDomesticStandingOrder2/CreditorAccount/Name

Name of the account, as assigned by the account servicing institution.


Usage: 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.

OB: ASPSPs may carry out name validation for Confirmation of Payee, but it is not mandatory.

Max70Text



SecondaryIdentification

0..1

OBDomesticStandingOrder2/CreditorAccount/SecondaryIdentification

This is secondary identification of the account, as assigned by the account servicing institution.

This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination).

Max34Text



SupplementaryData

0..1

OBDomesticStandingOrder2/SupplementaryData

Additional information that can not be captured in the structured fields and/or any other specific block.

OBSupplementaryData1



International Payment Data Dictionary

Name
Occurrence
XPath
EnhancedDefinition
Class
Codes
Pattern

OBInternational2


OBInternational2

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 international payment.

OBInternational2



InstructionIdentification

1..1

OBInternational2/InstructionIdentification

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.

Max35Text



EndToEndIdentification

1..1

OBInternational2/EndToEndIdentification

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.

Max35Text



LocalInstrument

0..1

OBInternational2/LocalInstrument

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.

OBExternalLocalInstrument1Code



InstructionPriority

0..1

OBInternational2/InstructionPriority

Indicator of the urgency or order of importance that the instructing party would like the instructed party to apply to the processing of the instruction.

OBPriority2Code

Normal

Urgent


Purpose

0..1

OBInternational2/Purpose

Specifies the external purpose code in the format of character string with a maximum length of 4 characters.

The list of valid codes is an external code list published separately.

External code sets can be downloaded from www.iso20022.org.

OBExternalPurpose1Code1



ChargeBearer

0..1

OBInternational2/ChargeBearer

Specifies which party/parties will bear the charges associated with the processing of the payment transaction.

OBChargeBearerType1Code

BorneByCreditor

BorneByDebtor

FollowingServiceLevel

Shared


CurrencyOfTransfer

1..1

OBInternational2/CurrencyOfTransfer

Specifies the currency of the to be transferred amount, which is different from the currency of the debtor's account.

ActiveOrHistoricCurrencyCode


^[A-Z]{3,3}$

InstructedAmount

1..1

OBInternational2/InstructedAmount

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.

OBActiveOrHistoricCurrencyAndAmount



Amount

1..1

OBInternational2/InstructedAmount/Amount

A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.

Only up to two decimal places are supported.

OBActiveCurrencyAndAmount_SimpleType


^\d{1,13}\.\d{1,5}$

^\d{1,13}\.\d{1,2}$

Currency

1..1

OBInternational2/InstructedAmount/Currency

A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".

ActiveOrHistoricCurrencyCode


^[A-Z]{3,3}$

ExchangeRateInformation

0..1

OBInternational2/ExchangeRateInformation

Provides details on the currency exchange rate and contract.

OBExchangeRate1



UnitCurrency

1..1

OBInternational2/ExchangeRateInformation/UnitCurrency

Currency in which the rate of exchange is expressed in a currency exchange. In the example 1GBP = xxxCUR, the unit currency is GBP.

ActiveOrHistoricCurrencyCode


^[A-Z]{3,3}$

ExchangeRate

0..1

OBInternational2/ExchangeRateInformation/ExchangeRate

The factor used for conversion of an amount from one currency to another. This reflects the price at which one currency was bought with another currency.

BaseOneRate



RateType

1..1

OBInternational2/ExchangeRateInformation/RateType

Specifies the type used to complete the currency exchange.

OBExchangeRateType2Code

Actual

Agreed

Indicative


ContractIdentification

0..1

OBInternational2/ExchangeRateInformation/ContractIdentification

Unique and unambiguous reference to the foreign exchange contract agreed between the initiating party/creditor and the debtor agent.

Max256Text



DebtorAccount

0..1

OBInternational2/DebtorAccount

Unambiguous identification of the account of the debtor to which a debit entry will be made as a result of the transaction.

OBCashAccountDebtor4



SchemeName

1..1

OBInternational2/DebtorAccount/SchemeName

Name of the identification scheme, in a coded form as published in an external list.

OBExternalAccountIdentification4Code

SortCodeAccountNumber

UK.OBIE.SortCodeAccountNumber

IBAN

UK.OBIE.IBAN


Identification

1..1

OBInternational2/DebtorAccount/Identification

Identification assigned by an institution to identify an account. This identification is known by the account owner.

Max256Text



Name

0..1

OBInternational2/DebtorAccount/Name

Name of the account, as assigned by the account servicing institution.


Usage: 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.

Max70Text



SecondaryIdentification

0..1

OBInternational2/DebtorAccount/SecondaryIdentification

This is secondary identification of the account, as assigned by the account servicing institution.

This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination).

Max34Text



Creditor

0..1

OBInternational2/Creditor

Party to which an amount of money is due.

OBPartyIdentification43



Name

0..1

OBInternational2/Creditor/Name

Name by which a party is known and which is usually used to identify that party.

Max140Text



PostalAddress

0..1

OBInternational2/Creditor/PostalAddress

Information that locates and identifies a specific address, as defined by postal services.

OBPostalAddress6



AddressType

0..1

OBInternational2/Creditor/PostalAddress/AddressType

Identifies the nature of the postal address.

OBAddressTypeCode

Business

Correspondence

DeliveryTo

MailTo

POBox

Postal

Residential

Statement


Department

0..1

OBInternational2/Creditor/PostalAddress/Department

Identification of a division of a large organisation or building.

Max70Text



SubDepartment

0..1

OBInternational2/Creditor/PostalAddress/SubDepartment

Identification of a sub-division of a large organisation or building.

Max70Text



StreetName

0..1

OBInternational2/Creditor/PostalAddress/StreetName

Name of a street or thoroughfare.

Max70Text



BuildingNumber

0..1

OBInternational2/Creditor/PostalAddress/BuildingNumber

Number that identifies the position of a building on a street.

Max16Text



PostCode

0..1

OBInternational2/Creditor/PostalAddress/PostCode

Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.

Max16Text



TownName

0..1

OBInternational2/Creditor/PostalAddress/TownName

Name of a built-up area, with defined boundaries, and a local government.

Max35Text



CountrySubDivision

0..1

OBInternational2/Creditor/PostalAddress/CountrySubDivision

Identifies a subdivision of a country such as state, region, county.

Max35Text



Country

0..1

OBInternational2/Creditor/PostalAddress/Country

Nation with its own government.

CountryCode


^[A-Z]{2,2}$

AddressLine

0..7

OBInternational2/Creditor/PostalAddress/AddressLine

Information that locates and identifies a specific address, as defined by postal services, presented in free format text.

Max70Text



CreditorAgent

0..1

OBInternational2/CreditorAgent

Financial institution servicing an account for the creditor.

OBBranchAndFinancialInstitutionIdentification6



SchemeName

0..1

OBInternational2/CreditorAgent/SchemeName

Name of the identification scheme, in a coded form as published in an external list.

OBExternalFinancialInstitutionIdentification4Code



Identification

0..1

OBInternational2/CreditorAgent/Identification

Unique and unambiguous identification of a financial institution or a branch of a financial institution.

Max35Text



Name

0..1

OBInternational2/CreditorAgent/Name

Name by which an agent is known and which is usually used to identify that agent.

Max140Text



PostalAddress

0..1

OBInternational2/CreditorAgent/PostalAddress

Information that locates and identifies a specific address, as defined by postal services.

OBPostalAddress6



AddressType

0..1

OBInternational2/CreditorAgent/PostalAddress/AddressType

Identifies the nature of the postal address.

OBAddressTypeCode

Business

Correspondence

DeliveryTo

MailTo

POBox

Postal

Residential

Statement


Department

0..1

OBInternational2/CreditorAgent/PostalAddress/Department

Identification of a division of a large organisation or building.

Max70Text



SubDepartment

0..1

OBInternational2/CreditorAgent/PostalAddress/SubDepartment

Identification of a sub-division of a large organisation or building.

Max70Text



StreetName

0..1

OBInternational2/CreditorAgent/PostalAddress/StreetName

Name of a street or thoroughfare.

Max70Text



BuildingNumber

0..1

OBInternational2/CreditorAgent/PostalAddress/BuildingNumber

Number that identifies the position of a building on a street.

Max16Text



PostCode

0..1

OBInternational2/CreditorAgent/PostalAddress/PostCode

Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.

Max16Text



TownName

0..1

OBInternational2/CreditorAgent/PostalAddress/TownName

Name of a built-up area, with defined boundaries, and a local government.

Max35Text



CountrySubDivision

0..1

OBInternational2/CreditorAgent/PostalAddress/CountrySubDivision

Identifies a subdivision of a country such as state, region, county.

Max35Text



Country

0..1

OBInternational2/CreditorAgent/PostalAddress/Country

Nation with its own government.

CountryCode


^[A-Z]{2,2}$

AddressLine

0..7

OBInternational2/CreditorAgent/PostalAddress/AddressLine

Information that locates and identifies a specific address, as defined by postal services, presented in free format text.

Max70Text



CreditorAccount

1..1

OBInternational2/CreditorAccount

Unambiguous identification of the account of the creditor to which a credit entry will be posted as a result of the payment transaction.

OBCashAccountCreditor3



SchemeName

1..1

OBInternational2/CreditorAccount/SchemeName

Name of the identification scheme, in a coded form as published in an external list.

OBExternalAccountIdentification4Code

SortCodeAccountNumber (UK only)

UK.OBIE.SortCodeAccountNumber (UK only)

IBAN

UK.OBIE.IBAN


Identification

1..1

OBInternational2/CreditorAccount/Identification

Identification assigned by an institution to identify an account. This identification is known by the account owner.

Max256Text



Name

1..1

OBInternational2/CreditorAccount/Name

Name of the account, as assigned by the account servicing institution.


Usage: 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.

OB: ASPSPs may carry out name validation for Confirmation of Payee, but it is not mandatory.

Max70Text



SecondaryIdentification

0..1

OBInternational2/CreditorAccount/SecondaryIdentification

This is secondary identification of the account, as assigned by the account servicing institution.

This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination).

Max34Text



RemittanceInformation

0..1

OBInternational2/RemittanceInformation

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' receivable system.

OBRemittanceInformation1



Unstructured

0..1

OBInternational2/RemittanceInformation/Unstructured

Information supplied to enable the matching/reconciliation of an entry with the items that the payment is intended to settle, such as commercial invoices in an accounts' receivable system, in an unstructured form.

Max140Text



Reference

0..1

OBInternational2/RemittanceInformation/Reference

Unique reference, as assigned by the creditor, to unambiguously refer to the payment transaction.


Usage: If available, the initiating party should provide this reference in the structured remittance information, to enable reconciliation by the creditor upon receipt of the amount of money.


If the business context requires the use of a creditor reference or a payment remit identification, and only one identifier can be passed through the end-to-end chain, the creditor's reference or payment remittance identification should be quoted in the end-to-end transaction identification.

OB: The Faster Payments Scheme can only accept 18 characters for the ReferenceInformation field - which is where this ISO field will be mapped.

Max35Text



SupplementaryData

0..1

OBInternational2/SupplementaryData

Additional information that can not be captured in the structured fields and/or any other specific block.

OBSupplementaryData1



International Scheduled Payment Data Dictionary

Name
Occurrence
XPath
EnhancedDefinition
Class
Codes
Pattern

OBInternationalScheduled2


OBInternationalScheduled2

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 scheduled international payment.

OBInternationalScheduled2



InstructionIdentification

1..1

OBInternationalScheduled2/InstructionIdentification

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.

Max35Text



EndToEndIdentification

0..1

OBInternationalScheduled2/EndToEndIdentification

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.

Max35Text



LocalInstrument

0..1

OBInternationalScheduled2/LocalInstrument

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.

OBExternalLocalInstrument1Code



InstructionPriority

0..1

OBInternationalScheduled2/InstructionPriority

Indicator of the urgency or order of importance that the instructing party would like the instructed party to apply to the processing of the instruction.

OBPriority2Code

Normal

Urgent


Purpose

0..1

OBInternationalScheduled2/Purpose

Specifies the external purpose code in the format of character string with a maximum length of 4 characters.

The list of valid codes is an external code list published separately.

External code sets can be downloaded from www.iso20022.org.

OBExternalPurpose1Code1



ChargeBearer

0..1

OBInternationalScheduled2/ChargeBearer

Specifies which party/parties will bear the charges associated with the processing of the payment transaction.

OBChargeBearerType1Code

BorneByCreditor

BorneByDebtor

FollowingServiceLevel

Shared


RequestedExecutionDateTime

1..1

OBInternationalScheduled2/RequestedExecutionDateTime

Date at which the initiating party requests the clearing agent to process the payment.

Usage: This is the date on which the debtor's account is to be debited.

ISODateTime



CurrencyOfTransfer

1..1

OBInternationalScheduled2/CurrencyOfTransfer

Specifies the currency of the to be transferred amount, which is different from the currency of the debtor's account.

ActiveOrHistoricCurrencyCode


^[A-Z]{3,3}$

InstructedAmount

1..1

OBInternationalScheduled2/InstructedAmount

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.

OBActiveOrHistoricCurrencyAndAmount



Amount

1..1

OBInternationalScheduled2/InstructedAmount/Amount

A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.

Only up to two decimal places are supported.

OBActiveCurrencyAndAmount_SimpleType


^\d{1,13}\.\d{1,5}$

^\d{1,13}\.\d{1,2}$

Currency

1..1

OBInternationalScheduled2/InstructedAmount/Currency

A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".

ActiveOrHistoricCurrencyCode


^[A-Z]{3,3}$

ExchangeRateInformation

0..1

OBInternationalScheduled2/ExchangeRateInformation

Provides details on the currency exchange rate and contract.

OBExchangeRate1



UnitCurrency

1..1

OBInternationalScheduled2/ExchangeRateInformation/UnitCurrency

Currency in which the rate of exchange is expressed in a currency exchange. In the example 1GBP = xxxCUR, the unit currency is GBP.

ActiveOrHistoricCurrencyCode


^[A-Z]{3,3}$

ExchangeRate

0..1

OBInternationalScheduled2/ExchangeRateInformation/ExchangeRate

The factor used for conversion of an amount from one currency to another. This reflects the price at which one currency was bought with another currency.

BaseOneRate



RateType

1..1

OBInternationalScheduled2/ExchangeRateInformation/RateType

Specifies the type used to complete the currency exchange.

OBExchangeRateType2Code

Actual

Agreed

Indicative


ContractIdentification

0..1

OBInternationalScheduled2/ExchangeRateInformation/ContractIdentification

Unique and unambiguous reference to the foreign exchange contract agreed between the initiating party/creditor and the debtor agent.

Max256Text



DebtorAccount

0..1

OBInternationalScheduled2/DebtorAccount

Unambiguous identification of the account of the debtor to which a debit entry will be made as a result of the transaction.

OBCashAccountDebtor4



SchemeName

1..1

OBInternationalScheduled2/DebtorAccount/SchemeName

Name of the identification scheme, in a coded form as published in an external list.

OBExternalAccountIdentification4Code

SortCodeAccountNumber

UK.OBIE.SortCodeAccountNumber

IBAN

UK.OBIE.IBAN


Identification

1..1

OBInternationalScheduled2/DebtorAccount/Identification

Identification assigned by an institution to identify an account. This identification is known by the account owner.

Max256Text



Name

0..1

OBInternationalScheduled2/DebtorAccount/Name

Name of the account, as assigned by the account servicing institution.


Usage: 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.

Max70Text



SecondaryIdentification

0..1

OBInternationalScheduled2/DebtorAccount/SecondaryIdentification

This is secondary identification of the account, as assigned by the account servicing institution.

This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination).

Max34Text



Creditor

0..1

OBInternationalScheduled2/Creditor

Party to which an amount of money is due.

OBPartyIdentification43



Name

0..1

OBInternationalScheduled2/Creditor/Name

Name by which a party is known and which is usually used to identify that party.

Max140Text



PostalAddress

0..1

OBInternationalScheduled2/Creditor/PostalAddress

Information that locates and identifies a specific address, as defined by postal services.

OBPostalAddress6



AddressType

0..1

OBInternationalScheduled2/Creditor/PostalAddress/AddressType

Identifies the nature of the postal address.

OBAddressTypeCode

Business

Correspondence

DeliveryTo

MailTo

POBox

Postal

Residential

Statement


Department

0..1

OBInternationalScheduled2/Creditor/PostalAddress/Department

Identification of a division of a large organisation or building.

Max70Text



SubDepartment

0..1

OBInternationalScheduled2/Creditor/PostalAddress/SubDepartment

Identification of a sub-division of a large organisation or building.

Max70Text



StreetName

0..1

OBInternationalScheduled2/Creditor/PostalAddress/StreetName

Name of a street or thoroughfare.

Max70Text



BuildingNumber

0..1

OBInternationalScheduled2/Creditor/PostalAddress/BuildingNumber

Number that identifies the position of a building on a street.

Max16Text



PostCode

0..1

OBInternationalScheduled2/Creditor/PostalAddress/PostCode

Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.

Max16Text



TownName

0..1

OBInternationalScheduled2/Creditor/PostalAddress/TownName

Name of a built-up area, with defined boundaries, and a local government.

Max35Text



CountrySubDivision

0..1

OBInternationalScheduled2/Creditor/PostalAddress/CountrySubDivision

Identifies a subdivision of a country such as state, region, county.

Max35Text



Country

0..1

OBInternationalScheduled2/Creditor/PostalAddress/Country

Nation with its own government.

CountryCode


^[A-Z]{2,2}$

AddressLine

0..7

OBInternationalScheduled2/Creditor/PostalAddress/AddressLine

Information that locates and identifies a specific address, as defined by postal services, presented in free format text.

Max70Text



CreditorAgent

0..1

OBInternationalScheduled2/CreditorAgent

Financial institution servicing an account for the creditor.

OBBranchAndFinancialInstitutionIdentification6



SchemeName

0..1

OBInternationalScheduled2/CreditorAgent/SchemeName

Name of the identification scheme, in a coded form as published in an external list.

OBExternalFinancialInstitutionIdentification4Code



Identification

0..1

OBInternationalScheduled2/CreditorAgent/Identification

Unique and unambiguous identification of a financial institution or a branch of a financial institution.

Max35Text



Name

0..1

OBInternationalScheduled2/CreditorAgent/Name

Name by which an agent is known and which is usually used to identify that agent.

Max140Text



PostalAddress

0..1

OBInternationalScheduled2/CreditorAgent/PostalAddress

Information that locates and identifies a specific address, as defined by postal services.

OBPostalAddress6



AddressType

0..1

OBInternationalScheduled2/CreditorAgent/PostalAddress/AddressType

Identifies the nature of the postal address.

OBAddressTypeCode

Business

Correspondence

DeliveryTo

MailTo

POBox

Postal

Residential

Statement


Department

0..1

OBInternationalScheduled2/CreditorAgent/PostalAddress/Department

Identification of a division of a large organisation or building.

Max70Text



SubDepartment

0..1

OBInternationalScheduled2/CreditorAgent/PostalAddress/SubDepartment

Identification of a sub-division of a large organisation or building.

Max70Text



StreetName

0..1

OBInternationalScheduled2/CreditorAgent/PostalAddress/StreetName

Name of a street or thoroughfare.

Max70Text



BuildingNumber

0..1

OBInternationalScheduled2/CreditorAgent/PostalAddress/BuildingNumber

Number that identifies the position of a building on a street.

Max16Text



PostCode

0..1

OBInternationalScheduled2/CreditorAgent/PostalAddress/PostCode

Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.

Max16Text



TownName

0..1

OBInternationalScheduled2/CreditorAgent/PostalAddress/TownName

Name of a built-up area, with defined boundaries, and a local government.

Max35Text



CountrySubDivision

0..1

OBInternationalScheduled2/CreditorAgent/PostalAddress/CountrySubDivision

Identifies a subdivision of a country such as state, region, county.

Max35Text



Country

0..1

OBInternationalScheduled2/CreditorAgent/PostalAddress/Country

Nation with its own government.

CountryCode


^[A-Z]{2,2}$

AddressLine

0..7

OBInternationalScheduled2/CreditorAgent/PostalAddress/AddressLine

Information that locates and identifies a specific address, as defined by postal services, presented in free format text.

Max70Text



CreditorAccount

1..1

OBInternationalScheduled2/CreditorAccount

Unambiguous identification of the account of the creditor to which a credit entry will be posted as a result of the payment transaction.

OBCashAccountCreditor3



SchemeName

1..1

OBInternationalScheduled2/CreditorAccount/SchemeName

Name of the identification scheme, in a coded form as published in an external list.

OBExternalAccountIdentification4Code



Identification

1..1

OBInternationalScheduled2/CreditorAccount/Identification

Identification assigned by an institution to identify an account. This identification is known by the account owner.

Max256Text



Name

1..1

OBInternationalScheduled2/CreditorAccount/Name

Name of the account, as assigned by the account servicing institution.


Usage: 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.

OB: ASPSPs may carry out name validation for Confirmation of Payee, but it is not mandatory.

Max70Text



SecondaryIdentification

0..1

OBInternationalScheduled2/CreditorAccount/SecondaryIdentification

This is secondary identification of the account, as assigned by the account servicing institution.

This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination).

Max34Text



RemittanceInformation

0..1

OBInternationalScheduled2/RemittanceInformation

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' receivable system.

OBRemittanceInformation1



Unstructured

0..1

OBInternationalScheduled2/RemittanceInformation/Unstructured

Information supplied to enable the matching/reconciliation of an entry with the items that the payment is intended to settle, such as commercial invoices in an accounts' receivable system, in an unstructured form.

Max140Text



Reference

0..1

OBInternationalScheduled2/RemittanceInformation/Reference

Unique reference, as assigned by the creditor, to unambiguously refer to the payment transaction.


Usage: If available, the initiating party should provide this reference in the structured remittance information, to enable reconciliation by the creditor upon receipt of the amount of money.


If the business context requires the use of a creditor reference or a payment remit identification, and only one identifier can be passed through the end-to-end chain, the creditor's reference or payment remittance identification should be quoted in the end-to-end transaction identification.

OB: The Faster Payments Scheme can only accept 18 characters for the ReferenceInformation field - which is where this ISO field will be mapped.

Max35Text



SupplementaryData

0..1

OBInternationalScheduled2/SupplementaryData

Additional information that can not be captured in the structured fields and/or any other specific block.

OBSupplementaryData1



International Standing Orders Data Dictionary

Name
Occurrence
XPath
EnhancedDefinition
Class
Codes
Pattern

Frequency

1..1

OBInternationalStandingOrder2/Frequency

Individual Definitions:

EvryDay - Every day

EvryWorkgDay - Every working day

IntrvlWkDay - An interval specified in weeks (01 to 09) (01 to 02), and the day within the week (01 to 07)

WkInMnthDay - A monthly interval, specifying the week of the month (01 to 05) and day within the week (01 to 07)

IntrvlMnthDay - An interval specified in months (between 01 to 06, 12, 24) (between 01 to 03, 06, 12), specifying the day within the month (-5 to -1, 1 to 31) (-1, 1 to 31)

QtrDay - Quarterly (either ENGLISH, SCOTTISH, or RECEIVED).

ENGLISH = Paid on the 25th March, 24th June, 29th September and 25th December.

SCOTTISH = Paid on the 2nd February, 15th May, 1st August and 11th November.

RECEIVED = Paid on the 20th March, 19th June, 24th September and 20th December.


Individual Patterns:

EvryDay (ScheduleCode)

EvryWorkgDay (ScheduleCode)

IntrvlWkDay:IntervalInWeeks:DayInWeek (ScheduleCode + IntervalInWeeks + DayInWeek)

WkInMnthDay:WeekInMonth:DayInWeek (ScheduleCode + WeekInMonth + DayInWeek)

IntrvlMnthDay:IntervalInMonths:DayInMonth (ScheduleCode + IntervalInMonths + DayInMonth)

QtrDay: + either (ENGLISH, SCOTTISH or RECEIVED) ScheduleCode + QuarterDay


The regular expression for this element combines five smaller versions for each permitted pattern. To aid legibility - the components are presented individually here:

EvryDay

EvryWorkgDay

IntrvlWkDay:0[1-9]:0[1-7]

WkInMnthDay:0[1-5]:0[1-7]

WkInMnthDay:0[1-2]:0[1-7]

IntrvlMnthDay:(0[1-6]|12|24):(-0[1-5]|0[1-9]|[12][0-9]|3[01])

IntrvlMnthDay:(0[1-3]|06|12):(-0[1-5]|0[1-9]|[12][0-9]|3[01])

QtrDay:(ENGLISH|SCOTTISH|RECEIVED)


Full Regular Expression:

^(EvryDay)$|^(EvryWorkgDay)$|^(IntrvlWkDay:0[1-9]:0[1-7])$|^(WkInMnthDay:0[1-5]:0[1-7])$|^(IntrvlMnthDay:(0[1-6]|12|24):(-0[1-5]|0[1-9]|[12][0-9]|3[01]))$|^(QtrDay:(ENGLISH|SCOTTISH|RECEIVED))$

^(IntrvlWkDay:0[1-2]:0[1-7])$|^(IntrvlMnthDay:(0[1-3]|06|12):(-01|0[1-9]|[12][0-9]|3[01]))$

Max35Text


^(EvryDay)$|^(EvryWorkgDay)$|^(IntrvlWkDay:0[1-9]:0[1-7])$|^(WkInMnthDay:0[1-5]:0[1-7])$|^(IntrvlMnthDay:(0[1-6]|12|24):(-0[1-5]|0[1-9]|[12][0-9]|3[01]))$|^(QtrDay:(ENGLISH|SCOTTISH|RECEIVED))$

^(IntrvlWkDay:0[1-2]:0[1-7])$|^(IntrvlMnthDay:(0[1-3]|06|12):(-01|0[1-9]|[12][0-9]|3[01]))$

Country

0..1

OBInternationalStandingOrder2/Creditor/PostalAddress/Country

Nation with its own government.

CountryCode


^[A-Z]{2,2}$

Country

0..1

OBInternationalStandingOrder2/CreditorAgent/PostalAddress/Country

Nation with its own government.

CountryCode


^[A-Z]{2,2}$

CurrencyOfTransfer

1..1

OBInternationalStandingOrder2/CurrencyOfTransfer

Specifies the currency of the to be transferred amount, which is different from the currency of the debtor's account.

ActiveOrHistoricCurrencyCode


^[A-Z]{3,3}$

Currency

1..1

OBInternationalStandingOrder2/InstructedAmount/Currency

A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".

ActiveOrHistoricCurrencyCode


^[A-Z]{3,3}$

Amount

1..1

OBInternationalStandingOrder2/InstructedAmount/Amount

A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.

Only up to two decimal places are supported.

OBActiveCurrencyAndAmount_SimpleType


^\d{1,13}\.\d{1,5}$

^\d{1,13}\.\d{1,2}$

OBInternationalStandingOrder2


OBInternationalStandingOrder2

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 an international standing order.

OBInternationalStandingOrder2



Reference

0..1

OBInternationalStandingOrder2/Reference

Unique reference, as assigned by the creditor, to unambiguously refer to the payment transaction.


Usage: If available, the initiating party should provide this reference in the structured remittance information, to enable reconciliation by the creditor upon receipt of the amount of money.


If the business context requires the use of a creditor reference or a payment remit identification, and only one identifier can be passed through the end-to-end chain, the creditor's reference or payment remittance identification should be quoted in the end-to-end transaction identification.

Max35Text



NumberOfPayments

0..1

OBInternationalStandingOrder2/NumberOfPayments

Number of the payments that will be made in completing this frequency sequence including any executed since the sequence start date.

Must be between 1 and 50.

Max35Text



FirstPaymentDateTime

1..1

OBInternationalStandingOrder2/FirstPaymentDateTime

The date on which the first payment for a Standing Order schedule will be made.

Can be up to one year in the future.

If a specific time is given, it will be ignored.

If the FirstPaymentDateTime doesn't match the given frequency, the FirstPaymentDateTime will be set to the next matching one.

Example:

"FirstPaymentDateTime": "2020-11-15T14:00:00+00:00"

"Frequency": "IntrvlMnthDay:01:29"

The first payment date will be the 29th of November.

ISODateTime



FinalPaymentDateTime

0..1

OBInternationalStandingOrder2/FinalPaymentDateTime

The date on which the final payment for a Standing Order schedule will be made.

If a specific time is given, it will be ignored, only the date is considered.

Cannot be more than one year in the future.

ISODateTime



Purpose

0..1

OBInternationalStandingOrder2/Purpose

Specifies the external purpose code in the format of character string with a maximum length of 4 characters.

The list of valid codes is an external code list published separately.

External code sets can be downloaded from www.iso20022.org.

OBExternalPurpose1Code1



ChargeBearer

0..1

OBInternationalStandingOrder2/ChargeBearer

Specifies which party/parties will bear the charges associated with the processing of the payment transaction.

OBChargeBearerType1Code

BorneByCreditor

BorneByDebtor

FollowingServiceLevel

Shared


InstructedAmount

1..1

OBInternationalStandingOrder2/InstructedAmount

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.

OBActiveOrHistoricCurrencyAndAmount



DebtorAccount

0..1

OBInternationalStandingOrder2/DebtorAccount

Provides the details to identify the debtor account.

OBCashAccountDebtor4



SchemeName

1..1

OBInternationalStandingOrder2/DebtorAccount/SchemeName

Name of the identification scheme, in a coded form as published in an external list.

OBExternalAccountIdentification4Code

SortCodeAccountNumber

UK.OBIE.SortCodeAccountNumber

IBAN

UK.OBIE.IBAN


Identification

1..1

OBInternationalStandingOrder2/DebtorAccount/Identification

Identification assigned by an institution to identify an account. This identification is known by the account owner.

Max256Text



Name

0..1

OBInternationalStandingOrder2/DebtorAccount/Name

Name of the account, as assigned by the account servicing institution.


Usage: 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.

Max70Text



SecondaryIdentification

0..1

OBInternationalStandingOrder2/DebtorAccount/SecondaryIdentification

This is secondary identification of the account, as assigned by the account servicing institution.

This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination).

Max34Text



Creditor

0..1

OBInternationalStandingOrder2/Creditor

Party to which an amount of money is due.

OBPartyIdentification43



Name

0..1

OBInternationalStandingOrder2/Creditor/Name

Name by which a party is known and which is usually used to identify that party.

Max140Text



PostalAddress

0..1

OBInternationalStandingOrder2/Creditor/PostalAddress

Information that locates and identifies a specific address, as defined by postal services.

OBPostalAddress6



AddressType

0..1

OBInternationalStandingOrder2/Creditor/PostalAddress/AddressType

Identifies the nature of the postal address.

OBAddressTypeCode

Business

Correspondence

DeliveryTo

MailTo

POBox

Postal

Residential

Statement


Department

0..1

OBInternationalStandingOrder2/Creditor/PostalAddress/Department

Identification of a division of a large organisation or building.

Max70Text



SubDepartment

0..1

OBInternationalStandingOrder2/Creditor/PostalAddress/SubDepartment

Identification of a sub-division of a large organisation or building.

Max70Text



StreetName

0..1

OBInternationalStandingOrder2/Creditor/PostalAddress/StreetName

Name of a street or thoroughfare.

Max70Text



BuildingNumber

0..1

OBInternationalStandingOrder2/Creditor/PostalAddress/BuildingNumber

Number that identifies the position of a building on a street.

Max16Text



PostCode

0..1

OBInternationalStandingOrder2/Creditor/PostalAddress/PostCode

Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.

Max16Text



TownName

0..1

OBInternationalStandingOrder2/Creditor/PostalAddress/TownName

Name of a built-up area, with defined boundaries, and a local government.

Max35Text



CountrySubDivision

0..1

OBInternationalStandingOrder2/Creditor/PostalAddress/CountrySubDivision

Identifies a subdivision of a country such as state, region, county.

Max35Text



AddressLine

0..7

OBInternationalStandingOrder2/Creditor/PostalAddress/AddressLine

Information that locates and identifies a specific address, as defined by postal services, presented in free format text.

Max70Text



CreditorAgent

0..1

OBInternationalStandingOrder2/CreditorAgent

Party that manages the account on behalf of the account owner, that is manages the registration and booking of entries on the account, calculates balances on the account and provides information about the account.

This is the servicer of the beneficiary account.

OBBranchAndFinancialInstitutionIdentification6



SchemeName

0..1

OBInternationalStandingOrder2/CreditorAgent/SchemeName

Name of the identification scheme, in a coded form as published in an external list.

OBExternalFinancialInstitutionIdentification4Code



Identification

0..1

OBInternationalStandingOrder2/CreditorAgent/Identification

Unique and unambiguous identification of the servicing institution.

Max35Text



Name

0..1

OBInternationalStandingOrder2/CreditorAgent/Name

Name by which an agent is known and which is usually used to identify that agent.

Max140Text



PostalAddress

0..1

OBInternationalStandingOrder2/CreditorAgent/PostalAddress

Information that locates and identifies a specific address, as defined by postal services.

OBPostalAddress6



AddressType

0..1

OBInternationalStandingOrder2/CreditorAgent/PostalAddress/AddressType

Identifies the nature of the postal address.

OBAddressTypeCode

Business

Correspondence

DeliveryTo

MailTo

POBox

Postal

Residential

Statement


Department

0..1

OBInternationalStandingOrder2/CreditorAgent/PostalAddress/Department

Identification of a division of a large organisation or building.

Max70Text



SubDepartment

0..1

OBInternationalStandingOrder2/CreditorAgent/PostalAddress/SubDepartment

Identification of a sub-division of a large organisation or building.

Max70Text



StreetName

0..1

OBInternationalStandingOrder2/CreditorAgent/PostalAddress/StreetName

Name of a street or thoroughfare.

Max70Text



BuildingNumber

0..1

OBInternationalStandingOrder2/CreditorAgent/PostalAddress/BuildingNumber

Number that identifies the position of a building on a street.

Max16Text



PostCode

0..1

OBInternationalStandingOrder2/CreditorAgent/PostalAddress/PostCode

Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.

Max16Text



TownName

0..1

OBInternationalStandingOrder2/CreditorAgent/PostalAddress/TownName

Name of a built-up area, with defined boundaries, and a local government.

Max35Text



CountrySubDivision

0..1

OBInternationalStandingOrder2/CreditorAgent/PostalAddress/CountrySubDivision

Identifies a subdivision of a country such as state, region, county.

Max35Text



AddressLine

0..7

OBInternationalStandingOrder2/CreditorAgent/PostalAddress/AddressLine

Information that locates and identifies a specific address, as defined by postal services, presented in free format text.

Max70Text



CreditorAccount

1..1

OBInternationalStandingOrder2/CreditorAccount

Provides the details to identify the beneficiary account.

OBCashAccountCreditor3



SchemeName

1..1

OBInternationalStandingOrder2/CreditorAccount/SchemeName

Name of the identification scheme, in a coded form as published in an external list.

OBExternalAccountIdentification4Code

SortCodeAccountNumber (UK only)

UK.OBIE.SortCodeAccountNumber (UK only)

IBAN

UK.OBIE.IBAN


Identification

1..1

OBInternationalStandingOrder2/CreditorAccount/Identification

Identification assigned by an institution to identify an account. This identification is known by the account owner.

Max256Text



Name

1..1

OBInternationalStandingOrder2/CreditorAccount/Name

Name of the account, as assigned by the account servicing institution.


Usage: 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.

OB: ASPSPs may carry out name validation for Confirmation of Payee, but it is not mandatory.

Max70Text



SecondaryIdentification

0..1

OBInternationalStandingOrder2/CreditorAccount/SecondaryIdentification

This is secondary identification of the account, as assigned by the account servicing institution.

This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination).

Max34Text



SupplementaryData

0..1

OBInternationalStandingOrder2/SupplementaryData

Additional information that can not be captured in the structured fields and/or any other specific block.

OBSupplementaryData1



Confirmation of Funds API

Swagger version3.1
Base URI

https://api.adambank.com:8446/open-banking/v3.1/cbpii/

General variances to specificationn/a
Non-functional limitationsn/a

Resource
Endpoint
Available (Y/N)
Mandatory?
1funds-confirmation-consentPOST /funds-confirmation-consentsYMandatory
2funds-confirmation-consentGET /funds-confirmation-consents/{ConsentId}YMandatory
3funds-confirmation-consentDELETE /funds-confirmation-consents/{ConsentId}YMandatory
4funds-confirmationPOST /funds-confirmationsYMandatory

Open Data API

Swagger version1.1
Base URI/
General variances to specification n/a
Non-functional limitationsn/a