International Standing Order Payments
- CBB Admin
1. Version Control
Version | Date | Description of Changes |
Bahrain OBF v1.0.0 | 25th Aug 2020 | Initial Release |
2. Overview
The International Standing Orders resource is used by a PISP 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 resource - and available methods.
S. No. | Resource | HTTP Operation | Endpoint | Mandatory | Scope | Grant Type | Message Signing | Idempotency Key | Request Object | Response Object |
3.1 | international-standing-orders | POST | POST /international-standing-orders | Conditional | payments | Authorization Code | Signed Request Signed Response | Yes | OBWriteInternationalStandingOrder | OBWriteInternationalStandingOrderResponse |
3.2 | international-standing-orders | GET | GET /international-standing-orders/{InternationalStandingOrderPaymentId} | Mandatory (if resource POST implemented) | payments | Client Credentials | Signed Response | No | NA | OBWriteInternationalStandingOrderResponse |
3.3 | payment-details | GET | GET /international-standing-orders/{InternationalStandingOrderPaymentId}/payment-details | Optional | payments | Client Credentials | Signed Response | No | NA | OBWritePaymentDetailsResponse |
3.1 POST/international-Standing-orders
Once the international-standing-order-consent has been authorised by the user/customer, the PISP can proceed to submit the international-standing-orders for processing:
This is done by making a POST request to the international-standing-orders endpoint.
This request is an instruction to the ASPSP to begin the international standing order journey. The PISP must submit the international standing order immediately, however, there are some scenarios where the ASPSP may not warehouse the international standing order immediately (e.g. busy periods at the ASPSP).
The PISP must ensure that the Initiation and Risk sections of the international-standing-orders match the corresponding Initiation and Risk sections of the international-standing-order-consent resource. If the two do not match, the ASPSP must not process the request and must respond with a 400 (Bad Request).
Any operations on the international-standing-orders resource will not result in a Status change for the international-standing-orders resource.
3.1.1 Status
An international-standing-orders can only be created if its corresponding international-standing-order-consent resource has the status of "Authorised".
The international-standing-orders resource that is created successfully must have one of the following Status codes:
Status |
InitiationPending |
InitiationFailed |
InitiationCompleted |
3.2 GET /international-standing-orders/{InternationalStandingOrderPaymentId}
A PISP can retrieve the international-standing-orders to check its status.
3.2.1 Status
The international-standing-orders resource must have one of the following Status codes:
Status |
InitiationPending |
InitiationFailed |
InitiationCompleted |
Cancelled |
3.3 GET /international-standing-orders/{InternationalStandingOrderPaymentId}/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 international-standing-orders - payment-details must have one of the following PaymentStatusCode code-set enumerations:
Status |
Accepted |
AcceptedCancellationRequest |
AcceptedTechnicalValidation |
AcceptedCustomerProfile |
AcceptedFundsChecked |
AcceptedWithChange |
Pending |
Rejected |
AcceptedSettlementInProcess |
AcceptedSettlementCompleted |
AcceptedWithoutPosting |
AcceptedCreditSettlementCompleted |
Cancelled |
NoCancellationProcess |
PartiallyAcceptedCancellationRequest |
PartiallyAcceptedTechnicalCorrect |
PaymentCancelled |
PendingCancellationRequest |
Received |
RejectedCancellationRequest |
3.4 State Model
3.4.1 Payment Order
The state model for the international-standing-orders resource describes the initiation status only. I.e., not the subsequent execution of the international-standing-orders.
The definitions for the Status:
S.No. | Status | Status Definition |
1 | InitiationPending | The initiation of the payment order is pending. |
2 | InitiationFailed | The initiation of the payment order has failed. |
3 | InitiationCompleted | The initiation of the payment order is complete. |
4 | Cancelled | Payment initiation has been successfully cancelled after having received a request for cancellation. |
4. Data Model
The Data Dictionary section gives the detail on the payload content for the International Standing Order API flows.
4.1 OBInternationalStandingOrder (Reused Classes)
The OBInternationalStandingOrder class is defined in the international-standing-order-consents page.
4.2 International Standing Order - Request
The OBWriteInternationalStandingOrder object will be used for a call to:
POST /international-standing-orders.
4.2.1 UML Diagram
4.2.2 Notes
The international-standing-orders request object contains the:
ConsentId.
The full Initiation and Risk objects from the international-standing-order-consent request.
The Initiation and Risk sections of the international-standing-orders request must match the Initiation and Risk sections of the corresponding international-standing-order-consent request.
Name | Occurrence | XPath | Enhanced Definition | Class/ Datatype | Codes | Pattern |
OBWriteInternationalStandingOrder |
| OBWriteInternationalStandingOrder |
| OBWriteInternationalStandingOrder |
|
|
Data | 1..1 | OBWriteInternationalStandingOrder/Data |
| OBWriteInternationalStandingOrder/Data |
|
|
ConsentId | 1..1 | OBWriteInternationalStandingOrder/Data/ConsentId | OB: Unique identification as assigned by the ASPSP to uniquely identify the consent resource. | String |
|
|
Initiation | 1..1 | OBWriteInternationalStandingOrder/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 |
|
|
Risk | 1..1 | OBWriteInternationalStandingOrder/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 - Response
The OBWriteInternationalStandingOrderResponse object will be used for a response to a call to:
POST /international-standing-orders.
GET /international-standing-orders/{InternationalStandingOrderPaymentId}.
4.3.1 UML Diagram
4.3.2 Notes
The international-standing-orders response object contains the:
InternationalStandingOrderPaymentId.
ConsentId.
CreationDateTime the international-standing-orders resource was created.
Status and StatusUpdateDateTime of the international-standing-orders resource.
The Charges in the international-standing-order-consent response from the ASPSP.
Refund account details, if requested by PISP as part of the international-scheduled-payment-consents resource.
The Initiation object from the international-standing-order-consent.
4.3.3 Data Dictionary
Name | Occurrence | XPath | Enhanced Definition | Class/ Datatype | Codes | Pattern |
OBWriteInternationalStandingOrderResponse |
| OBWriteInternationalStandingOrderResponse |
| OBWriteInternationalStandingOrderResponse |
|
|
Data | 1..1 | OBWriteInternationalStandingOrderResponse/Data |
| OBWriteInternationalStandingOrderResponse/Data |
|
|
InternationalStandingOrderId | 1..1 | OBWriteInternationalStandingOrderResponse/Data/InternationalStandingOrderId | Unique identification as assigned by the ASPSP to uniquely identify the international standing order resource. | String |
|
|
ConsentId | 1..1 | OBWriteInternationalStandingOrderResponse/Data/ConsentId | Unique identification as assigned by the ASPSP to uniquely identify the consent resource. | String |
|
|
CreationDateTime | 1..1 | OBWriteInternationalStandingOrderResponse/Data/CreationDateTime | Date and time at which the resource was created. | DateTime |
|
|
Status | 1..1 | OBWriteInternationalStandingOrderResponse/Data/Status | Specifies the status of resource in code form. | String | Enum:
|
|
StatusUpdateDateTime | 1..1 | OBWriteInternationalStandingOrderResponse/Data/StatusUpdateDateTime | Date and time at which the resource status was updated. | DateTime |
|
|
Refund | 0..1 | OBWriteInternationalStandingOrderResponse/Data/Refund | Unambiguous identification of the refund account to which a refund will be made as a result of the transaction. | OBInternationalRefundAccount |
|
|
Charges | 0..n | OBWriteInternationalStandingOrderResponse/Data/Charges | Set of elements used to provide details of a charge for the payment initiation. | OBCharge |
|
|
Initiation | 1..1 | OBWriteInternationalStandingOrderResponse/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 |
|
|
4.4 International Standing Order- Payment Details – Response
The OBWritePaymentDetailsResponse object will be used for a response to a call to:
GET /international-standing-orders/{InternationalStandingOrderPaymentId}/payment-details.
4.4.1 UML Diagram
4.4.2 Data Dictionary
Name | Occurrence | XPath | Enhanced Definition | Class/ Datatype | Codes | Pattern |
OBWritePaymentDetailsResponse |
| OBWritePaymentDetailsResponse |
| OBWritePaymentDetailsResponse |
|
|
Data | 1..1 | OBWritePaymentDetailsResponse/Data |
| OBWritePaymentDetailsResponse/Data |
|
|
PaymentStatus | 0..n | OBWritePaymentDetailsResponse/Data/PaymentStatus | Payment status details. | OBWritePaymentDetails |
|
|
5. Usage Example
5.1 POST /international-standing-orders
5.1.1 Request
|
|
|
5.1.2 Response
|
|
|
|
CENTRAL BANK OF BAHRAIN © 2020