Domestic Standing Order Consents
- CBB Administrator
1. Version Control
Version | Date | Description of Changes |
Bahrain OBF v1.0.0 | 25th Aug 2020 | Initial Release |
2. Overview
The Domestic Standing Order Consent resource is used by a PISP to register an intent to initiate a Domestic Standing Order.
3. Endpoints
Endpoints for the resources are defined below
S. No. | Resource | HTTP Operation | Endpoint | Mandatory | Scope | Grant Type | Message Signing | Idempotency Key | Request Object | Response Object |
3.1 | domestic-standing-order-consents | POST | POST /domestic-standing-order-consents | Conditional | payments | Client Credentials | Signed Request Signed Response | Yes | OBWriteDomesticStandingOrderConsent | OBWriteDomesticStandingOrderConsentResponse |
3.2 | domestic-standing-order-consents | GET | GET /domestic-standing-order-consents/{ConsentId} | Mandatory (if resource POST implemented) | payments | Client Credentials | Signed Response | No | NA | OBWriteDomesticStandingOrderConsentResponse |
3.1 POST /domestic-standing-order-consents
The API endpoint allows the PISP to ask an ASPSP to create a new domestic-standing-order-consent resource.
The POST action indicates to the ASPSP that a domestic standing order consent has been staged. At this point, the user/customer may not have been identified by the ASPSP, and the request payload may not contain any information of the account that should be debited.
The endpoint allows the PISP to send a copy of the consent (between user/customer and PISP) to the ASPSP for the user/customer to authorise.
The ASPSP creates the domestic-standing-order-consent resource and responds with a unique ConsentId to refer to the resource.
3.1.1 Status
The default Status is "AwaitingAuthorisation" immediately after the domestic-standing-order-consent has been created.
S. No. | Status | Status Definition |
1 | AwaitingAuthorisation | The consent resource is awaiting user/customer authorisation |
3.2 GET /domestic-standing-order-consents/ {ConsentId}
A PISP can optionally retrieve a payment consent resource that they have created to check its status.
Once the user/customer authorises the payment-consent resource - the Status of the payment-consent resource will be updated with "Authorised".
If the user/customer rejects the consent or the domestic-payment-consent has failed some other ASPSP validation, the Status will be set to "Rejected".
Once a domestic-payment has been successfully created using the domestic-payment-consent, the Status of the domestic-payment-consent will be set to "Consumed".
3.1.2 Status
The default Status is "AwaitingAuthorisation" immediately after the domestic-payment-consent has been created.
S. No. | Status | Status Definition |
1 | AwaitingAuthorisation | The consent resource is awaiting user/customer authorisation |
2 | Rejected | The consent resource has been rejected |
3 | Authorised | The consent resource has been successfully authorised |
4 | Consumed | The consented action has been successfully completed. This does not reflect the status of the consented action |
3.3 State Model
3.3.1 Standing Order Consent
The state model for the domestic-standing-order-consent resource follows the generic consent state model.
4. Data Model
The Data Dictionary section gives the detail on the payload content for the Domestic Standing Order API flows.
4.1. OBDomesticStandingOrderInitiation (Reused Classes)
This section describes the OBDomesticStandingOrderInitiation class, which is reused as the Initiation object in the domestic-standing-order-consent resource
4.1.1 UML Diagram
4.1.2 Notes
For the OBDomesticStandingOrderInitiation object:
All elements in the Initiation payload that are specified by the PISP must not be changed via the ASPSP, as this is part of formal consent from the user/customer.
If the ASPSP is able to establish a problem with payload or any contextual error during the API call, the ASPSP must reject the domestic-standing-order-consent request immediately.
If the ASPSP establishes a problem with the domestic-standing-order-consent after the API call, the ASPSP can set the Status of the domestic-standing-order-consent resource to Rejected.
DebtorAccount is optional as the PISP may not know the account identification details for the user/customer.
If the DebtorAccount is specified by the PISP and is invalid for the user/customer, then the domestic-standing-order-consent will be set to Rejected after user/customer authentication.
Account Identification field usage:
Where the "BH.OBF.IBAN" is specified as the SchemeName in the Account Identification section (either DebtorAccount or CreditorAccount), the Identification field must be populated with the full IBAN.
Where the “BH.OBF.PAN” is specified as the SchemeName in the Account identification section (either DebtorAccount or CreditorAccount), the identification field must be populated with the full Primary Account Number - identifier scheme used to identify a card account.
The Permission field is restricted to "Create", however, may be extended to "Update" and "Delete" in a future iteration of the specification.
Either the NumberOfPayments or FinalPaymentDateTime must be specified (not both) if the domestic standing order is not open ended.
The structure allows a PISP to specify a domestic standing order with a different payment amount and date combinations: for the first payment, the recurring payment, and the final payment. The recurring payment (and date) must only be populated if different from the first payment (and date).
If the PISP requests a Frequency that is not supported by the ASPSP, the ASPSP must respond with a 400 HTTP status code.
Frequency example:
Frequency | Example | Details |
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.3 Data Dictionary
Name | Occurrence | XPath | Enhanced Definition | Class/ Datatype | Codes | Pattern |
OBDomesticStandingOrderInitiation |
| OBDomesticStandingOrderInitiation | 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. | OBDomesticStandingOrderInitiation |
|
|
Frequency | 1..1 | OBDomesticStandingOrderInitiation/Frequency | Individual Definitions: Individual Patterns: The regular expression for this element combines five smaller versions for each permitted pattern. To aid legibility - the components are presented individually here: | 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 | OBDomesticStandingOrderInitiation/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 |
|
|
NumberOfPayments | 0..1 | OBDomesticStandingOrderInitiation/NumberOfPayments | Number of the payments that will be made in completing this frequency sequence including any executed since the sequence start date. | String |
|
|
FirstPaymentDateTime | 1..1 | OBDomesticStandingOrderInitiation/FirstPaymentDateTime | The date on which the first payment for a Standing Order schedule will be made. | DateTime |
|
|
RecurringPaymentDateTime | 0..1 | OBDomesticStandingOrderInitiation/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. | DateTime |
|
|
FinalPaymentDateTime | 0..1 | OBDomesticStandingOrderInitiation/FinalPaymentDateTime | The date on which the final payment for a Standing Order schedule will be made. | DateTime |
|
|
FirstPaymentAmount | 1..1 | OBDomesticStandingOrderInitiation/FirstPaymentAmount | The amount of the first Standing Order | OBDomesticStandingOrderInitiation/FirstPaymentAmount |
|
|
Amount | 1..1 | OBDomesticStandingOrderInitiation/FirstPaymentAmount/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,5}$ |
Currency | 1..1 | OBDomesticStandingOrderInitiation/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}$ |
RecurringPaymentAmount | 0..1 | OBDomesticStandingOrderInitiation/RecurringPaymentAmount | The amount of the recurring Standing Order | OBDomesticStandingOrderInitiation/RecurringPaymentAmount |
|
|
Amount | 1..1 | OBDomesticStandingOrderInitiation/RecurringPaymentAmount/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,5}$ |
Currency | 1..1 | OBDomesticStandingOrderInitiation/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". | String |
| ^[A-Z]{3,3}$ |
FinalPaymentAmount | 0..1 | OBDomesticStandingOrderInitiation/FinalPaymentAmount | The amount of the final Standing Order | OBDomesticStandingOrderInitiation/FinalPaymentAmount |
|
|
Amount | 1..1 | OBDomesticStandingOrderInitiation/FinalPaymentAmount/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,5}$ |
Currency | 1..1 | OBDomesticStandingOrderInitiation/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". | String |
| ^[A-Z]{3,3}$ |
DebtorAccount | 0..1 | OBDomesticStandingOrderInitiation/DebtorAccount | Provides the details to identify the debtor account. | OBDomesticStandingOrderInitiation/DebtorAccount |
|
|
SchemeName | 1..1 | OBDomesticStandingOrderInitiation/DebtorAccount/SchemeName | Name of the identification scheme, in a coded form as published in an external list. | String | Enum:
|
|
Identification | 1..1 | OBDomesticStandingOrderInitiation/DebtorAccount/Identification | Identification assigned by an institution to identify an account. This identification is known by the account owner. | String |
|
|
Name | 0..1 | OBDomesticStandingOrderInitiation/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. | String |
|
|
CreditorAccount | 1..1 | OBDomesticStandingOrderInitiation/CreditorAccount | Identification assigned by an institution to identify an account. This identification is known by the account owner. | OBDomesticStandingOrderInitiation/CreditorAccount |
|
|
SchemeName | 1..1 | OBDomesticStandingOrderInitiation/CreditorAccount/SchemeName | Name of the identification scheme, in a coded form as published in an external list. | String | Enum:
|
|
Identification | 1..1 | OBDomesticStandingOrderInitiation/CreditorAccount/Identification | Identification assigned by an institution to identify an account. This identification is known by the account owner. | String |
|
|
Name | 1..1 | OBDomesticStandingOrderInitiation/CreditorAccount/Name | The account name is the name or names of the account owner(s) represented at an account level. Note: the account name is not the product name or the nickname of the account. | String |
|
|
SupplementaryData | 0..1 | OBDomesticStandingOrderInitiation/SupplementaryData | Additional information that cannot be captured in the structured fields and/or any other specific block. | OBSupplementaryData |
|
|
4.2 Domestic Standing Order Consent– Request
The OBWriteDomesticStandingOrderConsent object will be used for the call to:
POST /domestic-standing-order-consents
4.2.1 UML Diagram
4.2.2 Notes
The domestic-standing-consent request contains these objects:
Initiation
Authorisation
SCASupportData
Risk
4.2.3 Data Dictionary
Name | Occurrence | XPath | Enhanced Definition | Class/ Datatype | Codes | Pattern |
OBWriteDomesticStandingOrderConsent |
| OBWriteDomesticStandingOrderConsent |
| OBWriteDomesticStandingOrderConsent |
|
|
Data | 1..1 | OBWriteDomesticStandingOrderConsent/Data |
| OBWriteDomesticStandingOrderConsent/Data |
|
|
Permission | 1..1 | OBWriteDomesticStandingOrderConsent/Data/Permission | Specifies the Open Banking service request types. | String | Enum:
|
|
ReadRefundAccount | 0..1 | OBWriteDomesticStandingOrderConsent/Data/ReadRefundAccount | Specifies to share the refund account details with PISP | String | Enum:
|
|
Initiation | 1..1 | OBWriteDomesticStandingOrderConsent/Data/Initiation | 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. | OBDomesticStandingOrderInitiation |
|
|
Authorisation | 0..1 | OBWriteDomesticStandingOrderConsent/Data/Authorisation | The authorisation type request from the PISP. | OBAuthorisation |
|
|
SCASupportData | 0..1 | OBWriteDomesticStandingOrderConsent/Data/SCASupportData | Supporting Data provided by PISP, when requesting SCA Exemption. | OBSCASupportData |
|
|
Risk | 1..1 | OBWriteDomesticStandingOrderConsent/Risk | The Risk section is sent by the initiating party to the ASPSP. It is used to specify additional details for risk scoring for Payments. | OBRisk |
|
|
4.3 Domestic Standing Order Consent – Response
The OBWriteDomesticStandingOrderConsentResponse object will be used for a response to a call to:
POST /domestic-standing-order-consents.
GET /domestic-standing-order-consents/{ConsentId}.
4.3.1 UML Diagram
4.3.2 Notes
The domestic-standing-order-consent response contains the full original payload from the domestic-standing-order-consent request, with the following additional elements:
ConsentId.
CreationDateTime the domestic-standing-order-consent resource was created.
Status and StatusUpdateDateTime of the domestic-standing-order-consent resource.
Permission field in the original request.
ReadRefundAccount field in the original request.
CutOffDateTime Behaviour is explained in Payment Initiation API Profile.
Charges array - for the breakdown of applicable ASPSP charges.
4.3.3 Data Dictionary
Name | Occurrence | XPath | Enhanced Definition | Class/ Datatype | Codes | Pattern |
OBWriteDometicStandingOrderConsentResponse |
| OBWriteDomesticStandingOrderConsentResponse |
| OBWriteDomesticStandingOrderConsentResponse |
|
|
Data | 1..1 | OBWriteDomesticStandingOrderConsentResponse/Data |
| OBWriteDomesticStandingOrderConsentResponse/Data |
|
|
ConsentId | 1..1 | OBWriteDomesticStandingOrderConsentResponse/Data/ConsentId | Unique identification as assigned by the ASPSP to uniquely identify the consent resource. | String |
|
|
CreationDateTime | 1..1 | OBWriteDomesticStandingOrderConsentResponse/Data/CreationDateTime | Date and time at which the resource was created. | DateTime |
|
|
Status | 1..1 | OBWriteDomesticStandingOrderConsentResponse/Data/Status | Specifies the status of consent resource in code form. | OBExternalConsentStatus1Code | Enum:
|
|
StatusUpdateDateTime | 1..1 | OBWriteDomesticStandingOrderConsentResponse/Data/StatusUpdateDateTime | Date and time at which the resource status was updated. | DateTime |
|
|
Permission | 1..1 | OBWriteDomesticStandingOrderConsentResponse/Data/Permission | Specifies the Open Banking service request types. | String | Enum:
|
|
ReadRefundAccount | 0..1 | OBWriteDomesticStandingOrderConsentResponse/Data/ReadRefundAccount | Specifies to share the refund account details with PISP. | String | Enum:
|
|
CutOffDateTime | 0..1 | OBWriteDomesticStandingOrderConsentResponse/Data/CutOffDateTime | Specified cut-off date and time for the payment consent. | DateTime |
|
|
Charges | 0..n | OBWriteDomesticStandingOrderConsentResponse/Data/Charges | Set of elements used to provide details of a charge for the payment initiation. | OBCharge |
|
|
Initiation | 1..1 | OBWriteDomesticStandingOrderConsentResponse/Data/Initiation | 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. | OBDomesticStandingOrderInitiation |
|
|
Authorisation | 0..1 | OBWriteDomesticStandingOrderConsentResponse/Data/Authorisation | The authorisation type request from the PISP. | OBAuthorisation |
|
|
SCASupportData | 0..1 | OBWriteDomesticStandingOrderConsentResponse/Data/SCASupportData | Supporting Data provided by PISP, when requesting SCA Exemption. | OBSCASupportData |
|
|
Risk | 1..1 | OBWriteDomesticStandingOrderConsentResponse/Risk | The Risk section is sent by the initiating party to the ASPSP. It is used to specify additional details for risk scoring for Payments. | OBRisk |
|
|
5. Usage Example
5.1 POST /domestic-standing-order-consents
5.1.1 Request
|
|
|
5.1.2 Response
|
|
|
5.2 GET /domestic-standing-order-consents/{ConsentId}
5.2.1 Request
|
5.2.2 Response
|
|
|
CENTRAL BANK OF BAHRAIN © 2020