1. Version Control
Version | Date | Description of Changes |
Bahrain OBF v1.0.0 | 25th Aug 2020 | Initial Release |
2. Overview
The International Payment Consent resource is used by a PISP to register an intent to initiate an International Future dated Payment.
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 |
2.1 | international-future-dated-payment-consents | POST | POST /international-future-dated-payment-consents | Conditional | payments | Client Credentials | Signed Request Signed Response | Yes | OBWriteInternationalFutureDatedConsent | OBWriteInternationalFutureDatedConsentResponse |
2.2 | international-future-dated-payment-consents | GET | GET /international-future-dated-payment-consents/{ConsentId} | Mandatory (if resource POST implemented) | payments | Client Credentials | Signed Response | No | NA | OBWriteInternationalFutureDatedConsentResponse |
2.3 | international-future-dated-payment-consents | GET | GET /international-future-dated-payment-consents/{ConsentId}/funds-confirmation | Optional | payments | Authorization Code | Signed Response | No | NA | OBWriteFundsConfirmationResponse |
3.1 POST/international-future-dated-payment-consents
The API endpoint allows the PISP to ask an ASPSP to create a new international-future-dated-payment-consent resource.
The POST action indicates to the ASPSP that a payment 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-future-dated-payment-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-future-dated-payment-consent has been created.
Status |
AwaitingAuthorisation |
3.2 GET /international- future-dated-payment-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-future-dated-payment-consent has failed some other ASPSP validation, the Status will be set to "Rejected".
Once an international-future-dated-payment has been successfully created using the international-future-dated-payment-consent, the Status of the international-future-dated-payment-consent will be set to "Consumed".
The available Status codes for the international-future-dated-payment-consent resource are:
Status |
AwaitingAuthorisation |
Rejected |
Authorised |
Consumed |