|
Version | Date | Author | Comments |
---|---|---|---|
3.0 | OB R/W API Team | This is the baseline version. No change from RC3. | |
3.1-draft1 | OB R/W API Team | This is the initial draft version for 3.1. Draft 1 Changes
Errata
| |
3.1-draft2 | OB R/W API Team | Draft2 Changes:
| |
3.1-draft3 | OB R/W API Team | Errata
Draft3 Changes:
| |
3.1 RC1 | OB R/W API Team | RC1 Changes:
| |
3.1 | OB R/W API Team | Version 3.1 final release. No changes from Version 3.1 RC1. |
Resource | HTTP Operation | Endpoint | Mandatory ? | Scope | Grant Type | Message Signing | Idempotency Key | Request Object | Response Object |
---|---|---|---|---|---|---|---|---|---|
domestic-standing-order-consents | POST | POST /domestic-standing-order-consents | Conditional | payments | Client Credentials | Signed Request Signed Response | Yes | OBWriteDomesticStandingOrderConsent2 | OBWriteDomesticStandingOrderConsentResponse2 |
domestic-standing-order-consents | GET | GET /domestic-standing-order-consents/{ConsentId} | Mandatory (if resource POST implemented) | payments | Client Credentials | Signed Response | No | NA | OBWriteDomesticStandingOrderConsentResponse2 |
domestic-standing-orders | POST | POST /domestic-standing-orders | Conditional | payments | Authorization Code | Signed Request Signed Response | Yes | OBWriteDomesticStandingOrder2 | OBWriteDomesticStandingOrderResponse2 |
domestic-standing-orders | GET | GET /domestic-standing-orders/{DomesticStandingOrderId} | Mandatory (if resource POST implemented) | payments | Client Credentials | Signed Response | No | NA | OBWriteDomesticStandingOrderResponse2 |
POST /domestic-standing-order-consents |
The API endpoint allows the PISP to ask an ASPSP to create a new domestic-standing-order-consent resource.
The default Status is "AwaitingAuthorisation" immediately after the domestic-standing-order-consent has been created.
Status |
---|
AwaitingAuthorisation |
GET /domestic-standing-order-consents/{ConsentId} |
A PISP can optionally retrieve a payment consent resource that they have created to check its 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-standing-order-consent has failed some other ASPSP validation, the Status will be set to "Rejected".
Once a domestic-standing-order has been successfully created using the domestic-standing-order-consent, the Status of the domestic-standing-order-consent will be set to "Consumed".
The available Status codes for the domestic-standing-order-consent resource are:
Status |
---|
AwaitingAuthorisation |
Rejected |
Authorised |
Consumed |
POST /domestic-standing-orders |
Once the domestic-standing-order-consent has been authorised by the PSU, the PISP can proceed to submitting the domestic-standing-order for processing:
A domestic-standing-order can only be created if its corresponding domestic-standing-order-consent resource has the status of "Authorised".
The domestic-standing-order resource that is created successfully must have one of the following Status codes:
Status |
---|
InitiationPending |
InitiationFailed |
InitiationCompleted |
GET /domestic-standing-orders/{DomesticStandingOrderId} |
A PISP can retrieve the domestic-standing-order to check its status.
The domestic-standing-order resource must have one of the following Status codes:
Status |
---|
InitiationPending |
InitiationFailed |
InitiationCompleted |
The state model for the domestic-standing-order-consent resource follows the generic consent state model. However, does not use the "Revoked" status, as the consent for a domestic-standing-order is not a long-lived consent.
The definitions for the Status:
Status | Status Description | |
---|---|---|
1 | AwaitingAuthorisation | The consent resource is awaiting PSU authorisation. |
2 | Rejected | The consent resource has been rejected. |
3 | Authorised | The consent resource has been successfully authorised. |
4 | Consumed | The consented action has been successfully completed. This does not reflect the status of the consented action. |
The state model for the domestic-standing-order resource describes the initiation status only. I.e., not the subsequent execution of the domestic-standing-order.
The definitions for the Status:
Status | Payment Status Description | |
---|---|---|
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. |
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:
Status | Status Description | |
---|---|---|
1 | AwaitingFurtherAuthorisation | The payment-order resource is awaiting further authorisation. |
2 | Rejected | The payment-order resource has been rejected by an authoriser. |
3 | Authorised | The payment-order resource has been successfully authorised by all required authorisers. |
The Data Dictionary section gives the detail on the payload content for the Domestic Standing Order API flows.
This section describes the OBDomesticStandingOrder2 class, which is reused as the Initiation object in the domestic-standing-order-consent and domestic-standing-order resources.
For the OBDomesticStandingOrder2 Initiation object:
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-standing-order-consent request immediately.
If the ASPSP establishes a problem with the domestic-standing-order-consent after the API call, the ASPSP can set the Status of the domestic-standing-order-consent resource to Rejected
Frequency | Example | Details |
---|---|---|
EvryDay | EvryDay | Every day. |
EvryWorkgDay | EvryWorkgDay | Every working day. |
IntrvlWkDay | IntrvlWkDay:1:3 | Every week, on the 3rd day of the week. |
IntrvlWkDay | IntrvlWkDay:2:3 | Every 2nd week, on the 3rd day of the week. |
WkInMnthDay | WkInMnthDay:2:3 | Every month, on the 2nd week of the month, and on the third day of the week. |
IntrvlMnthDay | IntrvlMnthDay:1:-1 | Every month, on the last day of the month. |
IntrvlMnthDay | IntrvlMnthDay:6:15 | Every 6th month, on the 15th day of the month. |
QtrDay | QtrDay:ENGLISH | Paid on the 25th March, 24th June, 29th September and 25th December. |
Name | Occurrence | XPath | EnhancedDefinition | Class | Codes | Pattern |
---|---|---|---|---|---|---|
OBDomesticStandingOrder2 | OBDomesticStandingOrder2 | 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 a domestic standing order. | OBDomesticStandingOrder2 | |||
Frequency | 1..1 | OBDomesticStandingOrder2/Frequency | Individual Definitions: EvryDay - Every day EvryWorkgDay - Every working day IntrvlWkDay - An interval specified in weeks (01 to 09), and the day within the week (01 to 07) WkInMnthDay - A monthly interval, specifying the week of the month (01 to 05) and day within the week (01 to 07) IntrvlMnthDay - An interval specified in months (between 01 to 06, 12, 24), specifying the day within the month (-5 to -1, 1 to 31) QtrDay - Quarterly (either ENGLISH, SCOTTISH, or RECEIVED). ENGLISH = Paid on the 25th March, 24th June, 29th September and 25th December. SCOTTISH = Paid on the 2nd February, 15th May, 1st August and 11th November. RECEIVED = Paid on the 20th March, 19th June, 24th September and 20th December. Individual Patterns: EvryDay (ScheduleCode) EvryWorkgDay (ScheduleCode) IntrvlWkDay:IntervalInWeeks:DayInWeek (ScheduleCode + IntervalInWeeks + DayInWeek) WkInMnthDay:WeekInMonth:DayInWeek (ScheduleCode + WeekInMonth + DayInWeek) IntrvlMnthDay:IntervalInMonths:DayInMonth (ScheduleCode + IntervalInMonths + DayInMonth) QtrDay: + either (ENGLISH, SCOTTISH or RECEIVED) ScheduleCode + QuarterDay The regular expression for this element combines five smaller versions for each permitted pattern. To aid legibility - the components are presented individually here: EvryDay EvryWorkgDay IntrvlWkDay:0[1-9]:0[1-7] WkInMnthDay:0[1-5]:0[1-7] IntrvlMnthDay:(0[1-6]|12|24):(-0[1-5]|0[1-9]|[12][0-9]|3[01]) QtrDay:(ENGLISH|SCOTTISH|RECEIVED) Full Regular Expression: ^(EvryDay)$|^(EvryWorkgDay)$|^(IntrvlWkDay:0[1-9]:0[1-7])$|^(WkInMnthDay:0[1-5]:0[1-7])$|^(IntrvlMnthDay:(0[1-6]|12|24):(-0[1-5]|0[1-9]|[12][0-9]|3[01]))$|^(QtrDay:(ENGLISH|SCOTTISH|RECEIVED))$ | Max35Text | ^(EvryDay)$|^(EvryWorkgDay)$|^(IntrvlWkDay:0[1-9]:0[1-7])$|^(WkInMnthDay:0[1-5]:0[1-7])$|^(IntrvlMnthDay:(0[1-6]|12|24):(-0[1-5]|0[1-9]|[12][0-9]|3[01]))$|^(QtrDay:(ENGLISH|SCOTTISH|RECEIVED))$ | |
Reference | 0..1 | OBDomesticStandingOrder2/Reference | Unique reference, as assigned by the creditor, to unambiguously refer to the payment transaction. Usage: If available, the initiating party should provide this reference in the structured remittance information, to enable reconciliation by the creditor upon receipt of the amount of money. If the business context requires the use of a creditor reference or a payment remit identification, and only one identifier can be passed through the end-to-end chain, the creditor's reference or payment remittance identification should be quoted in the end-to-end transaction identification. | Max35Text | ||
NumberOfPayments | 0..1 | OBDomesticStandingOrder2/NumberOfPayments | Number of the payments that will be made in completing this frequency sequence including any executed since the sequence start date. | Max35Text | ||
FirstPaymentDateTime | 1..1 | OBDomesticStandingOrder2/FirstPaymentDateTime | The date on which the first payment for a Standing Order schedule will be made. | ISODateTime | ||
RecurringPaymentDateTime | 0..1 | OBDomesticStandingOrder2/RecurringPaymentDateTime | The date on which the first recurring payment for a Standing Order schedule will be made. Usage: This must be populated only if the first recurring date is different to the first payment date. | ISODateTime | ||
FinalPaymentDateTime | 0..1 | OBDomesticStandingOrder2/FinalPaymentDateTime | The date on which the final payment for a Standing Order schedule will be made. | ISODateTime | ||
FirstPaymentAmount | 1..1 | OBDomesticStandingOrder2/FirstPaymentAmount | The amount of the first Standing Order | OBActiveOrHistoricCurrencyAndAmount | ||
Amount | 1..1 | OBDomesticStandingOrder2/FirstPaymentAmount/Amount | A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217. | OBActiveCurrencyAndAmount_SimpleType | ^\d{1,13}\.\d{1,5}$ | |
Currency | 1..1 | OBDomesticStandingOrder2/FirstPaymentAmount/Currency | A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds". | ActiveOrHistoricCurrencyCode | ^[A-Z]{3,3}$ | |
RecurringPaymentAmount | 0..1 | OBDomesticStandingOrder2/RecurringPaymentAmount | The amount of the recurring Standing Order | OBActiveOrHistoricCurrencyAndAmount | ||
Amount | 1..1 | OBDomesticStandingOrder2/RecurringPaymentAmount/Amount | A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217. | OBActiveCurrencyAndAmount_SimpleType | ^\d{1,13}\.\d{1,5}$ | |
Currency | 1..1 | OBDomesticStandingOrder2/RecurringPaymentAmount/Currency | A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds". | ActiveOrHistoricCurrencyCode | ^[A-Z]{3,3}$ | |
FinalPaymentAmount | 0..1 | OBDomesticStandingOrder2/FinalPaymentAmount | The amount of the final Standing Order | OBActiveOrHistoricCurrencyAndAmount | ||
Amount | 1..1 | OBDomesticStandingOrder2/FinalPaymentAmount/Amount | A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217. | OBActiveCurrencyAndAmount_SimpleType | ^\d{1,13}\.\d{1,5}$ | |
Currency | 1..1 | OBDomesticStandingOrder2/FinalPaymentAmount/Currency | A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds". | ActiveOrHistoricCurrencyCode | ^[A-Z]{3,3}$ | |
DebtorAccount | 0..1 | OBDomesticStandingOrder2/DebtorAccount | Provides the details to identify the debtor account. | OBCashAccountDebtor4 | ||
SchemeName | 1..1 | OBDomesticStandingOrder2/DebtorAccount/SchemeName | Name of the identification scheme, in a coded form as published in an external list. | OBExternalAccountIdentification4Code | ||
Identification | 1..1 | OBDomesticStandingOrder2/DebtorAccount/Identification | Identification assigned by an institution to identify an account. This identification is known by the account owner. | Max256Text | ||
Name | 0..1 | OBDomesticStandingOrder2/DebtorAccount/Name | Name of the account, as assigned by the account servicing institution. Usage: The account name is the name or names of the account owner(s) represented at an account level. The account name is not the product name or the nickname of the account. | Max70Text | ||
SecondaryIdentification | 0..1 | OBDomesticStandingOrder2/DebtorAccount/SecondaryIdentification | This is secondary identification of the account, as assigned by the account servicing institution. This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination). | Max34Text | ||
CreditorAccount | 1..1 | OBDomesticStandingOrder2/CreditorAccount | Identification assigned by an institution to identify an account. This identification is known by the account owner. | OBBranchAndFinancialInstitutionIdentification6 | ||
SchemeName | 1..1 | OBDomesticStandingOrder2/CreditorAccount/SchemeName | Name of the identification scheme, in a coded form as published in an external list. | OBExternalFinancialInstitutionIdentification4Code | ||
Identification | 1..1 | OBDomesticStandingOrder2/CreditorAccount/Identification | Identification assigned by an institution to identify an account. This identification is known by the account owner. | Max256Text | ||
Name | 1..1 | OBDomesticStandingOrder2/CreditorAccount/Name | Name of the account, as assigned by the account servicing institution. Usage: The account name is the name or names of the account owner(s) represented at an account level. The account name is not the product name or the nickname of the account. OB: ASPSPs may carry out name validation for Confirmation of Payee, but it is not mandatory. | Max70Text | ||
SecondaryIdentification | 0..1 | OBDomesticStandingOrder2/CreditorAccount/SecondaryIdentification | This is secondary identification of the account, as assigned by the account servicing institution. This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination). | Max34Text | ||
SupplementaryData | 0..1 | OBDomesticStandingOrder2/SupplementaryData | Additional information that can not be captured in the structured fields and/or any other specific block. | OBSupplementaryData1 |
The OBWriteDomesticStandingOrderConsent2 object will be used for the call to:
The domestic-standing-consent request contains these objects:
Name | Occurrence | XPath | EnhancedDefinition | Class | Codes | Pattern |
---|---|---|---|---|---|---|
OBWriteDomesticStandingOrderConsent2 | OBWriteDomesticStandingOrderConsent2 | OBWriteDomesticStandingOrderConsent2 | ||||
Data | 1..1 | OBWriteDomesticStandingOrderConsent2/Data | OBWriteDataDomesticStandingOrderConsent2 | |||
Permission | 1..1 | OBWriteDomesticStandingOrderConsent2/Data/Permission | Specifies the Open Banking service request types. | OBExternalPermissions2Code | Create | |
Initiation | 1..1 | OBWriteDomesticStandingOrderConsent2/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 a domestic standing order. | OBDomesticStandingOrder2 | ||
Authorisation | 0..1 | OBWriteDomesticStandingOrderConsent2/Data/Authorisation | The authorisation type request from the TPP. | OBAuthorisation1 | ||
Risk | 1..1 | OBWriteDomesticStandingOrderConsent2/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. | OBRisk1 |
The OBWriteDomesticStandingOrderConsentResponse2 object will be used for a response to a call to:
The domestic-standing-order-consent response contains the full original payload from the domestic-standing-order-consent request, with the following additional elements:
Name | Occurrence | XPath | EnhancedDefinition | Class | Codes | Pattern |
---|---|---|---|---|---|---|
OBWriteDomesticStandingOrderConsentResponse2 | OBWriteDomesticStandingOrderConsentResponse2 | OBWriteDomesticStandingOrderConsentResponse2 | ||||
Data | 1..1 | OBWriteDomesticStandingOrderConsentResponse2/Data | OBWriteDataDomesticStandingOrderConsentResponse2 | |||
ConsentId | 1..1 | OBWriteDomesticStandingOrderConsentResponse2/Data/ConsentId | OB: Unique identification as assigned by the ASPSP to uniquely identify the consent resource. | Max128Text | ||
CreationDateTime | 1..1 | OBWriteDomesticStandingOrderConsentResponse2/Data/CreationDateTime | Date and time at which the resource was created. | ISODateTime | ||
Status | 1..1 | OBWriteDomesticStandingOrderConsentResponse2/Data/Status | Specifies the status of consent resource in code form. | OBExternalConsentStatus1Code | Authorised AwaitingAuthorisation Consumed Rejected | |
StatusUpdateDateTime | 1..1 | OBWriteDomesticStandingOrderConsentResponse2/Data/StatusUpdateDateTime | Date and time at which the resource status was updated. | ISODateTime | ||
Permission | 1..1 | OBWriteDomesticStandingOrderConsentResponse2/Data/Permission | Specifies the Open Banking service request types. | OBExternalPermissions2Code | Create | |
CutOffDateTime | 0..1 | OBWriteDomesticStandingOrderConsentResponse2/Data/CutOffDateTime | Specified cut-off date and time for the payment consent. | ISODateTime | ||
Charges | 0..n | OBWriteDomesticStandingOrderConsentResponse2/Data/Charges | Set of elements used to provide details of a charge for the payment initiation. | OBCharge2 | ||
Initiation | 1..1 | OBWriteDomesticStandingOrderConsentResponse2/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 a domestic standing order. | OBDomesticStandingOrder2 | ||
Authorisation | 0..1 | OBWriteDomesticStandingOrderConsentResponse2/Data/Authorisation | The authorisation type request from the TPP. | OBAuthorisation1 | ||
Risk | 1..1 | OBWriteDomesticStandingOrderConsentResponse2/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. | OBRisk1 |
The OBWriteDomesticStandingOrder2 object will be used for a call to:
The domestic-standing-order request object contains the:
The Initiation and Risk sections of the domestic-standing-order request must match the Initiation and Risk sections of the corresponding domestic-standing-order-consent request.
Name | Occurrence | XPath | EnhancedDefinition | Class | Codes | Pattern |
---|---|---|---|---|---|---|
OBWriteDomesticStandingOrder2 | OBWriteDomesticStandingOrder2 | OBWriteDomesticStandingOrder2 | ||||
Data | 1..1 | OBWriteDomesticStandingOrder2/Data | OBWriteDataDomesticStandingOrder2 | |||
ConsentId | 1..1 | OBWriteDomesticStandingOrder2/Data/ConsentId | OB: Unique identification as assigned by the ASPSP to uniquely identify the consent resource. | Max128Text | ||
Initiation | 1..1 | OBWriteDomesticStandingOrder2/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 a domestic standing order. | OBDomesticStandingOrder2 | ||
Risk | 1..1 | OBWriteDomesticStandingOrder2/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. | OBRisk1 |
The OBWriteDomesticStandingOrderResponse2 object will be used for a response to a call to:
The domestic-standing-order response object contains the:
Name | Occurrence | XPath | EnhancedDefinition | Class | Codes | Pattern |
---|---|---|---|---|---|---|
OBWriteDomesticStandingOrderResponse2 | OBWriteDomesticStandingOrderResponse2 | OBWriteDomesticStandingOrderResponse2 | ||||
Data | 1..1 | OBWriteDomesticStandingOrderResponse2/Data | OBWriteDataDomesticStandingOrderResponse2 | |||
DomesticStandingOrderId | 1..1 | OBWriteDomesticStandingOrderResponse2/Data/DomesticStandingOrderId | OB: Unique identification as assigned by the ASPSP to uniquely identify the domestic standing order resource. | Max40Text | ||
ConsentId | 1..1 | OBWriteDomesticStandingOrderResponse2/Data/ConsentId | OB: Unique identification as assigned by the ASPSP to uniquely identify the consent resource. | Max128Text | ||
CreationDateTime | 1..1 | OBWriteDomesticStandingOrderResponse2/Data/CreationDateTime | Date and time at which the resource was created. | ISODateTime | ||
Status | 1..1 | OBWriteDomesticStandingOrderResponse2/Data/Status | Specifies the status of the payment order resource. | OBExternalStatus1Code | InitiationCompleted InitiationFailed InitiationPending | |
StatusUpdateDateTime | 1..1 | OBWriteDomesticStandingOrderResponse2/Data/StatusUpdateDateTime | Date and time at which the resource status was updated. | ISODateTime | ||
Charges | 0..n | OBWriteDomesticStandingOrderResponse2/Data/Charges | Set of elements used to provide details of a charge for the payment initiation. | OBCharge2 | ||
Initiation | 1..1 | OBWriteDomesticStandingOrderResponse2/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 a domestic standing order. | OBDomesticStandingOrder2 | ||
MultiAuthorisation | 0..1 | OBWriteDomesticStandingOrderResponse2/Data/MultiAuthorisation | OBMultiAuthorisation1 |
This set of flows and payload examples are for creating and retrieving a domestic standing order through a PISP:
participant PSU participant PISP participant ASPSP Authorisation Server participant ASPSP Resource Server note over PSU, ASPSP Resource Server Step 1: Agree a Domestic Standing Order Initiation end note PSU -> PISP: Agree a standing order initiation note over PSU, ASPSP Resource Server Step 2: Setup a Domestic Standing Order consent end note PISP <-> ASPSP Authorisation Server: Establish TLS 1.2 MA PISP -> ASPSP Authorisation Server: Initiate Client Credentials Grant ASPSP Authorisation Server -> PISP: access-token PISP <-> ASPSP Resource Server: Establish TLS 1.2 MA PISP -> ASPSP Resource Server: POST /domestic-standing-order-consents ASPSP Resource Server -> PISP: HTTP 201 (Created), ConsentId PISP -> PSU: HTTP 302 (Found), Redirect (ConsentId) note over PSU, ASPSP Resource Server Step 3: Authorize consent end note PSU -> ASPSP Authorisation Server: Follow redirect (ConsentId) PSU <-> ASPSP Authorisation Server: authenticate PSU <-> ASPSP Authorisation Server: SCA if required ASPSP Authorisation Server -> PSU: HTTP 302 (Found), Redirect (authorization-code) PSU -> PISP: Follow redirect (authorization-code) PISP <-> ASPSP Authorisation Server: Establish TLS 1.2 MA PISP -> ASPSP Authorisation Server: Exchange authorization-code for access token ASPSP Authorisation Server -> PISP: access-token opt note over PSU, ASPSP Resource Server Step 4: Get status of Domestic Standing Order consent end note PISP <-> ASPSP Resource Server: Establish TLS 1.2 MA PISP -> ASPSP Resource Server: GET /domestic-standing-order-consents/{ConsentId} ASPSP Resource Server -> PISP: HTTP 200 (OK), consent resource end opt note over PSU, ASPSP Resource Server Step 5: Create Domestic Standing Order end note PISP <-> ASPSP Resource Server: Establish TLS 1.2 MA PISP -> ASPSP Resource Server: POST /domestic-standing-orders ASPSP Resource Server -> PISP: HTTP 201 (Created), DomesticStandingOrder resource |
POST /domestic-standing-order-consents
POST /domestic-standing-order-consents HTTP/1.1 Authorization: Bearer 2YotnFZFEjr1zCsicMWpAA x-idempotency-key: FRESCO.21302.GFX.20 x-jws-signature: TGlmZSdzIGEgam91cm5leSBub3QgYSBkZXN0aW5hdGlvbiA=..T2ggZ29vZCBldmVuaW5nIG1yIHR5bGVyIGdvaW5nIGRvd24gPw== x-fapi-financial-id: OB/2017/001 x-fapi-customer-last-logged-time: 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": { "Frequency": "EvryDay", "Reference": "Pocket money for Damien", "FirstPaymentDateTime": "1976-06-06T06:06:06+00:00" "FirstPaymentAmount": { "Amount": "6.66", "Currency": "GBP" }, "RecurringPaymentAmount": { "Amount": "7.00", "Currency": "GBP" }, "FinalPaymentDateTime": "1981-03-20T06:06:06+00:00" "FinalPaymentAmount": { "Amount": "7.00", "Currency": "GBP" }, "DebtorAccount": { "SchemeName": "UK.OBIE.SortCodeAccountNumber", "Identification": "11280001234567", "Name": "Andrea Smith" }, "CreditorAccount": { "SchemeName": "UK.OBIE.SortCodeAccountNumber", "Identification": "08080021325698", "Name": "Bob Clements" } } }, "Risk": { "PaymentContextCode": "PartyToParty" } } |
POST /domestic-standing-order-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": "SOC-100", "CreationDateTime": "1976-01-01T06:06:06+00:00", "Status": "AwaitingAuthorisation", "StatusUpdateDateTime": "1976-06-06T06:06:06+00:00", "Permission": "Create", "Initiation": { "Frequency": "EvryDay", "Reference": "Pocket money for Damien", "FirstPaymentDateTime": "1976-06-06T06:06:06+00:00" "FirstPaymentAmount": { "Amount": "6.66", "Currency": "GBP" }, "RecurringPaymentAmount": { "Amount": "7.00", "Currency": "GBP" }, "FinalPaymentDateTime": "1981-03-20T06:06:06+00:00" "FinalPaymentAmount": { "Amount": "7.00", "Currency": "GBP" }, "DebtorAccount": { "SchemeName": "UK.OBIE.SortCodeAccountNumber", "Identification": "11280001234567", "Name": "Andrea Smith" }, "CreditorAccount": { "SchemeName": "UK.OBIE.SortCodeAccountNumber", "Identification": "08080021325698", "Name": "Bob Clements" } } }, "Risk": { "PaymentContextCode": "PartyToParty" }, "Links": { "Self": "https://api.alphabank.com/open-banking/v3.1/pisp/domestic-standing-order-consents/SOC-100" }, "Meta": {} } |
POST /domestic-standing-orders request
POST /domestic-standing-orders HTTP/1.1 Authorization: Bearer eYJQLMQLMQLM x-idempotency-key: FRESNO.1317.GFX.22 x-jws-signature: TGlmZSdzIGEgam91cm5leSBub3QgYSBkZXN0aW5hdGlvbiA=..T2ggZ29vZCBldmVuaW5nIG1yIHR5bGVyIGdvaW5nIGRvd24gPw== x-fapi-financial-id: OB/2017/001 x-fapi-customer-last-logged-time: 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": "SOC-100", "Initiation": { "Frequency": "EvryDay", "Reference": "Pocket money for Damien", "FirstPaymentDateTime": "1976-06-06T06:06:06+00:00" "FirstPaymentAmount": { "Amount": "6.66", "Currency": "GBP" }, "RecurringPaymentAmount": { "Amount": "7.00", "Currency": "GBP" }, "FinalPaymentDateTime": "1981-03-20T06:06:06+00:00" "FinalPaymentAmount": { "Amount": "7.00", "Currency": "GBP" }, "DebtorAccount": { "SchemeName": "UK.OBIE.SortCodeAccountNumber", "Identification": "11280001234567", "Name": "Andrea Smith" }, "CreditorAccount": { "SchemeName": "UK.OBIE.SortCodeAccountNumber", "Identification": "08080021325698", "Name": "Bob Clements" } } }, "Risk": { "PaymentContextCode": "PartyToParty" } } |
POST /domestic-standing-orders 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": { "DomesticStandingOrderId": "SO-SOC-100", "ConsentId": "SOC-100", "CreationDateTime": "1976-01-01T06:06:06+00:00", "Status": "InitiationCompleted", "StatusUpdateDateTime": "1976-06-06T06:06:06+00:00", "Initiation": { "Frequency": "EvryDay", "Reference": "Pocket money for Damien", "FirstPaymentDateTime": "1976-06-06T06:06:06+00:00" "FirstPaymentAmount": { "Amount": "6.66", "Currency": "GBP" }, "RecurringPaymentAmount": { "Amount": "7.00", "Currency": "GBP" }, "FinalPaymentDateTime": "1981-03-20T06:06:06+00:00" "FinalPaymentAmount": { "Amount": "7.00", "Currency": "GBP" }, "DebtorAccount": { "SchemeName": "UK.OBIE.SortCodeAccountNumber", "Identification": "11280001234567", "Name": "Andrea Smith" }, "CreditorAccount": { "SchemeName": "UK.OBIE.SortCodeAccountNumber", "Identification": "08080021325698", "Name": "Bob Clements" } } }, "Risk": { "PaymentContextCode": "PartyToParty" }, "Links": { "Self": "https://api.alphabank.com/open-banking/v3.1/pisp/domestic-standing-orders/SO-SOC-100" }, "Meta": {} } |
GET /domestic-standing-order-consents/{ConsentId}
GET /domestic-standing-order-consents/SOC-100 HTTP/1.1 Authorization: Bearer 2YotnFZFEjr1zCsicMWpAA x-fapi-financial-id: OB/2017/001 x-fapi-customer-last-logged-time: 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 Accept: application/json |
GET /domestic-standing-order-consents response
HTTP/1.1 200 OK x-fapi-interaction-id: 93bac548-d2de-4546-b106-880a5018460d Content-Type: application/json { "Data": { "ConsentId": "SOC-100", "CreationDateTime": "1976-01-01T06:06:06+00:00", "Status": "Authorised", "StatusUpdateDateTime": "1976-06-06T06:06:06+00:00", "Permission": "Create", "Initiation": { "Frequency": "EvryDay", "Reference": "Pocket money for Damien", "FirstPaymentDateTime": "1976-06-06T06:06:06+00:00" "FirstPaymentAmount": { "Amount": "6.66", "Currency": "GBP" }, "RecurringPaymentAmount": { "Amount": "7.00", "Currency": "GBP" }, "FinalPaymentDateTime": "1981-03-20T06:06:06+00:00" "FinalPaymentAmount": { "Amount": "7.00", "Currency": "GBP" }, "DebtorAccount": { "SchemeName": "UK.OBIE.SortCodeAccountNumber", "Identification": "11280001234567", "Name": "Andrea Smith" }, "CreditorAccount": { "SchemeName": "UK.OBIE.SortCodeAccountNumber", "Identification": "08080021325698", "Name": "Bob Clements" } } }, "Risk": { "PaymentContextCode": "PartyToParty" }, "Links": { "Self": "https://api.alphabank.com/open-banking/v3.1/pisp/domestic-standing-order-consents/SOC-100" }, "Meta": {} } |