| Warning |
|---|
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. |
...
| Page Properties | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||
|
...
Planned Improvements | Delivery date |
|---|---|
App-to-App enhancements: Coutts & Co plans to implement app-to-app enhancements for Open Banking journeys by mid November. | 17.11.2019 |
| File Payments v3.1 | 17.11.2019 |
...
| Supports dynamic client registration (Y/N) | Y |
|---|---|
| Instructions for manual onboarding | Coutts & Co. does not support manual registration. Only dynamic registration is supported. |
| OIDC .well-known endpoint | |
| 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, Coutts & Co. is in a phase of live proving with a limited number of customers. If a TPP should plan to integrate with Coutts productively and test the APIs, then please contact us via the service desk mentioned above. |
| Other on-boarding notes | Currently, Coutts & 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/coutts/3.0.0 |
...
| Resource | Endpoint | Available (Y/N) | Mandatory? | |
|---|---|---|---|---|
| 1 | account-access-consents | POST /account-access-consents | Y | Mandatory |
| 2 | account-access-consents | GET /account-requests/{AccountRequestId} | Y | Mandatory |
| 3 | account-access-consents | DELETE /account-requests/{AccountRequestId} | Y | Mandatory |
| 4 | accounts | GET /accounts | Y | Mandatory |
| 5 | accounts | GET /accounts/{AccountId} | Y | Mandatory |
| 6 | balances | GET /accounts/{AccountId}/balances | Y | Mandatory |
| 7 | balances | GET /balances | N | Optional |
| 8 | transactions | GET /accounts/{AccountId}/transactions | Y | Mandatory |
| 9 | transactions | GET /transactions | N | Optional |
| 10 | beneficiaries | GET /accounts/{AccountId}/beneficiaries | Y | Conditional |
| 11 | beneficiaries | GET /beneficiaries | N | Optional |
| 12 | direct-debits | GET /accounts/{AccountId}/direct-debits | Y | Conditional |
| 13 | direct-debits | GET /direct-debits | N | Optional |
| 14 | standing-orders | GET /accounts/{AccountId}/standing-orders | Y | Conditional |
| 15 | standing-orders | GET /standing-orders | N | Optional |
| 16 | products | GET /accounts/{AccountId}/product | Y | Conditional |
| 17 | products | GET /products | N | Optional |
| 18 | offers | GET /accounts/{AccountId}/offers | N | Conditional |
| 19 | offers | GET /offers | N | Optional |
| 20 | party | GET /accounts/{AccountId}/party | N | Conditional |
| 21 | party | GET /party | N | Optional |
| 22 | scheduled-payments | GET /accounts/{AccountId}/scheduled-payments | Y | Conditional |
| 23 | scheduled-payments | GET /scheduled-payments | N | Optional |
| 24 | statements | GET /accounts/{AccountId}/statements | N | Conditional |
| 25 | statements | GET /accounts/{AccountId}/statements/{StatementId} | N | Conditional |
| 26 | statements | GET /accounts/{AccountId}/statements/{StatementId}/file | N | Optional |
| 27 | transactions | GET /accounts/{AccountId}/statements/{StatementId}/transactions | N | Conditional |
| 28 | statements | GET /statements | N | Conditional |
Fields information
...
| Swagger version | 3.1 |
|---|---|
| Base URI | |
| General variances to specification | File Payments APIs are not implemented, but Coutts plans to support these as of November 17th 2019 |
| Non-functional limitations | Global as well as individual TPP rate limiting will be applied for API calls in production and in sandbox. |
...
| Resource | Endpoint | Available (Y/N) | Mandatory? | |
|---|---|---|---|---|
| 1 | domestic-payment-consents | POST /domestic-payment-consents | Y | Mandatory |
| 2 | domestic-payment-consents | GET /domestic-payment-consents/{ConsentId} | Y | Mandatory |
| 3 | domestic-payment-consents | GET /domestic-payment-consents/{ConsentId}/funds-confirmation | Y | Mandatory |
| 4 | domestic-payments | POST /domestic-payments | Y | Mandatory |
| 5 | domestic-payments | GET /domestic-payments/{DomesticPaymentId} | Y | Mandatory |
| 6 | domestic-scheduled-payment-consents | POST /domestic-scheduled-payment-consents | Y | Conditional |
| 7 | domestic-scheduled-payment-consents | GET /domestic-scheduled-payment-consents/{ConsentId} | Y | Mandatory (if resource POST implemented) |
| 8 | domestic-scheduled-payments | POST /domestic-scheduled-payments | Y | Conditional |
| 9 | domestic-scheduled-payments | GET /domestic-scheduled-payments/{DomesticScheduledPaymentId} | Y | Mandatory (if resource POST implemented) |
| 10 | domestic-standing-order-consents | POST /domestic-standing-order-consents | Y | Conditional |
| 11 | domestic-standing-order-consents | GET /domestic-standing-order-consents/{ConsentId} | Y | Mandatory (if resource POST implemented) |
| 12 | domestic-standing-orders | POST /domestic-standing-orders | Y | Conditional |
| 13 | domestic-standing-orders | GET /domestic-standing-orders/{DomesticStandingOrderId} | Y | Mandatory (if resource POST implemented) |
| 14 | international-payment-consents | POST /international-payment-consents | Y | Conditional |
| 15 | international-payment-consents | GET /international-payment-consents/{ConsentId} | Y | Mandatory (if resource POST implemented) |
| 16 | international-payment-consents | GET /international-payment-consents/{ConsentId}/funds-confirmation | Y | Mandatory (if resource POST implemented) |
| 17 | international-payments | POST /international-payments | Y | Conditional |
| 18 | international-payments | GET /international-payments/{InternationalPaymentId} | Y | Mandatory (if resource POST implemented) |
| 19 | international-scheduled-payment-consents | POST /international-scheduled-payment-consents | Y | Conditional |
| 20 | international-scheduled-payment-consents | GET /international-scheduled-payment-consents/{ConsentId} | Y | Mandatory (if resource POST implemented) |
| 21 | international-scheduled-payment-consents | GET /international-scheduled-payment-consents/{ConsentId}/funds-confirmation | Y | Mandatory (if immediate debit supported) |
| 22 | international-scheduled-payments | POST /international-scheduled-payments | Y | Conditional |
| 23 | international-scheduled-payments | GET /international-scheduled-payments/{InternationalScheduledPaymentId} | Y | Mandatory (if resource POST implemented) |
| 24 | international-standing-order-consents | POST /international-standing-order-consents | Y | Conditional |
| 25 | international-standing-order-consents | GET /international-standing-order-consents/{ConsentId} | Y | Mandatory (if resource POST implemented) |
| 26 | international-standing-orders | POST /international-standing-orders | Y | Conditional |
| 27 | international-standing-orders | GET /international-standing-orders/{InternationalStandingOrderPaymentId} | Y | Mandatory (if resource POST implemented) |
| 28 | file-payment-consents | POST /file-payment-consents | N | Conditional |
| 29 | file-payment-consents | POST /file-payment-consents/{ConsentId}/file | N | Conditional |
| 30 | file-payment-consents | GET /file-payment-consents/{ConsentId} | N | Mandatory (if resource POST implemented) |
| 31 | file-payment-consents | GET /file-payment-consents/{ConsentId}/file | N | Conditional |
| 32 | file-payments | POST /file-payments | N | Conditional |
| 33 | file-payments | GET /file-payments/{FilePaymentId} | N | Mandatory (if resource POST implemented) |
| 34 | file-payments | GET /file-payments/{FilePaymentId}/report-file | N | Conditional |
...
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,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 |
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 | ||
|
|
|
|
| ||
|
|
|
|
| ||
|
|
|
|
| ||
|
|
|
|
| ||
|
|
|
|
| ||
|
|
|
|
|
| |
|
|
|
|
| ||
|
|
|
|
| ||
|
|
|
|
| ||
|
|
|
|
| ||
|
|
|
|
| ||
|
|
|
|
| ||
|
|
|
|
| ||
|
|
|
|
|
| |
|
|
|
|
| ||
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 | ||
|
|
|
|
| ||
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 | ||
|
|
|
|
|
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,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 |
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 | ||
|
|
|
|
| ||
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 | ||
|
|
|
|
| ||
|
|
|
|
| ||
|
|
|
|
| ||
|
|
|
|
| ||
|
|
|
|
| ||
|
|
|
|
|
| |
|
|
|
|
| ||
|
|
|
|
| ||
|
|
|
|
| ||
|
|
|
|
| ||
|
|
|
|
| ||
|
|
|
|
| ||
|
|
|
|
| ||
|
|
|
|
|
| |
|
|
|
|
| ||
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 | ||
|
|
|
|
| ||
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 | ||
|
|
|
|
|
International Standing Orders Data Dictionary
...
| Resource | Endpoint | Available (Y/N) | Mandatory? | |
|---|---|---|---|---|
| 1 | funds-confirmation-consent | POST /funds-confirmation-consents | Y | Mandatory |
| 2 | funds-confirmation-consent | GET /funds-confirmation-consents/{ConsentId} | Y | Mandatory |
| 3 | funds-confirmation-consent | DELETE /funds-confirmation-consents/{ConsentId} | Y | Mandatory |
| 4 | funds-confirmation | POST /funds-confirmations | Y | Mandatory |
Open Data API
| Swagger version | 1.1 |
|---|---|
| Base URI | / |
| General variances to specification | n/a |
| Non-functional limitations | n/a |
...