...
S.No. | Resource | HTTP Operation | Endpoint | Mandatory | Scope | Grant Type | Message Signing | Idempotency Key | Request Object | Response Object |
2.1 | domestic-future-dated-payments | POST | POST /domestic-future-dated-payments | Conditional | payments | Authorization Authorisation Code | Signed Request Signed Response | Yes | OBWriteDomesticFutureDatedPayment | OBWriteDomesticFutureDatedPaymentResponse |
2.2 | domestic-future-dated-payments | GET | GET /domestic-future-dated-payments/{DomesticFutureDatedPaymentId} | Mandatory (if resource POST implemented) | payments | Client Credentials | Signed Response | No | No | OBWriteDomesticFutureDatedPaymentResponse |
2.3 | payment-details | GET | GET /domestic-future-dated-payments/{DomesticFutureDatedPaymentId}/payment-details | Optional | payments | Client Credentials | Signed Response | No | No | OBWriteDomesticFutureDatedPaymentIdPaymentDetailsResponse
|
2.4 | domestic-future-dated-payments | PATCH | PATCH /domestic-future-dated-payments/{DomesticFutureDatedPaymentId} | Conditional | payments | Client Credentials | Signed Request Signed Response | No | OBPatchDomesticFutureDatedPayment | OBWriteDomesticFutureDatedPaymentResponse |
2.1 POST/domestic-future-dated-payments
...
Status |
Accepted |
AcceptedCancellationRequest |
AcceptedTechnicalValidation |
AcceptedCustomerProfile |
AcceptedFundsChecked |
AcceptedWithChange |
Pending |
Rejected |
AcceptedSettlementInProcess |
AcceptedSettlementCompleted |
AcceptedWithoutPosting |
AcceptedCreditSettlementCompleted |
Cancelled |
NoCancellationProcess |
PartiallyAcceptedCancellationRequest |
PartiallyAcceptedTechnicalCorrect |
PaymentCancelled |
PendingCancellationRequest |
Received |
RejectedCancellationRequest |
2.4
...
PATCH /domestic-future-dated-payments/{DomesticFutureDatedPaymentId}
PSUs can setup, through PISPs, an instruction to their ASPSPs to cancel a future dated domestic payment.
PISPs can allow cancellation of only those specific payments that are initiated through the respective PISPs portal.
2.4.1 Status
Status |
RejectedCancellationRequest |
AcceptedCancellationRequest |
PendingCancellationRequest |
2.5 State Model
2.5.1 Payment Order Consent
The state model for the domestic-future-dated-payment resource describes the initiation status only. I.e., not the subsequent execution of the domestic-future-dated-payment.
...
Name | Occurrence | XPath | Definition | Class/ Datatype | Codes | Pattern |
OBWriteDomesticFutureDatedPaymentDetailsResponse |
| OBWriteDomesticFutureDatedPaymentDetailsResponse |
| OBWriteDomesticFutureDatedPaymentDetailsResponse |
|
|
Data | 1..1 | OBWriteDomesticFutureDatedPaymentDetailsResponse/Data |
| OBWriteDomesticFutureDatedPaymentDetailsResponse/Data |
|
|
PaymentStatus | 0..n | OBWriteDomesticFutureDatedPaymentDetailsResponse/Data/PaymentStatus | Payment status details. | OBWritePaymentDetails |
|
4. Usage Example
4.1. POST /domestic-future-dated-payments
4.1.1 Request
...
3.5. Domestic Future Dated Payment – Patch Payment Status - Request
The OBPatchDomesticFutureDatedPayment object will be used for the call to:
PATCH /domestic-future-dated-payments
...
Authorization: Bearer 4ZopnFZFKjr5zDsicSQpLL
x-idempotency-key: XYZ.51403.MLT.30
x-jws-signature: LMlmPSqzISEpar72ce5deMGue4RsZMDnZYG1bW6hdPlvriZ=..G1rrM18vVYBmdmRurS6nIR1yFHR8bGZyIJdvaB5nKGRvm35hTr==
x-fapi-auth-date: Tue, 18 Mar 2020 19:43:31 GMT
x-fapi-customer-ip-address: 204.35.213.15
x-fapi-interaction-id: 75bdc714-b2dg-7676-c759-780d6815689f
Content-Type: application/json
Accept: application/json
|
4.1.2 Response
...
/{DomesticFutureDatedPaymentId}
3.5.1 UML Diagram
...
3.5.2 Data Dictionary
Name | Occurrence | XPath | Definition | Class/ Datatype | Codes | Pattern |
OBPatchDomesticFutureDatedPayment |
| OBPatchDomesticFutureDatedPayment |
| OBPatchDomesticFutureDatedPayment |
|
|
Data | 1..1 | OBPatchDomesticFutureDatedPayment/Data |
| OBPatchDomesticFutureDatedPayment/Data |
|
|
ConsentId | 1..1 | OBPatchDomesticFutureDatedPayment/Data/ConsentId | OB: Unique identification as assigned by the ASPSP to uniquely identify the consent resource | String |
| |
Status | 1..1 | OBPatchDomesticFutureDatedPayment/Data /Status | Specifies the status of the payment order resource | String | Enum:
|
4. Usage Example
4.1. POST /domestic-future-dated-payments
4.1.1 Request
|
|
4.1.2 Response
|
|
4.2. PATCH /domestic-future-dated-payments/{DomesticFutureDatedPaymentId}
4.2.1 Request
|
|
4.2.2 Response
|
| string
| 871Z
| Cancelled
| 871Z
| 871Z
| 871Z
|
| "IBAN"
|
| EFT-CSCT-
| 869Z
| "IBAN"
|
| "IBAN"
|
|
|
| Department
| TO_BE_CONFIRMED
| "SubDepartment": "TO_BE_CONFIRMED",
|
| BuildingNumber
| Building 152
|
| Bahrain
|
| 871Z
| 871Z
|