Domestic Scheduled Payment Consents - v3.1.2

1. Overview
2. Endpoints
   1. POST /domestic-scheduled-payment-consents
      1. Status
   2. GET /domestic-scheduled-payment-consents/{ConsentId}
      1. Status
   3. State Model
      1. Payment Order Consent
3. Data Model
   1. Reused Classes
      1. OBDomesticScheduled2
         1. UML Diagram
         2. Notes
         3. Data Dictionary
   2. Domestic Scheduled Payment Consent - Request
      1. UML Diagram
      2. Notes
      3. Data Dictionary
   3. Domestic Scheduled Payment Consent - Response
      1. UML Diagram
      2. Notes
      3. Data Dictionary
4. Usage Examples
   1. Create a Domestic Scheduled Payment Consent
      1. POST /domestic-scheduled-payment-consents Request
      2. POST /domestic-scheduled-payment-consents Response

Overview

The Domestic Scheduled Payment Consent resource is used by a PISP to register an intent 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-payment-consents

The API endpoint allows the PISP to ask an ASPSP to create a new domestic-scheduled-payment-consent resource.

• The POST action indicates to the ASPSP that a domestic scheduled payment consent has been staged. At this point, the PSU 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 PSU and PISP) to the ASPSP for the PSU to authorise.
• The ASPSP creates the domestic-scheduled-payment-consent resource and responds with a unique ConsentId to refer to the resource.

Status

• The default Status is “AwaitingAuthorisation” immediately after the domestic-scheduled-payment-consent has been created.

GET /domestic-scheduled-payment-consents/{ConsentId}

A PISP can optionally retrieve a payment consent resource that they have created to check its status.

Status

Once the PSU authorises the payment-consent resource, the Status of the payment-consent resource will be updated with “Authorised”.

If the PSU rejects the consent or the domestic-scheduled-payment-consent has failed some other ASPSP validation, the Status will be set to “Rejected”.

Once a domestic-scheduled-payment has been successfully created using the domestic-scheduled-payment-consent, the Status of the domestic-scheduled-payment-consent will be set to “Consumed”.

The available Status codes for the domestic-scheduled-payment-consent resource are:

State Model

Payment Order Consent

The state model for the domestic-scheduled-payment-consent resource follows the generic consent state model. However, does not use the “Revoked” status, as the consent for a domestic-scheduled-payment is not a long-lived consent.

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

This section describes the OBDomesticScheduled2 class which is reused as the Initiation object in the domestic-scheduled-payment-consent resource.

UML Diagram

Notes

For the OBDomesticScheduled2 Initiation object:

• All elements in the Initiation payload that are specified by the PISP must not be changed via the ASPSP, as this is part of formal consent from the PSU.
• If the ASPSP is able to establish a problem with payload or any contextual error during the API call, the ASPSP must reject the domestic-scheduled-payment-consent consent request immediately.
• If the ASPSP establishes a problem with the domestic-scheduled-payment-consent after the API call, the ASPSP must set the Status of the domestic-scheduled-payment-consent resource to Rejected.
• DebtorAccount is optional as the PISP may not know the account identification details for the PSU.
• If the DebtorAccount is specified by the PISP and is invalid for the PSU, then the domestic-scheduled-payment-consent will be set to Rejected after PSU authentication. Account Identification field usage:
  • Where “UK.OBIE.SortCodeAccountNumber” is specified as the SchemeName in the Account identification section (either DebtorAccount or CreditorAccount), the Identification field must be populated with the 6 digit Sort Code and 8 digit Account Number (a 14 digit field).
  • Where the “UK.OBIE.IBAN” is specified as the SchemeName in the Account identification section (either DebtorAccount or CreditorAccount), the Identification field must be populated with the full IBAN.
  • Neither the InstructionIdentification nor EndToEndIdentification will be used as the domestic-payment-consent resource identifier (ConsentId) as the ConsentId must be uniquely generated by the ASPSP.
• Permission field is restricted to “Create”, however, may be extended to “Update” and “Delete” in a future iteration of the specification.
• LocalInstrument is the requested payment scheme for execution. This is a free-text field.
• RequestedExecutionDateTime allows a PISP to specify the date for an ASPSP to execute the domestic scheduled payment.

Data Dictionary

Domestic Scheduled Payment Consent - Request

The OBWriteDomesticScheduledConsent3 object will be used for the call to:

• POST /domestic-scheduled-payment-consents

UML Diagram

Notes

The domestic-scheduled-payment-consent request contains these objects:

• Initiation
• Authorisation
• SCASupportData
• Risk

Data Dictionary

Domestic Scheduled Payment Consent - Response

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

• POST /domestic-scheduled-payment-consents
• GET /domestic-scheduled-payment-consents/{ConsentId}

UML Diagram

Notes

The domestic-scheduled-payment-consent response contains the full original payload from the domestic-scheduled-payment-consent request with these additional elements:

• ConsentId.
• CreationDateTime the domestic-scheduled-payment-consent resource was created.
• Status and StatusUpdateDateTime of the domestic-scheduled-payment-consent resource.
• Permission field in the original request.
• CutOffDateTime Behaviour is explained in the Payment Initiation API Profile, Section - Payment Restrictions -> CutOffDateTime Behaviour.
• ExpectedExecutionDateTime for the domestic-scheduled-payment resource if created before CutOffDateTIme - the expected DateTime the payment is executed against the Debtor Account. If populated, the ASPSP must update the value with any changes (e.g., after PSU authorisation).
• ExpectedSettlementDateTime for the domestic-scheduled-payment resource if created before CutOffDateTIme - the expected DateTime the payment will be received at the Creditor Account. If populated, the ASPSP must update the value with any changes (e.g., after PSU authorisation).
• Charges array - for the breakdown of applicable ASPSP charges.

Data Dictionary

Usage Examples

Create a Domestic Scheduled Payment Consent

POST /domestic-scheduled-payment-consents Request

POST /domestic-scheduled-payment-consents HTTP/1.1
Authorization: Bearer 2YotnFZFEjr1zCsicMWpAA
x-idempotency-key: FRESCO.21302.GFX.20
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": {
    "Permission": "Create",
    "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-payment-consents 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": {
    "ConsentId": "7290",
    "Permission": "Create",
    "Status": "AwaitingAuthorisation",
    "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"
      }
    }
  },
  "Risk": {
    "PaymentContextCode": "PartyToParty"
  },
  "Links": {
    "Self": "https://api.alphabank.com/open-banking/v3.1/pisp/domestic-scheduled-payment-consents/7290"
  },
  "Meta": {}
}