Table of Contents

1. Overview

The standing-orders resource is used by an AISP to retrieve the standing orders for a specific AccountId or to retrieve the standing orders in bulk for all the accounts that the PSU has consented to.

This resource description should be read in conjunction with a compatible Account Information Services API Profile.

2. Endpoints

_S.No_.	_Resource	_{HTTP Operation}	_Endpoint	_Mandatory	_Scope	_{Grant Type}	_{Idempotency Key}	_Parameter	_{Request Object}	_{Response Object}
_2.1	_{standing-orders}	_GET	_{GET /accounts/{AccountId}/standing-orders}	_Conditional	_accounts	_{Authorization Code}	_No			_{OBReadStandingOrder}
_2.2	_{standing-orders}	_GET	_{GET /standing-orders}	_Optional	_accounts	_{Authorization Code}	_No	_Pagination		_{OBReadStandingOrder}

2.1. 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).

2.2. 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.

3. Data Models

3.1. OBReadStandingOrder

The OBReadStandingOrder object will be used for the call to:

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

3.1.1 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.

3.1.2 UML Diagram

...

3.1.3 Notes

The Creditor Account and CreditorAgent blocks replicate what is used consistently throughout the Account Information APIs to identify an account.
For the /accounts/{AccountId}/standing-orders endpoint, the Creditor Account and CreditorAgent 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.
ASPSPs must give TPPs at least three month's notice, prior to implementing any change in the code-lists of the fields, if such a change impacts the ability of TPPs to continue with the provision of their service.

3.1.4 Frequency

_Frequency	_Example	_Details
_NotKnown	_NotKnown	_{Not known}
_EvryDay	_EvryDay	_{Every day}
_EvryWorkgDay	_EvryWorkgDay	_{Every working day}
_IntrvlDay	_IntrvlDay:15	_{Every 15 Calendar day}
_IntrvlWkDay	_{IntrvlWkDay:01:03}	_{Every week, on the 3rd day of the week}
_IntrvlWkDay	_{IntrvlWkDay:02:03}	_{Every 2nd week, on the 3rd day of the week}
_WkInMnthDay	_{WkInMnthDay:02:03}	_{Every month, on the 2nd week of the month, and on the third day of the week}
_{IntrvlMnthDay}	_{IntrvlMnthDay:01:-01}	_{Every month, on the last day of the month}
_{IntrvlMnthDay}	_{IntrvlMnthDay:06:15}	_{Every 6th month, on the 15th day of the month}
_QtrDay	_{QtrDay:ENGLISH}	_{Paid on the 25th March, 24th June, 29th September and 25th December}

3.1.5 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:
- OBReadStandingOrder/Data/StandingOrder/CreditorAgent
- OBReadStandingOrder/Data/StandingOrder/CreditorAccoun
If the ReadStandingOrdersDetail is granted by the PSU:
- OBReadStandingOrder/Data/StandingOrder/CreditorAgent may be returned if applicable to the account and ASPSP (0..1)
- OBReadStandingOrder/Data/StandingOrder/CreditorAccount must be returned (1..1)

If the ReadPAN permission is granted by the PSU, the ASPSP may choose to populate the OBReadStandingOrder/Data/StandingOrder/CreditorAccount/Identification with the unmasked PAN (if the PAN is being populated in the response).

3.1.6 Data Dictionary

...

_Name

...

_Occurrence

...

_XPath

...

_Definition

...

_{Class/ Datatype}

...

_Codes

...

_Pattern

...

_{OBReadStandingOrder}

...

_{OBReadStandingOrder}

...

_{OBReadStandingOrder}

...

_Data

...

_1..1

...

_{OBReadStandingOrder/Data}

...

_{OBReadStandingOrder/Data}

...

_{StandingOrder}

...

_0..n

...

_{OBReadStandingOrder/Data/StandingOrder}

...

_{OBReadStandingOrder/Data/StandingOrder}

...

_AccountId

...

_1..1

...

_{OBReadStandingOrder/Data/StandingOrder/AccountId}

...

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

...

_String

...

_{StandingOrderId}

...

_0..1

...

_{OBReadStandingOrder/Data/StandingOrder/StandingOrderId}

...

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

...

_String

...

_Frequency

...

_1..1

...

_{OBReadStandingOrder/Data/StandingOrder/Frequency}

_{Individual Definitions:}
_{NotKnown - Not known}
_{EvryDay - Every day}
_{EvryWorkgDay - Every working day}
_{IntrvlDay - An interval specified in number of calendar days (02 to 31)}
_{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 (-05 to -01, 01 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:}
_{NotKnown (ScheduleCode)}
_{EvryDay (ScheduleCode)}
_{EvryWorkgDay (ScheduleCode)}
_{IntrvlDay:NoOfDay (ScheduleCode + NoOfDay)}
_{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}

...

Table of Contents

maxLevel	1
style	none

1. Version Control

Version	Date	Description of Changes
Bahrain OBF v1.0.0	25th Aug 2020	Initial Release

2. Overview

The standing-orders resource is used by an AISP to retrieve the standing orders for a specific AccountId or to retrieve the standing orders in bulk for all the accounts that the user/customer has consented to.

This resource description should be read in conjunction with a compatible Account Information Services API Profile.

3. Endpoints

S. No.	Resource	HTTP Operation	Endpoint	Mandatory	Scope	Grant Type	Idempotency Key	Parameters	Request Object	Response Object
3.1	standing-orders	GET	GET /accounts/{AccountId}/standing-orders	Conditional	accounts	Authorisation Code	No			OBReadStandingOrder
3.2	standing-orders	GET	GET /standing-orders	Optional	accounts	Authorisation Code	No	Pagination		OBReadStandingOrder

3.1 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).

3.2 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.

4. Data Models

4.1 OBReadStandingOrder

The OBReadStandingOrder object will be used for the call to:

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

4.1.1 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.

4.1.2 UML Diagram

...

4.1.3 Notes

The CreditorAccount and CreditorAgent blocks replicate what is used consistently throughout the Account Information APIs to identify an account
For the /accounts/{AccountId}/standing-orders endpoint, the CreditorAccount and CreditorAgent 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+03:00
The Amount elements all have embedded Currency elements for consistency is ISO 20022, and across the other API endpoints
ASPSPs must give AISPs at least three month's notice, prior to implementing any change in the code-lists of the fields, if such a change impacts the ability of AISPs to continue with the provision of their service

4.1.4 Frequency

Frequency	Example	Details
NotKnown	NotKnown	Not known
EvryDay	EvryDay	Every day
EvryWorkgDay	EvryWorkgDay	Every working day
IntrvlDay	IntrvlDay:15	Every 15 Calendar day
IntrvlWkDay	IntrvlWkDay:01:03	Every week, on the 3rd day of the week
IntrvlWkDay	IntrvlWkDay:02:03	Every 2nd week, on the 3rd day of the week
WkInMnthDay	WkInMnthDay:02:03	Every month, on the 2nd week of the month, and on the third day of the week
IntrvlMnthDay	IntrvlMnthDay:01:-01	Every month, on the last day of the month
IntrvlMnthDay	IntrvlMnthDay:06:15	Every 6th month, on the 15th day of the month
QtrDay	QtrDay:ENGLISH	Paid on the 25th March, 24th June, 29th September and 25th December

4.1.5 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:
- OBReadStandingOrder/Data/StandingOrder/CreditorAgent
- OBReadStandingOrder/Data/StandingOrder/CreditorAccount
If the ReadStandingOrdersDetail is granted by the user/customer:
- OBReadStandingOrder/Data/StandingOrder/CreditorAgent may be returned if applicable to the account and ASPSP (0..1)
- OBReadStandingOrder/Data/StandingOrder/CreditorAccount must be returned (1..1)

If the ReadPAN permission is granted by the user/customer, the ASPSP may choose to populate the OBReadStandingOrder/Data/StandingOrder/CreditorAccount/Identification with the unmasked PAN (if the PAN is being populated in the response).

4.1.6 Data Dictionary

_{The date on which the next payment for a Standing Order schedule will be made}

Name

Occurrence

XPath

Enhanced Definition

Class/ Datatype

Codes

Pattern

OBReadStandingOrder

Data

1..1

OBReadStandingOrder/Data

StandingOrder

0..n

OBReadStandingOrder/Data/StandingOrder

AccountId

1..1

OBReadStandingOrder/Data/StandingOrder/AccountId

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

String

StandingOrderId

0..1

OBReadStandingOrder/Data/StandingOrder/StandingOrderId

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

String

Frequency

1..1

OBReadStandingOrder/Data/StandingOrder/Frequency

Individual Definitions:
NotKnown - Not known
EvryDay - Every day
EvryWorkgDay - Every working day
IntrvlDay - An interval specified in number of calendar days (02 to 31)
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 (-05 to -01, 01 to 31)
QtrDay - Quarterly (ENGLISH)
ENGLISH = Paid on the 25th March, 24th June, 29th September and 25th December.

Individual Patterns:
NotKnown (ScheduleCode)
EvryDay (ScheduleCode)
EvryWorkgDay (ScheduleCode)
IntrvlDay:NoOfDay (ScheduleCode + NoOfDay)
IntrvlWkDay:IntervalInWeeks:DayInWeek (ScheduleCode + IntervalInWeeks + DayInWeek)
WkInMnthDay:WeekInMonth:DayInWeek (ScheduleCode + WeekInMonth + DayInWeek)
IntrvlMnthDay:IntervalInMonths:DayInMonth (ScheduleCode + IntervalInMonths + DayInMonth)
QtrDay: + either (ENGLISH) 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:
NotKnown
EvryDay
EvryWorkgDay
IntrvlDay:((0[2-9])\|([1-2][0-9])\|3[0-1]))$|^(
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))$

_String

Full Regular Expression:
^(NotKnown)$|^(EvryDay)$|^(EvryWorkgDay)$|^(IntrvlDay:((0[2-9])|([1-2][0-9])|3[0-1]))$|^(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

_{OBReadStandingOrder/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.}

_String

_{FirstPaymentDateTime}))$

String

^(NotKnown)$|^(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))$

Reference

0..1

OBReadStandingOrder/Data/StandingOrder/FirstPaymentDateTime

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

_DateTime

_{NextPaymentDateTime}

_0..1

_{OBReadStandingOrder/Data/StandingOrder/NextPaymentDateTime}

_DateTime

_{LastPaymentDateTime}

_0..1

_{OBReadStandingOrder/Data/StandingOrder/LastPaymentDateTime}

_{The date on which the last (most recent) payment for a Standing Order schedule was made.}

_DateTime

_{FinalPaymentDateTime}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

String

FirstPaymentDateTime

0..1

OBReadStandingOrder/Data/StandingOrder/FinalPaymentDateTimeFirstPaymentDateTime

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

DateTime

_{NumberOfPayments}NextPaymentDateTime

0..1

OBReadStandingOrder/Data/StandingOrder/NumberOfPayments

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

_StringNextPaymentDateTime

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

DateTime

_{StandingOrderStatusCode}LastPaymentDateTime

0..1

OBReadStandingOrder/Data/StandingOrder/StandingOrderStatusCode

_{Specifies the status of the standing order in code form.}

_String

_Enum:

_Active
_Inactive

_{FirstPaymentAmount}LastPaymentDateTime

The date on which the last (most recent) payment for a Standing Order schedule was made

DateTime

FinalPaymentDateTime

0..1

OBReadStandingOrder/Data/StandingOrder/FirstPaymentAmountFinalPaymentDateTime

The amount of the first Standing Order_{OBReadStandingOrder/Data/StandingOrder/FirstPaymentAmount}date on which the final payment for a Standing Order schedule will be made

DateTime

_AmountNumberOfPayments

10..1

OBReadStandingOrder/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.}NumberOfPayments

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

String

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

_Currency

1

StandingOrderStatusCode

0..1

OBReadStandingOrder/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".}

_String

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

_{NextPaymentAmount}

StandingOrderStatusCode

Specifies the status of the standing order in code form

String

Enum:

Active
Inactive

FirstPaymentAmount

0..1

OBReadStandingOrder/Data/StandingOrder/NextPaymentAmountFirstPaymentAmount

The amount of the next first Standing Order.

OBReadStandingOrder/Data/StandingOrder/NextPaymentAmountFirstPaymentAmount

Amount

1..1

OBReadStandingOrder/Data/StandingOrder/NextPaymentAmountFirstPaymentAmount/Amount

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

String

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

Currency

1..1

OBReadStandingOrder/Data/StandingOrder/NextPaymentAmountFirstPaymentAmount/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".

String

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

_{LastPaymentAmount}NextPaymentAmount

0..1

OBReadStandingOrder/Data/StandingOrder/LastPaymentAmountNextPaymentAmount

The amount of the last (most recent) next Standing Order instruction.

OBReadStandingOrder/Data/StandingOrder/LastPaymentAmountNextPaymentAmount

Amount

1..1

OBReadStandingOrder/Data/StandingOrder/LastPaymentAmountNextPaymentAmount/Amount

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

String

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

Currency

1..1

OBReadStandingOrder/Data/StandingOrder/LastPaymentAmountNextPaymentAmount/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".

String

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

_{FinalPaymentAmount}LastPaymentAmount

0..1

OBReadStandingOrder/Data/StandingOrder/FinalPaymentAmountLastPaymentAmount

The amount of the final last (most recent) Standing Order instruction

OBReadStandingOrder/Data/StandingOrder/FinalPaymentAmountLastPaymentAmount

Amount

1..1

OBReadStandingOrder/Data/StandingOrder/FinalPaymentAmountLastPaymentAmount/Amount

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

String

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

Currency

1..1

OBReadStandingOrder/Data/StandingOrder/FinalPaymentAmountLastPaymentAmount/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".

String

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

_{CreditorAgent}FinalPaymentAmount

0..1

OBReadStandingOrder/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.}FinalPaymentAmount

The amount of the final Standing Order

OBReadStandingOrder/Data/StandingOrder/FinalPaymentAmount

Amount

1..1

OBReadStandingOrder/Data/StandingOrder/CreditorAgent

_SchemeNameFinalPaymentAmount/Amount

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

String

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

Currency

1..1

OBReadStandingOrder/Data/StandingOrder/CreditorAgentFinalPaymentAmount/SchemeNameName of the Currency

A code allocated to currency by a Maintenance Agency under an international identification scheme, in a coded form as published in an external list.

_String

_Enum:

_BH.OBF.BICFI

_{Identification}

_1..1

_{OBReadStandingOrder/Data/StandingOrder/CreditorAgent/Identification}

_{Unique and unambiguous identification of the servicing institution.}described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds"

String

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

CreditorAgent

0..1

OBReadStandingOrder/Data/StandingOrder/CreditorAccountProvides the details to identify 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.

OBReadStandingOrder/Data/StandingOrder/CreditorAccountCreditorAgent

SchemeName

1..1

OBReadStandingOrder/Data/StandingOrder/CreditorAccountCreditorAgent/SchemeName

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

String

Enum:

1

BH.OBF.BBAN
_BH.OBF.IBAN
_BH.OBF.PAN

_{Identification}

BICFI

Identification

1..1

OBReadStandingOrder/Data/StandingOrder/CreditorAgent/Identification

Unique and unambiguous identification of the servicing institution

String

CreditorAccount

0..1

OBReadStandingOrder/Data/StandingOrder/CreditorAccount/Identification

_{Beneficiary account identification.}

_String

Provides the details to identify the beneficiary account

OBReadStandingOrder/Data/StandingOrder/CreditorAccount

_NameSchemeName

01..1

OBReadStandingOrder/Data/StandingOrder/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.}SchemeName

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

String

Enum:

BH.OBF.IBAN

Identification

1..1

OBReadStandingOrder/Data/StandingOrder/CreditorAccount/Identification

Beneficiary account identification

String

_{SecondaryIdentification}Name

0..1

OBReadStandingOrder/Data/StandingOrder/CreditorAccount/SecondaryIdentificationName

_{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).}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

String

SupplementaryData

0..1

OBReadStandingOrder/Data/StandingOrder/SupplementaryData

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

OBSupplementaryData

...

5.

...

Usage Example

...

5.

...

1 Bulk

...

5.1.

...

1 Get Standing Orders Request

GET /standing-orders

AuthorizationAuthorisation: Bearer 4ZopnFZFKjr5zDsicSQpLL

x-fapi-auth-date: Tue, 18 Mar 2020 19:43:31 GMT+03:00

x-fapi-customer-ip-address: 204.35.213.15

x-fapi-interaction-id: 75bdc714-b2dg-7676-c759-780d6815689f

Accept: application/json

...

5.1.

...

2 Get Standing Orders Response

200 OK

x-fapi-interaction-id: 75bdc714-b2dg-7676-c759-780d6815689f

Content-Type: application/json

{
  "Data": {
    "StandingOrder": [
      {
        "AccountId": "00345897",
        "StandingOrderId": "2276",
        "Frequency": "Monthly",
        "Reference": "Bill payment",
        "FirstPaymentDateTime": "2020-03-26T10:54:49.225Z"225+03:00”,
        "NextPaymentDateTime": "2020-04-26T10:54:49.225Z":49.225+03:00”,
        "LastPaymentDateTime": "2020-1202-26T10:54:49.225Z"225+03:00”,
        "FinalPaymentDateTime": "2020-1210-26T10:54:49.225Z"225+03:00”,
        "NumberOfPayments": "8",
        "StandingOrderStatusCode": "Active",
        "FirstPaymentAmount": {
          "Amount": "1000",
          "Currency": "BHD"
        },
        "NextPaymentAmount": {
          "Amount": "1000",
          "Currency": "BHD"
        },
        "LastPaymentAmount": {
          "Amount": "1000",
          "Currency": "BHD"
        },
        "FinalPaymentAmount": {
          "Amount": "1000",
          "Currency": "BHD"
        },
        "CreditorAgent": {
          "SchemeName": "BH.OBF.BBAN",
          "Identification": "BH10XYZU00100000001789"
        },
        "CreditorAccount": {
          "SchemeName": "BH.OBF.BBAN",
          "Identification": "BH10XYZU00100000008876",
          "Name": "Asif KhanKhalid Ahmed Ali",
        },
      },

"AccountId": "00135678",

"StandingOrderId": "2277",

"Frequency": "Monthly",

"Reference": "InstallmentInstalment",

"FirstPaymentDateTime": "2020-03-26T10:54:49.225Z"225+03:00”,

"NextPaymentDateTime": "2020-04-26T10:54:49.225Z"225+03:00”,

"LastPaymentDateTime": "2020-1202-26T10:54:49.225Z"225+03:00”,

"FinalPaymentDateTime": "2020-1210-26T10:54:49.225Z"225+03:00”,

"NumberOfPayments": "8",

"StandingOrderStatusCode": "Active",

"FirstPaymentAmount": {

"Amount": "1200",

"Currency": "BHD"

},

"NextPaymentAmount": {

"Amount": "1200",

"Currency": "BHD"

},

"LastPaymentAmount": {

"Amount": "1200",

"Currency": "BHD"

},

"FinalPaymentAmount": {

"Amount": "1200",

"Currency": "BHD"

},

"CreditorAgent": {

"SchemeName": "IBANBH.OBF.BICFI",

"Identification": "BH10BBKU00100000001789"

},

"CreditorAccount": {

"SchemeName": "BH.OBF.IBAN",

"Identification": "BH10XYZU00100000006789",

"Name": "Daniel D'souzaMohammed Ahmed Abdulla",

},

}

]

},

"Links": {

"Self": "www.TBC.com"

},

"Meta": {

"TotalPages": 01,

"FirstAvailableDateTime": "2020-03-26T09:10:17.596Z"596+03:00”,

"LastAvailableDateTime": "2020-03-26T09:10:17.596Z"596+03:00”

}

...

5.2

...

Specific Account

...

5.2.

...

1 Get Account Standing Orders Request

GET /accounts/00345897/standing-orders

AuthorizationAuthorisation: Bearer 4ZopnFZFKjr5zDsicSQpLL

x-fapi-auth-date: Tue, 18 Mar 2020 19:43:31 GMT+03:00

x-fapi-customer-ip-address: 204.35.213.15

x-fapi-interaction-id: 75bdc714-b2dg-7676-c759-780d6815689f

Accept: application/json

...

5.2.

...

2 Get Account Standing Orders Response

200 OK

x-fapi-interaction-id: 75bdc714-b2dg-7676-c759-780d6815689f

Content-Type: application/json

{

"Data": {

"StandingOrder": [

{

"AccountId": "00345897",

"StandingOrderId": "2276",

"Frequency": "Monthly",

"Reference": "Bill payment",

"FirstPaymentDateTime": "2020-03-26T10:54:49.225Z":49.225+03:00”,

"NextPaymentDateTime": "2020-04-26T10:54:49.225Z"225+03:00”,

"LastPaymentDateTime": "2020-1202-26T10:54:49.225Z"225+03:00”,

"FinalPaymentDateTime": "2020-1210-26T10:54:49.225Z"225+03:00”,

"NumberOfPayments": "8",

"StandingOrderStatusCode": "Active",

"FirstPaymentAmount": {

"Amount": "1000",

"Currency": "BHD"

},

"NextPaymentAmount": {

"Amount": "1000",

"Currency": "BHD"

},

"LastPaymentAmount": {

"Amount": "1000",

"Currency": "BHD"

},

"FinalPaymentAmount": {

"Amount": "1000",

"Currency": "BHD"

},

"CreditorAgent": {

"SchemeName": "BH.OBF.BBAN",

"Identification": "BH10XYZU00100000001789"

},

"CreditorAccount": {

"SchemeName": "BH.OBF.BBAN",

"Identification": "BH10XYZU00100000008876",

"Name": "Asif KhanKhalid Ahmed Ali",

},

}

]

},

"Links": {

"Self": "www.TBC.com"

},

"Meta": {

"TotalPages": 01,

"FirstAvailableDateTime": "2020-03-26T09:10:17.596Z"596+03:00”,

"LastAvailableDateTime": "2020-0302-26T09:10:17.596Z"596+03:00”

}

Version	Old Version 1	New Version Current
Changes made by	CBB Admin	CBB Admin
Saved on	Apr 13, 2020	Aug 26, 2020

Page Comparison

Versions Compared

Key

1. Overview

2. Endpoints

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

2.2. GET /standing-orders

3. Data Models

3.1. OBReadStandingOrder

3.1.1 Resource Definition

3.1.2 UML Diagram

3.1.3 Notes

3.1.4 Frequency

3.1.6 Data Dictionary

1. Version Control

2. Overview

3. Endpoints

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

3.2 GET /standing-orders

4. Data Models

4.1 OBReadStandingOrder

4.1.1 Resource Definition

4.1.2 UML Diagram

4.1.3 Notes

4.1.4 Frequency

4.1.5 Permission Codes

4.1.6 Data Dictionary

5.

Usage Example

5.

1 Bulk

5.1.

1 Get Standing Orders Request

5.1.

2 Get Standing Orders Response

5.2

Specific Account

5.2.

1 Get Account Standing Orders Request

5.2.

2 Get Account Standing Orders Response