1. Version Control

Version	Date	Description of Changes
Bahrain OBF v1.0.0	28th Oct 2020	Initial Release

2. Overview

The Domestic Payments resource is used by a PISP to initiate a Domestic Payment.

This resource description should be read in conjunction with Payment Initiation API Profile.

3. Endpoints

S. No.	Resource	HTTP Operation	Endpoint	Mandatory	Scope	Grant Type	Message Signing	Idempotency Key	Request Object	Response Object
3.1	domestic-payment	POST	POST /domestic-payments	Mandatory	payments	Authorisation Code	Signed Request Signed Response	Yes	OBWriteDomesticPaymentRequest	OBWriteDomesticPaymentResponse
3.2	domestic-payment	GET	GET /domestic-payments/{DomesticPaymentId}	Mandatory	payments	Client Credentials	Signed Response	No	NA	OBWriteDomesticPaymentResponse
3.3	payment-details	GET	GET /domestic-payments/{DomesticPaymentId}/payment-details	Optional	payments	Client Credentials	Signed Response	No	NA	OBWritePaymentDetailsResponse

3.1 POST /domestic-payment

Once the domestic-payment-consents has been authorised by the user/customer, the PISP can proceed to submit the domestic-payment for processing:

This is done by making a POST request to the domestic-payment endpoint
This request is an instruction to the ASPSP to begin the single domestic payment journey. The domestic-payment must be submitted immediately, however, there are some scenarios where the domestic-payment may not be executed immediately (e.g., busy periods at the ASPSP)
The PISP must ensure that the Initiation and Risk sections of the domestic-payment match the corresponding Initiation and Risk sections of the domestic-payment-consents resource. If the two do not match, the ASPSP must not process the request and must respond with a 400 (Bad Request)

3.1.1 Status

A domestic-payment can only be created if its corresponding domestic-payment-consents resource has the status of "Authorised".

The domestic-payment resource that is created successfully must have one of the following PaymentStatusCode code-set enumerations:

S.No.	Status	Status Definition
1	Pending	Payment initiation or individual transaction included in the payment initiation is pending. Further checks and status update will be performed
2	Rejected	Payment initiation or individual transaction included in the payment initiation has been rejected
3	AcceptedSettlementInProcess	All preceding checks such as technical validation and customer profile were successful and therefore the payment initiation has been accepted for execution
4	AcceptedSettlementCompleted	Settlement on the debtor's account has been completed
5	AcceptedWithoutPosting	Payment instruction included in the credit transfer is accepted without being posted to the creditor customer’s account
6	AcceptedCreditSettlementCompleted	Settlement on the creditor's account has been completed

3.2 GET /domestic-payments/{DomesticPaymentId}

A PISP can retrieve the domestic-payment to check its status.

3.2.1 Status

The domestic-payment resource must have one of the following PaymentStatusCode code-set enumerations:

S.No.	Status	Status Definition
1	Pending	Payment initiation or individual transaction included in the payment initiation is pending. Further checks and status update will be performed
2	Rejected	Payment initiation or individual transaction included in the payment initiation has been rejected
3	AcceptedSettlementInProcess	All preceding checks such as technical validation and customer profile were successful and therefore the payment initiation has been accepted for execution
4	AcceptedSettlementCompleted	Settlement on the debtor's account has been completed
5	AcceptedWithoutPosting	Payment instruction included in the credit transfer is accepted without being posted to the creditor customer’s account
6	AcceptedCreditSettlementCompleted	Settlement on the creditor's account has been completed

3.3 GET /domestic-payments/{DomesticPaymentId}/payment-details

A PISP can retrieve the Details of the underlying payment transaction via this endpoint. This resource allows ASPSPs to return richer list of Payment Statuses, and if available payment scheme related statuses.

3.3.1 Status

The domestic-payment- payment-details must have one of the following PaymentStatusCode code-set enumerations:

Status

Accepted

AcceptedCancellationRequest

AcceptedTechnicalValidation

AcceptedCustomerProfile

AcceptedFundsChecked

AcceptedWithChange

Pending

Rejected

AcceptedSettlementInProcess

AcceptedSettlementCompleted