# Domestic Standing Order Usage Examples - v4.0
- Standing Order Initiation
# Standing Order Initiation
This set of flows and payload examples are for creating and retrieving a domestic standing order through a PISP:
Diagram source
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
# Create Domestic Standing Order Consent
# 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-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": {
"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": "TransferToThirdParty"
}
}
# 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": "AWAU",
"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": "TransferToThirdParty"
},
"Links": {
"Self": "https://api.alphabank.com/open-banking/v4.0/pisp/domestic-standing-order-consents/SOC-100"
},
"Meta": {}
}
# Create a Domestic Standing Order
# 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-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": "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": "TransferToThirdParty"
}
}
# 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": "RCVD",
"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": "TransferToThirdParty"
},
"Links": {
"Self": "https://api.alphabank.com/open-banking/v4.0/pisp/domestic-standing-orders/SO-SOC-100"
},
"Meta": {}
}
# Get a Domestic Standing Order Consent
# GET /domestic-standing-order-consents/{ConsentId}
GET /domestic-standing-order-consents/SOC-100 HTTP/1.1
Authorization: Bearer 2YotnFZFEjr1zCsicMWpAA
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
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": "AUTH",
"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": "TransferToThirdParty"
},
"Links": {
"Self": "https://api.alphabank.com/open-banking/v4.0/pisp/domestic-standing-order-consents/SOC-100"
},
"Meta": {}
}