Domestic Scheduled Payments - v3.1.2

1. Overview
2. Endpoints
   1. POST /domestic-scheduled-payments
      1. Status
   2. GET /domestic-scheduled-payments/{DomesticScheduledPaymentId}
      1. Status
   3. GET /domestic-scheduled-payments/{DomesticScheduledPaymentId}/payment-details
      1. Status
   4. State Model
      1. Payment Order
         1. Multiple Authorisation
3. Data Model
   1. Reused Classes
      1. OBDomesticScheduled2
   2. Domestic Scheduled Payment - Request
      1. UML Diagram
      2. Notes
      3. Data Dictionary
   3. Domestic Scheduled Payment - Response
      1. UML Diagram
      2. Notes
      3. Data Dictionary
   4. Domestic Schedule Payment Order - Payment Details - Response
      1. UML Diagram
      2. Data Dictionary
4. Usage Examples
   1. Create a Domestic Scheduled Payment
      1. POST /domestic-scheduled-payments Request
      2. POST /domestic-scheduled-payments Response

Overview

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

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

Endpoints

POST /domestic-scheduled-payments

Once the domestic-scheduled-payment-consent has been authorised by the PSU, the PISP can proceed to submitting the domestic-scheduled-payment for processing:

• This is done by making a POST request to the domestic-scheduled-payments endpoint.
• This request is an instruction to the ASPSP to begin the domestic scheduled payment journey. The PISP must submit the domestic scheduled payment immediately, however, there are some scenarios where the ASPSP may not warehouse the domestic scheduled payment immediately (e.g., busy periods at the ASPSP)
• The PISP must ensure that the Initiation and Risk sections of the domestic-scheduled-payment match the corresponding Initiation and Risk sections of the domestic-scheduled-payment-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 domestic-scheduled-payment resource will not result in a Status change for the domestic-scheduled-payment resource.

Status

A domestic-scheduled-payment can only be created if its corresponding domestic-scheduled-payment-consent resource has the status of “Authorised”.

The domestic-scheduled-payment resource that is created successfully must have one of the following Status codes:

GET /domestic-scheduled-payments/{DomesticScheduledPaymentId}

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

Status

The domestic-scheduled-payment resource must have one of the following Status codes:

GET /domestic-scheduled-payments/{DomesticScheduledPaymentId}/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.

Status

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

State Model

Payment Order

The state model for the domestic-scheduled-payment resource describes the initiation status only. I.e., not the subsequent execution of the domestic-scheduled-payment.

The definitions for the Status:

Multiple Authorisation

If the payment-order requires multiple authorisations, the Status of the multiple authorisations will be updated in the MultiAuthorisation object.

The definitions for the Status:

Data Model

The data dictionary section gives the detail on the payload content for the Domestic Scheduled Payment API flows.

Reused Classes

OBDomesticScheduled2

The OBDomesticScheduled2 class is defined in the domestic-scheduled-payment-consents page.

Domestic Scheduled Payment - Request

The OBWriteDomesticScheduled2 object will be used for a call to:

• POST /domestic-scheduled-payments

UML Diagram

Notes

The domestic-scheduled-payment request object contains the:

• ConsentId.
• The full Initiation and Risk objects from the domestic-scheduled-payment-consent request.

The Initiation and Risk sections of the domestic-scheduled-payment request must match the Initiation and Risk sections of the corresponding domestic-scheduled-payment-consent request.

Data Dictionary

Domestic Scheduled Payment - Response

The OBWriteDomesticScheduledResponse3 object will be used for a response to a call to:

• POST /domestic-scheduled-payments
• GET /domestic-scheduled-payments/{DomesticScheduledPaymentId}

UML Diagram

Notes

The domestic-scheduled-payment response object contains the:

• DomesticScheduledPaymentId.
• ConsentId.
• CreationDateTime the domestic-scheduled-payment resource was created.
• Status and StatusUpdateDateTime of the domestic-scheduled-payment resource.
• ExpectedExecutionDateTime for the domestic-scheduled-payment resource.
• ExpectedSettlementDateTime for the domestic-scheduled-payment resource.
• Charges array - for the breakdown of applicable ASPSP charges.
• The Initiation object from the domestic-scheduled-payment-consent.
• The MultiAuthorisation object if the domestic-scheduled-payment resource requires multiple authorisations.

Data Dictionary

Domestic Schedule Payment Order - Payment Details - Response

The OBWritePaymentDetailsResponse1 object will be used for a response to a call to:

• GET /domestic-scheduled-payments/{DomesticScheduledPaymentId}/payment-details

UML Diagram

Data Dictionary

Usage Examples

Create a Domestic Scheduled Payment

POST /domestic-scheduled-payments Request

POST /domestic-scheduled-payments HTTP/1.1
Authorization: Bearer 2YotnFZFEjr1zCsicMWpAA
x-idempotency-key: FRESNO.1317.GFX.22
x-jws-signature: TGlmZSdzIGEgam91cm5leSBub3QgYSBkZXN0aW5hdGlvbiA=..T2ggZ29vZCBldmVuaW5nIG1yIHR5bGVyIGdvaW5nIGRvd24gPw==
x-fapi-auth-date:  Sun, 10 Sep 2017 19:43:31 GMT
x-fapi-customer-ip-address: 104.25.212.99
x-fapi-interaction-id: 93bac548-d2de-4546-b106-880a5018460d
Content-Type: application/json
Accept: application/json

{
  "Data": {
    "ConsentId": "7290",
    "Initiation": {
      "InstructionIdentification": "89f0a53a91ee47f6a383536f851d6b5a",
      "RequestedExecutionDateTime": "2018-08-06T00:00:00+00:00",
      "InstructedAmount": {
        "Amount": "200.00",
        "Currency": "GBP"
      },
      "DebtorAccount": {
        "SchemeName": "UK.OBIE.SortCodeAccountNumber",
        "Identification": "11280001234567",
        "Name": "Andrea Frost"
      },
      "CreditorAccount": {
        "SchemeName": "UK.OBIE.SortCodeAccountNumber",
        "Identification": "08080021325698",
        "Name": "Tom Kirkman"
      },
      "RemittanceInformation": {
        "Reference": "DSR-037",
        "Unstructured": "Internal ops code 5120103"
      }
    }
  },
  "Risk": {
    "PaymentContextCode": "PartyToParty"
  }
}

POST /domestic-scheduled-payments Response

HTTP/1.1 201 Created
x-jws-signature: V2hhdCB3ZSBnb3QgaGVyZQ0K..aXMgZmFpbHVyZSB0byBjb21tdW5pY2F0ZQ0K
x-fapi-interaction-id: 93bac548-d2de-4546-b106-880a5018460d
Content-Type: application/json

{
  "Data": {
    "DomesticScheduledPaymentId": "7290-003",
    "ConsentId": "7290",
    "Status": "InitiationPending",
    "CreationDateTime": "2018-05-05T15:15:13+00:00",
    "StatusUpdateDateTime": "2018-05-05T15:15:13+00:00",
    "Initiation": {
      "InstructionIdentification": "89f0a53a91ee47f6a383536f851d6b5a",
      "RequestedExecutionDateTime": "2018-08-06T00:00:00+00:00",
      "InstructedAmount": {
        "Amount": "200.00",
        "Currency": "GBP"
      },
      "DebtorAccount": {
        "SchemeName": "UK.OBIE.SortCodeAccountNumber",
        "Identification": "11280001234567",
        "Name": "Andrea Frost"
      },
      "CreditorAccount": {
        "SchemeName": "UK.OBIE.SortCodeAccountNumber",
        "Identification": "08080021325698",
        "Name": "Tom Kirkman"
      },
      "RemittanceInformation": {
        "Reference": "DSR-037",
        "Unstructured": "Internal ops code 5120103"
      }
    }
  },
  "Links": {
    "Self": "https://api.alphabank.com/open-banking/v3.1/pisp/domestic-scheduled-payments/7290-003"
  },
  "Meta": {}
}