Version Control

Version

Date

Author

Comments

2.0-rc2

07 Feb 2018

Open Banking Read/Write API Team

This is the initial version following specification restructuring.

Updates:

Added a StandingOrderStatusCode (which reflects the same DirectDebitStatusCode in the direct-debits resource)
Modified usage examples:
- Removed references to x-jws-signature
- Updated link URLs
- Name-spaced AccountRequestIds in usage examples - as IntentIds are name-spaced in other usage examples. ASPSPs may construct the IntentId as they wish.
Additional guidance for ReadStandingOrdersDetail permission

2.0-rc3

16 Feb 2018

Open Banking Read/Write API Team

This is the initial version for release candidate 3

Updates:

Updated mandatory, conditional or optional as per Design Principles

2.0.0

27 Feb 2018

Open Banking Read/Write API Team

This is the baseline version. No changes from v2.0-rc3.

Endpoints

Endpoints for the resource - and available methods.

	Resource	HTTP Operation	Endpoint	Mandatory?	Scope	Grant Type	Idempotent	Parameters	Request Object	Response Object
1	standing-orders	GET	GET /accounts/{AccountId}/standing-orders	Conditional	accounts	Authorization Code				OBReadStandingOrder2
2	standing-orders	GET	GET /standing-orders	Optional	accounts	Authorization Code		Pagination		OBReadStandingOrder2

GET /accounts/{AccountId}/standing-orders

An AISP may retrieve the standing-order resource for a specific AccountId (which is retrieved in the call to GET /accounts).

GET /standing-orders

If an ASPSP has implemented the bulk retrieval endpoints - an AISP may optionally retrieve the standing-order resources in bulk.

This will retrieve the resources for all authorised accounts linked to the account-request.

Data Model

The OBReadStandingOrder2 object will be used for the call to:

GET /accounts/{AccountId}/standing-orders
GET /standing-orders

Resource Definition

A resource that contains a set of elements that describes the list of standing-orders that have been set up on a specific account (AccountId).

An account (AccountId) may have no standing orders set up, or may have multiple standing orders set up.

UML Diagram

Notes:

The Account and Creditor blocks replicate what is used consistently throughout the Account Information APIs to identify an account.
For the /accounts/{AccountId}/standing-orders endpoint - the Account and Creditor blocks represent the account that is receiving funds (so has been named the CreditorAccount - for consistency with the PISP use case).
A DateTime element has been used - so that there is consistency across all API endpoints using dates. Where time elements do not exist in ASPSP systems - the time portion of the DateTime element will be defaulted to 00:00:00+00:00
The Amount elements all have embedded Currency elements - for consistency is ISO 20022, and across the other API endpoints

Permission Codes

The resource differs depending on the permissions (ReadStandingOrdersBasic and ReadStandingOrdersDetail) used to access resource. In the event the resource is accessed with both ReadStandingOrdersBasic and ReadStandingOrdersDetail, the most detailed level (ReadStandingOrdersDetail) must be used.

These objects must not be returned without the ReadStandingOrdersDetail permission:
- OBReadStandingOrder2/Data/StandingOrder/CreditorAgent
- OBReadStandingOrder2/Data/StandingOrder/CreditorAccount
If the ReadStandingOrdersDetail is granted by the PSU:
- OBReadStandingOrder2/Data/StandingOrder/CreditorAgent may be returned if applicable to the account and ASPSP (0..1)
- OBReadStandingOrder2/Data/StandingOrder/CreditorAccount must be returned (1..1)

Data Dictionary

Name	Occurrence	XPath	EnhancedDefinition	Class	Codes	Pattern
OBReadStandingOrder2		OBReadStandingOrder2		OBReadStandingOrder2
Data	1..1	OBReadStandingOrder2/Data		OBReadDataStandingOrder2
StandingOrder	0..n	OBReadStandingOrder2/Data/StandingOrder	Account to or from which a cash entry is made.	OBStandingOrder2
AccountId	1..1	OBReadStandingOrder2/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	OBReadStandingOrder2/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	OBReadStandingOrder2/Data/StandingOrder/Frequency	Individual Definitions: EvryDay - Every day EvryWorkgDay - Every working day IntrvlWkDay - An interval specified in weeks (01 to 09), 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), specifying the day within the month (-5 to -1, 1 to 31) QtrDay - Quarterly (either ENGLISH, SCOTTISH, or RECEIVED) 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] IntrvlMnthDay:(0[1-6]\|12\|24):(-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))$	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))$
Reference	0..1	OBReadStandingOrder2/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	OBReadStandingOrder2/Data/StandingOrder/FirstPaymentDateTime	The date on which the first payment for a Standing Order schedule will be made.	ISODateTime
FirstPaymentAmount	0..1	OBReadStandingOrder2/Data/StandingOrder/FirstPaymentAmount	The amount of the first Standing Order	ActiveOrHistoricCurrencyAndAmount
Currency	1..1	OBReadStandingOrder2/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}$
NextPaymentDateTime	1..1	OBReadStandingOrder2/Data/StandingOrder/NextPaymentDateTime	The date on which the next payment for a Standing Order schedule will be made.	ISODateTime
NextPaymentAmount	1..1	OBReadStandingOrder2/Data/StandingOrder/NextPaymentAmount	The amount of the next Standing Order	ActiveOrHistoricCurrencyAndAmount
Currency	1..1	OBReadStandingOrder2/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}$
FinalPaymentDateTime	0..1	OBReadStandingOrder2/Data/StandingOrder/FinalPaymentDateTime	The date on which the final payment for a Standing Order schedule will be made.	ISODateTime
FinalPaymentAmount	0..1	OBReadStandingOrder2/Data/StandingOrder/FinalPaymentAmount	The amount of the final Standing Order	ActiveOrHistoricCurrencyAndAmount
Currency	1..1	OBReadStandingOrder2/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}$
StandingOrderStatusCode	0..1	OBReadStandingOrder2/Data/StandingOrder/StandingOrderStatusCode	Specifies the status of the standing order in code form.	OBExternalStandingOrderStatus1Code	Active Inactive
CreditorAgent	0..1	OBReadStandingOrder2/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.	OBBranchAndFinancialInstitutionIdentification2
SchemeName	1..1	OBReadStandingOrder2/Data/StandingOrder/CreditorAgent/SchemeName	Name of the identification scheme, in a coded form as published in an external list.	OBExternalFinancialInstitutionIdentification2Code	BICFI
Identification	1..1	OBReadStandingOrder2/Data/StandingOrder/CreditorAgent/Identification	Unique and unambiguous identification of the servicing institution.	Max35Text
CreditorAccount	0..1	OBReadStandingOrder2/Data/StandingOrder/CreditorAccount	Provides the details to identify the beneficiary account.	OBCashAccount1
SchemeName	1..1	OBReadStandingOrder2/Data/StandingOrder/CreditorAccount/SchemeName	Name of the identification scheme, in a coded form as published in an external list.	OBExternalAccountIdentification2Code	IBAN SortCodeAccountNumber
Identification	1..1	OBReadStandingOrder2/Data/StandingOrder/CreditorAccount/Identification	Beneficiary account identification.	Max34Text
Name	0..1	OBReadStandingOrder2/Data/StandingOrder/CreditorAccount/Name	Name of the account, as assigned by the account servicing institution, in agreement with the account owner in order to provide an additional means of identification of the account. Usage: The account name is different from the account owner name. The account name is used in certain user communities to provide a means of identifying the account, in addition to the account owner's identity and the account number.	Max70Text
SecondaryIdentification	0..1	OBReadStandingOrder2/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

Enumerations

Code Class	Name	Definition
OBExternalAccountIdentification2Code	IBAN	An identifier used internationally by financial institutions to uniquely identify the account of a customer at a financial institution, as described in the latest edition of the international standard ISO 13616. "Banking and related financial services - International Bank Account Number (IBAN)".
OBExternalAccountIdentification2Code	SortCodeAccountNumber	Sort Code and Account Number - identifier scheme used in the UK by financial institutions to identify the account of a customer. The identifier is the concatenation of the 6 digit UK sort code and 8 digit account number. The regular expression for this identifier is: ^[0-9]{6}[0-9]{8}$
OBExternalStandingOrderStatus1Code	Active	The standing order is active.
OBExternalStandingOrderStatus1Code	Inactive	The standing order is inactive.
OBExternalFinancialInstitutionIdentification2Code	BICFI	Valid BICs for financial institutions are registered by the ISO 9362 Registration Authority in the BIC directory, and consist of eight (8) or eleven (11) contiguous characters.

Usage Examples

Specific Account

Request

Get Accounts Standing Orders Request

GET /accounts/22289/standing-orders HTTP/1.1
Authorization: Bearer Az90SAOJklae
x-fapi-financial-id: OB/2017/001
x-fapi-customer-last-logged-time:  Sun, 10 Sep 2017 19:43:31 UTC
x-fapi-customer-ip-address: 104.25.212.99
x-fapi-interaction-id: 93bac548-d2de-4546-b106-880a5018460d
Accept: application/json

Response

Get Accounts Standing Orders Response

HTTP/1.1 200 OK
x-fapi-interaction-id: 93bac548-d2de-4546-b106-880a5018460d
Content-Type: application/json

{
  "Data": {
    "StandingOrder": [
      {
        "AccountId": "22289",
        "StandingOrderId": "Ben3",
        "Frequency": "EvryWorkgDay",
        "Reference": "Towbar Club 2 - We Love Towbars",
        "FirstPaymentDateTime": "2017-08-12T00:00:00+00:00",
        "FirstPaymentAmount": {
          "Amount": "0.57",
          "Currency": "GBP"
        },
        "NextPaymentDateTime": "2017-08-13T00:00:00+00:00",
        "NextPaymentAmount": {
          "Amount": "0.56",
          "Currency": "GBP"
        },
        "FinalPaymentDateTime": "2027-08-12T00:00:00+00:00",
        "FinalPaymentAmount": {
          "Amount": "0.56",
          "Currency": "GBP"
        },
        "StandingOrderStatusCode": "Active",
        "CreditorAccount": {
          "SchemeName": "SortCodeAccountNumber",
          "Identification": "80200112345678",
          "Name": "Mrs Juniper"
        }
      }
    ]
  },
  "Links": {
    "Self": "https://api.alphabank.com/open-banking/v2.0/accounts/22289/standing-orders/"
  },
  "Meta": {
    "TotalPages": 1
  }
}

Bulk

Request

Get Standing Orders Request

GET /standing-orders HTTP/1.1
Authorization: Bearer Az90SAOJklae
x-fapi-financial-id: OB/2017/001
x-fapi-customer-last-logged-time:  Sun, 10 Sep 2017 19:43:31 UTC
x-fapi-customer-ip-address: 104.25.212.99
x-fapi-interaction-id: 93bac548-d2de-4546-b106-880a5018460d
Accept: application/json

Response

Get Standing Orders Response

HTTP/1.1 200 OK
x-fapi-interaction-id: 93bac548-d2de-4546-b106-880a5018460d
Content-Type: application/json

{
  "Data": {
    "StandingOrder": [
      {
        "AccountId": "22289",
        "StandingOrderId": "Ben3",
        "Frequency": "EvryWorkgDay",
        "Reference": "Towbar Club 2 - We Love Towbars",
        "FirstPaymentDateTime": "2017-08-12T00:00:00+00:00",
        "FirstPaymentAmount": {
          "Amount": "0.57",
          "Currency": "GBP"
        },
        "NextPaymentDateTime": "2017-08-13T00:00:00+00:00",
        "NextPaymentAmount": {
          "Amount": "0.56",
          "Currency": "GBP"
        },
        "FinalPaymentDateTime": "2027-08-12T00:00:00+00:00",
        "FinalPaymentAmount": {
          "Amount": "0.56",
          "Currency": "GBP"
        },
        "StandingOrderStatusCode": "Active",
        "CreditorAccount": {
          "SchemeName": "SortCodeAccountNumber",
          "Identification": "80200112345678",
          "Name": "Mrs Juniper"
        }
      },
      {
        "AccountId": "22289",
        "StandingOrderId": "Ben5",
        "Frequency": "WkinMnthDay(2)",
        "Reference": "Golf - We Love Golf",
        "FirstPaymentDateTime": "2017-06-12T00:00:00+00:00",
        "FirstPaymentAmount": {
          "Amount": "23.00",
          "Currency": "GBP"
        },
        "NextPaymentDateTime": "2017-07-12T00:00:00+00:00",
        "NextPaymentAmount": {
          "Amount": "23.00",
          "Currency": "GBP"
        },
        "FinalPaymentDateTime": "2018-06-12T00:00:00+00:00",
        "FinalPaymentAmount": {
          "Amount": "23.00",
          "Currency": "GBP"
        },
        "StandingOrderStatusCode": "Active",
        "CreditorAccount": {
          "SchemeName": "SortCodeAccountNumber",
          "Identification": "23605490179017",
          "Name": "Mr Tee"
        }
      }
    ]
  },
  "Links": {
    "Self": "https://api.alphabank.com/open-banking/v2.0/standing-orders/"
  },
  "Meta": {
    "TotalPages": 1
  }
}

Developer Zone

Standing Orders v2.0.0

Version Control

Endpoints

GET /accounts/{AccountId}/standing-orders

GET /standing-orders

Data Model

Resource Definition

UML Diagram

Permission Codes

Data Dictionary

Enumerations

Usage Examples

Specific Account

Bulk