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.