International 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 International Standing Order Consent resource is used by a PISP to register an intent to initiate an International Standing Order.
This resource description should be read in conjunction with a compatible Payment Initiation API Profile.
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 | international-standing-order-consents | POST | POST /international-standing-order-consents | Conditional | payments | Client Credentials | Signed Request Signed Response | Yes | OBWriteInternationalStandingOrderConsent | OBWriteInternationalStandingOrderConsentResponse |
3.2 | international-standing-order-consents | GET | GET /international-standing-order-consents/{ConsentId} | Mandatory (if resource POST implemented) | payments | Client Credentials | Signed Response | No | NA | OBWriteInternationalStandingOrderConsentResponse |
3.1 POST/international-standing-order-consents
The API endpoint allows the PISP to ask an ASPSP to create a new international-standing-order-consent resource.
The POST action indicates to the ASPSP that an international 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 international-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 international-standing-order-consent has been created.
Status |
AwaitingAuthorisation |
3.2 GET /international-standing-order-consents/{ConsentId}
A PISP can optionally retrieve a payment consent resource that they have created to check its status.
3.2.1 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 international-standing-order-consent has failed some other ASPSP validation, the Status will be set to "Rejected".
Once an international-standing-orders has been successfully created using the international-standing-order-consent, the Status of the international-standing-order-consent will be set to "Consumed".
The available Status codes for the international-standing-order-consent resource are:
Status |
AwaitingAuthorisation |
Rejected |
Authorised |
Consumed |
3.3 State Model
3.3.1 Payment Order Consent
The state model for the international-standing-order-consent resource follows the generic consent state model.
The definitions for the Status:
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. |
4. Data Model
The Data Dictionary section gives the detail on the payload content for the International Payment API flows.
4.1 OBInternationalStandingOrder (Reused Classes)
This section describes the OBInternationalStandingOrder class which is reused as the Initiation object in the international-standing-order-consent resource.
4.1.1 UML Diagram
4.1.2 Notes
For the OBInternationalStandingOrder Initiation 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 international-standing-order-consent request immediately.
If the ASPSP establishes a problem with the international-standing-order-consent after the API call, the ASPSP must set the Status of the international-standing-order-consent resource to Rejected.
The 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 international-standing-order-consent will be set to Rejected after user/customer authentication.
The CreditorAgent must at least have either of the pairs provided: SchemeName and Identification, or Name and PostalAddress.
Account Identification field usage:
SchemeName is a free-text field which will be populated with identification schemes an ASPSP accepts.
Identification is a field which is populated with the Identification of the account, using the valid identification scheme provided.
Valid Bahrain Account Identification SchemeName values include, but are not restricted to:
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.
Where the “BH.OBF.BBAN” is specified as the SchemeName in the Account Identification Section (CreditorAccount), the identification field must be populated with the full basic bank account number (Basic Bank Account Number (BBAN) - identifier used nationally by financial institutions, ie, in individual countries, generally as part of a National Account Numbering Scheme(s), to uniquely identify the account of a customer).
· Account/Servicer: This is the Data Type for Agent/SchemeName and used to identify the type of Identification used to identify an agent.
Where the "BH.OBF. BICFI" is specified as the SchemeName, the Identification field must be populated with the BIC (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).
Where the "BH.OBF. NCC" is specified as the SchemeName, the Identification field must be populated with the NCC (Valid NCC -National Clearing Code as an option for the accounts that don't have an IBAN, registered in the country identified by the 2 letter ISO-3166 Country code. For example, transfer to India may have Scheme Name as BH.OBF.NCC.IN and Identification can be the IFSC code of the bank/branch in India).
The InstructedAmount object must be populated with the desired Amount and Currency of transfer, regardless of the currency of the DebtorAccount or CreditorAccount, i.e. a user may wish to transfer 100USD from a BHD DebtorAccount (InstructedAmount will be 100USD), or 100BHD to an USD CreditorAccount (the InstructedAmount will be 100BHD).
The CurrencyOfTransfer is used to specify the currency the funds will be transferred i.e., a user/customer may wish to transfer 100BHD from a BH DebtorAccount to a Rupee INR CreditorAccount in India.
The ChargeBearer field is used by the PISP to indicate the bearer of charges. An ASPSP must Reject the Initiation request if the requested charge allocation cannot be fulfilled.
Permission field is restricted to "Create", however, may be extended to "Update" and "Delete" in a future iteration of the specification.
4.1.3 Data Dictionary
Name | Occurrence | XPath | Enhanced Definition | Class/ Datatype | Codes | Pattern |
OBInternationalStandingOrder |
| OBInternationalStandingOrder | The Initiation payload is sent by the initiating party to the ASPSP. It is used to request movement of funds from the debtor account to a creditor for an international standing order. | OBInternationalStandingOrder |
|
|
Frequency | 1..1 | OBInternationalStandingOrder/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 | OBInternationalStandingOrder/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 | OBInternationalStandingOrder/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 | OBInternationalStandingOrder/FirstPaymentDateTime | The date on which the first payment for a Standing Order schedule will be made. | DateTime |
|
|
FinalPaymentDateTime | 0..1 | OBInternationalStandingOrder/FinalPaymentDateTime | The date on which the final payment for a Standing Order schedule will be made. | DateTime |
|
|
Purpose | 0..1 | OBInternationalStandingOrder/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 http://www.iso20022.org . | String |
|
|
ExtendedPurpose | 0..1 | OBInternationalScheduled3/ExtendedPurpose | Specifies the purpose of an international payment, when there is no corresponding 4 character code available in the ISO20022 list of Purpose Codes. | String |
|
|
ChargeBearer | 0..1 | OBInternationalStandingOrder/ChargeBearer | Specifies which party/parties will bear the charges associated with the processing of the payment transaction. | String | Enum:
|
|
CurrencyOfTransfer | 1..1 | OBInternationalStandingOrder/CurrencyOfTransfer | Specifies the currency of the to be transferred amount, which is different from the currency of the debtor's account. | String |
| ^[A-Z]{3,3}$ |
DestinationCountryCode | 0..1 | OBInternationalScheduled3/DestinationCountryCode | Country in which Credit Account is domiciled. Nation with its own government. | String |
| ^[A-Z]{2,2}$ |
InstructedAmount | 1..1 | OBInternationalStandingOrder/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. | OBInternationalStandingOrder/InstructedAmount |
|
|
Amount | 1..1 | OBInternationalStandingOrder/InstructedAmount/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 | OBInternationalStandingOrder/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". | String |
| ^[A-Z]{3,3}$ |
DebtorAccount | 0..1 | OBInternationalStandingOrder/DebtorAccount | Provides the details to identify the debtor account. | OBInternationalStandingOrder/DebtorAccount |
|
|
SchemeName | 1..1 | OBInternationalStandingOrder/DebtorAccount/SchemeName | Name of the identification scheme, in a coded form as published in an external list. | String | Enum:
|
|
Identification | 1..1 | OBInternationalStandingOrder/DebtorAccount/Identification | Identification assigned by an institution to identify an account. This identification is known by the account owner. | String |
|
|
Name | 0..1 | OBInternationalStandingOrder/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 |
|
|
Creditor | 0..1 | OBInternationalStandingOrder/Creditor | Party to which an amount of money is due. | OBInternationalStandingOrder/Creditor |
|
|
Name | 0..1 | OBInternationalStandingOrder/Creditor/Name | Name by which a party is known and which is usually used to identify that party. | String |
|
|
PostalAddress | 0..1 | OBInternationalStandingOrder/Creditor/PostalAddress | Information that locates and identifies a specific address, as defined by postal services. | OBInternationalStandingOrder/Creditor/PostalAddress |
|
|
AddressType | 0..1 | OBInternationalStandingOrder/Creditor/PostalAddress/AddressType | Identifies the nature of the postal address. | String | Enum:
|
|
Department | 0..1 | OBInternationalStandingOrder/Creditor/PostalAddress/Department | Identification of a division of a large organisation or building. | String |
|
|
SubDepartment | 0..1 | OBInternationalStandingOrder/Creditor/PostalAddress/SubDepartment | Identification of a sub-division of a large organisation or building. | String |
|
|
AddressLine | 0..7 | OBInternationalStandingOrder/Creditor/PostalAddress/AddressLine | Information that locates and identifies a specific address, as defined by postal services, presented in free format text. | String |
|
|
StreetName | 0..1 | OBInternationalStandingOrder/Creditor/PostalAddress/StreetName | Name of a street or thoroughfare. | String |
|
|
BuildingNumber | 0..1 | OBInternationalStandingOrder/Creditor/PostalAddress/BuildingNumber | Number that identifies the position of a building on a street. | String |
|
|
PostCode | 0..1 | OBInternationalStandingOrder/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. | String |
|
|
TownName | 0..1 | OBInternationalStandingOrder/Creditor/PostalAddress/TownName | Name of a built-up area, with defined boundaries, and a local government. | String |
|
|
CountrySubDivision | 0..1 | OBInternationalStandingOrder/Creditor/PostalAddress/CountrySubDivision | Identifies a subdivision of a country such as state, region, and county. | String |
|
|
Country | 0..1 | OBInternationalStandingOrder/Creditor/PostalAddress/Country | Nation with its own government. | String |
| ^[A-Z]{2,2}$ |
CreditorAgent | 0..1 | OBInternationalStandingOrder/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. | OBInternationalStandingOrder/CreditorAgent |
|
|
SchemeName | 0..1 | OBInternationalStandingOrder/CreditorAgent/SchemeName | Name of the identification scheme, in a coded form as published in an external list. | String | Enum:
|
|
Identification | 0..1 | OBInternationalStandingOrder/CreditorAgent/Identification | Unique and unambiguous identification of the servicing institution. | String |
|
|
Name | 0..1 | OBInternationalStandingOrder/CreditorAgent/Name | Name by which an agent is known and which is usually used to identify that agent. | String |
|
|
PostalAddress | 0..1 | OBInternationalStandingOrder/CreditorAgent/PostalAddress | Information that locates and identifies a specific address, as defined by postal services. | OBInternationalStandingOrder/CreditorAgent/PostalAddress |
|
|
AddressType | 0..1 | OBInternationalStandingOrder/CreditorAgent/PostalAddress/AddressType | Identifies the nature of the postal address. | OBAddressTypeCode | Enum:
|
|
Department | 0..1 | OBInternationalStandingOrder/CreditorAgent/PostalAddress/Department | Identification of a division of a large organisation or building. | String |
|
|
SubDepartment | 0..1 | OBInternationalStandingOrder/CreditorAgent/PostalAddress/SubDepartment | Identification of a sub-division of a large organisation or building. | String |
|
|
AddressLine | 0..7 | OBInternationalStandingOrder/CreditorAgent/PostalAddress/AddressLine | Information that locates and identifies a specific address, as defined by postal services, presented in free format text. | String |
|
|
StreetName | 0..1 | OBInternationalStandingOrder/CreditorAgent/PostalAddress/StreetName | Name of a street or thoroughfare. | String |
|
|
BuildingNumber | 0..1 | OBInternationalStandingOrder/CreditorAgent/PostalAddress/BuildingNumber | Number that identifies the position of a building on a street. | String |
|
|
PostCode | 0..1 | OBInternationalStandingOrder/CreditorAgent/PostalAddress/PostCode | Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail. | String |
|
|
TownName | 0..1 | OBInternationalStandingOrder/CreditorAgent/PostalAddress/TownName | Name of a built-up area, with defined boundaries, and a local government. | String |
|
|
CountrySubDivision | 0..1 | OBInternationalStandingOrder/CreditorAgent/PostalAddress/CountrySubDivision | Identifies a subdivision of a country such as state, region, and county. | String |
|
|
Country | 0..1 | OBInternationalStandingOrder/CreditorAgent/PostalAddress/Country | Nation with its own government. | String |
| ^[A-Z]{2,2}$ |
CreditorAccount | 1..1 | OBInternationalStandingOrder/CreditorAccount | Provides the details to identify the beneficiary account. | OBInternationalStandingOrder/CreditorAccount |
|
|
SchemeName | 1..1 | OBInternationalStandingOrder/CreditorAccount/SchemeName | Name of the identification scheme, in a coded form as published in an external list. | String | Enum:
|
|
Identification | 1..1 | OBInternationalStandingOrder/CreditorAccount/Identification | Identification assigned by an institution to identify an account. This identification is known by the account owner. | String |
|
|
Name | 1..1 | OBInternationalStandingOrder/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 | OBInternationalStandingOrder/SupplementaryData | Additional information that cannot be captured in the structured fields and/or any other specific block. | OBSupplementaryData1 |
|
|
4.2 International Standing Order Consent – Request
The OBWriteInternationalStandingOrderConsent object will be used for the call to:
POST /international-standing-order-consents.
4.2.1 UML Diagram
4.2.2 Notes
The international-standing-order-consent request contains these objects:
Initiation
Authorisation
SCASupportData
Risk
III. Data Dictionary
Name | Occurrence | XPath | Enhanced Definition | Class/ Datatype | Codes | Pattern |
OBWriteInternationalStandingOrderConsent |
| OBWriteInternationalStandingOrderConsent |
| OBWriteInternationalStandingOrderConsent |
|
|
Data | 1..1 | OBWriteInternationalStandingOrderConsent/Data |
| OBWriteInternationalStandingOrderConsent/Data |
|
|
Permission | 1..1 | OBWriteInternationalStandingOrderConsent/Data/Permission | Specifies the Open Banking service request types. | String | Enum:
|
|
ReadRefundAccount | 0..1 | OBWriteInternationalStandingOrderConsent/Data/ReadRefundAccount | Specifies to share the refund account details with PISP. | String | Enum:
|
|
Initiation | 1..1 | OBWriteInternationalStandingOrderConsent/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 an international standing order. | OBInternationalStandingOrder |
|
|
Authorisation | 0..1 | OBWriteInternationalStandingOrderConsent/Data/Authorisation |
| OBAuthorisation |
|
|
SCASupportData | 0..1 | OBWriteInternationalStandingOrderConsent/Data/SCASupportData | Supporting Data provided by PISP, when requesting SCA Exemption. | OBSCASupportData |
|
|
Risk | 1..1 | OBWriteInternationalStandingOrderConsent/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 International Standing Order Consent - Response
The OBWriteInternationalStandingOrderConsentResponse object will be used for a response to a call to:
POST /international-standing-order-consents.
GET /international-standing-order-consents/{ConsentId}.
4.3.1 UML Diagram
4.3.2 Notes
The international-standing-order-consent response contains the full original payload from the international-standing-order-consent request with the additional elements below:
ConsentId.
CreationDateTime the international-standing-order-consent resource was created.
Status and StatusUpdateDateTime of the international-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 which will be used by the ASPSP to indicate charges, and the ChargeBearer as relevant.
4.3.3 Data Dictionary
Name | Occurrence | XPath | Enhanced Definition | Class/ Datatype | Codes | Pattern |
OBWriteInternationalStandingOrderConsentResponse |
| OBWriteInternationalStandingOrderConsentResponse |
| OBWriteInternationalStandingOrderConsentResponse |
|
|
Data | 1..1 | OBWriteInternationalStandingOrderConsentResponse/Data |
| OBWriteInternationalStandingOrderConsentResponse/Data |
|
|
ConsentId | 1..1 | OBWriteInternationalStandingOrderConsentResponse/Data/ConsentId | Unique identification as assigned by the ASPSP to uniquely identify the consent resource. | String |
|
|
CreationDateTime | 1..1 | OBWriteInternationalStandingOrderConsentResponse/Data/CreationDateTime | Date and time at which the resource was created. | DateTime |
|
|
Status | 1..1 | OBWriteInternationalStandingOrderConsentResponse/Data/Status | Specifies the status of resource in code form. | String | Enum:
|
|
StatusUpdateDateTime | 1..1 | OBWriteInternationalStandingOrderConsentResponse/Data/StatusUpdateDateTime | Date and time at which the resource status was updated. | DateTime |
|
|
Permission | 1..1 | OBWriteInternationalStandingOrderConsentResponse/Data/Permission | Specifies the Open Banking service request types. | String | Enum:
|
|
ReadRefundAccount | 0..1 | OBWriteInternationalStandingOrderConsentResponse/Data/ReadRefundAccount | Specifies to share the refund account details with PISP. | String | Enum:
|
|
CutOffDateTime | 0..1 | OBWriteInternationalStandingOrderConsentResponse/Data/CutOffDateTime | Specified cut-off date and time for the payment consent. | DateTime |
|
|
Charges | 0..n | OBWriteInternationalStandingOrderConsentResponse/Data/Charges | Set of elements used to provide details of a charge for the payment initiation. | OBCharge |
|
|
Initiation | 1..1 | OBWriteInternationalStandingOrderConsentResponse/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 an international standing order. | OBInternationalStandingOrder |
|
|
Authorisation | 0..1 | OBWriteInternationalStandingOrderConsentResponse/Data/Authorisation |
| OBAuthorisation |
|
|
SCASupportData | 0..1 | OBWriteInternationalStandingOrderConsentResponse/Data/SCASupportData | Supporting Data provided by PISP, when requesting SCA Exemption. | OBSCASupportData |
|
|
Risk | 1..1 | OBWriteInternationalStandingOrderConsentResponse/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 /international-standing-order-consents
5.1.1 Request
|
|
|
5.1.2 Response
|
|
|
|
CENTRAL BANK OF BAHRAIN © 2020