AccountIdstringrequired
AccountId
Get Direct Debits
get
https://https/mocking/api/v1/links/99d6f95a-22f3-4a33-85a1-256fa389e7d8/open-banking/v3.1/aisp/accounts/{AccountId}/direct-debits
Path Parameters
Headers
x-fapi-financial-idstringrequired
The unique id of the ASPSP to which the request is issued. The unique id will be issued by OB.
x-fapi-customer-last-logged-timestring
The time when the PSU last logged in with the TPP.
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below:
Sun, 10 Sep 2017 19:43:31 UTC
Match pattern:^(Mon|Tue|Wed|Thu|Fri|Sat|Sun), \d{2} (Jan|Feb|Mar|Apr|May|Jun|Jul|Aug|Sep|Oct|Nov|Dec) \d{4} \d{2}:\d{2}:\d{2} (GMT|UTC)$
x-fapi-customer-ip-addressstring
The PSU’s IP address if the PSU is currently logged in with the TPP.
x-fapi-interaction-idstring
An RFC4122 UID used as a correlation id.
Authorizationstringrequired
An Authorisation Token as per https://tools.ietf.org/html/rfc6750
x-customer-user-agentstring
Indicates the user-agent that the PSU is using.
Response
application/json; charset=utf-8
Response
application/json; charset=utf-8
Direct Debits Read
OBReadDirectDebit1
* Additional properties are NOT allowed.
Dataobjectrequired
* Additional properties are NOT allowed.
Show Child Parameters
Linksobjectrequired
Links relevant to the payload
* Additional properties are NOT allowed.
Show Child Parameters
Metaobjectrequired
Meta Data relevant to the payload
* Additional properties are NOT allowed.
Show Child Parameters
curl --request GET \
--url https://https/mocking/api/v1/links/99d6f95a-22f3-4a33-85a1-256fa389e7d8/open-banking/v3.1/aisp/accounts//direct-debits \
--header 'Accept: application/json; charset=utf-8' \
--header 'Content-Type: application/json; charset=utf-8' application/json; charset=utf-8
{
"Data": {
"DirectDebit": [
{
"AccountId": "d9116bd5-b268-4319-9855-d25a3cafe119",
"DirectDebitId": "218d2e75-496b-e611-8f61-18a9056583fa",
"DirectDebitStatusCode": "Active",
"MandateIdentification": "NULL",
"Name": "PREMIER PAPER GROUP LIMITED",
"PreviousPaymentAmount": {
"Amount": "17.00",
"Currency": "GBP"
},
"PreviousPaymentDateTime": "2017-11-23T00:00:00Z"
},
{
"AccountId": "d9116bd5-b268-4319-9855-d25a3cafe119",
"DirectDebitId": "4b8d2e75-496b-e611-8f61-18a9056583fa",
"DirectDebitStatusCode": "Active",
"MandateIdentification": "FRINGE57 SEASON 12",
"Name": "CHERRY GODFREY FINANCE LIMITED",
"PreviousPaymentAmount": {
"Amount": "10.00",
"Currency": "GBP"
},
"PreviousPaymentDateTime": "2017-11-23T00:00:00Z"
},
{
"AccountId": "d9116bd5-b268-4319-9855-d25a3cafe119",
"DirectDebitId": "4c8d2e75-496b-e611-8f61-18a9056583fa",
"DirectDebitStatusCode": "Active",
"MandateIdentification": "FRINGE55 SEASON 5",
"Name": "CETELEM (UK) LIMITED",
"PreviousPaymentAmount": {
"Amount": "10.00",
"Currency": "GBP"
},
"PreviousPaymentDateTime": "2017-11-23T00:00:00Z"
},
{
"AccountId": "d9116bd5-b268-4319-9855-d25a3cafe119",
"DirectDebitId": "4d8d2e75-496b-e611-8f61-18a9056583fa",
"DirectDebitStatusCode": "Active",
"MandateIdentification": "FRINGE52 SEASON 14",
"Name": "BAX GLOBAL LTD",
"PreviousPaymentAmount": {
"Amount": "10.00",
"Currency": "GBP"
},
"PreviousPaymentDateTime": "2017-11-23T00:00:00Z"
},
{
"AccountId": "d9116bd5-b268-4319-9855-d25a3cafe119",
"DirectDebitId": "4e8d2e75-496b-e611-8f61-18a9056583fa",
"DirectDebitStatusCode": "Active",
"MandateIdentification": "FRINGE53 SEASON 15",
"Name": "VICTORIA MUTUAL FINANCE LIMITED",
"PreviousPaymentAmount": {
"Amount": "10.00",
"Currency": "GBP"
},
"PreviousPaymentDateTime": "2017-11-23T00:00:00Z"
},
{
"AccountId": "d9116bd5-b268-4319-9855-d25a3cafe119",
"DirectDebitId": "508d2e75-496b-e611-8f61-18a9056583fa",
"DirectDebitStatusCode": "Active",
"MandateIdentification": "FRINGE51 SEASON 19",
"Name": "CENTRE ISLAND DEV TA CROWNE PLAZA",
"PreviousPaymentAmount": {
"Amount": "10.00",
"Currency": "GBP"
},
"PreviousPaymentDateTime": "2017-11-23T00:00:00Z"
},
{
"AccountId": "d9116bd5-b268-4319-9855-d25a3cafe119",
"DirectDebitId": "518d2e75-496b-e611-8f61-18a9056583fa",
"DirectDebitStatusCode": "Active",
"MandateIdentification": "FRINGE52 SEASON 20",
"Name": "BAX GLOBAL LTD",
"PreviousPaymentAmount": {
"Amount": "10.00",
"Currency": "GBP"
},
"PreviousPaymentDateTime": "2017-11-23T00:00:00Z"
},
{
"AccountId": "d9116bd5-b268-4319-9855-d25a3cafe119",
"DirectDebitId": "528d2e75-496b-e611-8f61-18a9056583fa",
"DirectDebitStatusCode": "Active",
"MandateIdentification": "FRINGE53 SEASON 21",
"Name": "VICTORIA MUTUAL FINANCE LIMITED",
"PreviousPaymentAmount": {
"Amount": "10.00",
"Currency": "GBP"
},
"PreviousPaymentDateTime": "2017-11-23T00:00:00Z"
},
{
"AccountId": "d9116bd5-b268-4319-9855-d25a3cafe119",
"DirectDebitId": "538d2e75-496b-e611-8f61-18a9056583fa",
"DirectDebitStatusCode": "Active",
"MandateIdentification": "FRINGE54 SEASON 22",
"Name": "PRATT DEVELOPMENTS",
"PreviousPaymentAmount": {
"Amount": "10.00",
"Currency": "GBP"
},
"PreviousPaymentDateTime": "2017-11-23T00:00:00Z"
},
{
"AccountId": "d9116bd5-b268-4319-9855-d25a3cafe119",
"DirectDebitId": "548d2e75-496b-e611-8f61-18a9056583fa",
"DirectDebitStatusCode": "Active",
"MandateIdentification": "FRINGE55 SEASON 23",
"Name": "CETELEM (UK) LIMITED",
"PreviousPaymentAmount": {
"Amount": "10.00",
"Currency": "GBP"
},
"PreviousPaymentDateTime": "2017-11-23T00:00:00Z"
}
]
},
"Links": {
"Self": "http://example.com/api/accounts/d9116bd5-b268-4319-9855-d25a3cafe119/direct-debits?pageId=1"
},
"Meta": {
"TotalPages": 1
}
}Get Party
get
https://https/mocking/api/v1/links/99d6f95a-22f3-4a33-85a1-256fa389e7d8/open-banking/v3.1/aisp/accounts/{AccountId}/party
Path Parameters
AccountIdstringrequired
AccountId
Headers
x-fapi-financial-idstringrequired
The unique id of the ASPSP to which the request is issued. The unique id will be issued by OB.
x-fapi-customer-last-logged-timestring
The time when the PSU last logged in with the TPP.
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below:
Sun, 10 Sep 2017 19:43:31 UTC
Match pattern:^(Mon|Tue|Wed|Thu|Fri|Sat|Sun), \d{2} (Jan|Feb|Mar|Apr|May|Jun|Jul|Aug|Sep|Oct|Nov|Dec) \d{4} \d{2}:\d{2}:\d{2} (GMT|UTC)$
x-fapi-customer-ip-addressstring
The PSU’s IP address if the PSU is currently logged in with the TPP.
x-fapi-interaction-idstring
An RFC4122 UID used as a correlation id.
Authorizationstringrequired
An Authorisation Token as per https://tools.ietf.org/html/rfc6750
x-customer-user-agentstring
Indicates the user-agent that the PSU is using.
Response
application/json; charset=utf-8
Response
application/json; charset=utf-8
Party Read
OBReadParty1
* Additional properties are NOT allowed.
Dataobjectrequired
* Additional properties are NOT allowed.
Show Child Parameters
Linksobjectrequired
Links relevant to the payload
* Additional properties are NOT allowed.
Show Child Parameters
Metaobjectrequired
Meta Data relevant to the payload
* Additional properties are NOT allowed.
Show Child Parameters
curl --request GET \
--url https://https/mocking/api/v1/links/99d6f95a-22f3-4a33-85a1-256fa389e7d8/open-banking/v3.1/aisp/accounts//party \
--header 'Accept: application/json; charset=utf-8' \
--header 'Content-Type: application/json; charset=utf-8' application/json; charset=utf-8
{
"Data": {
"Party": {
"PartyId": "fc8e3eba-8026-4bce-8901-7a1066bf4e92",
"PartyType": "Sole",
"EmailAddress": "admin@dummycorp.org"
}
},
"Links": {
"Self": "http://example.com/api/accounts/d9116bd5-b268-4319-9855-d25a3cafe119/party"
},
"Meta": {
"TotalPages": 1
}
}Get Scheduled Payments
get
https://https/mocking/api/v1/links/99d6f95a-22f3-4a33-85a1-256fa389e7d8/open-banking/v3.1/aisp/accounts/{AccountId}/scheduled-payments
Path Parameters
AccountIdstringrequired
AccountId
Headers
x-fapi-financial-idstringrequired
The unique id of the ASPSP to which the request is issued. The unique id will be issued by OB.
x-fapi-customer-last-logged-timestring
The time when the PSU last logged in with the TPP.
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below:
Sun, 10 Sep 2017 19:43:31 UTC
Match pattern:^(Mon|Tue|Wed|Thu|Fri|Sat|Sun), \d{2} (Jan|Feb|Mar|Apr|May|Jun|Jul|Aug|Sep|Oct|Nov|Dec) \d{4} \d{2}:\d{2}:\d{2} (GMT|UTC)$
x-fapi-customer-ip-addressstring
The PSU’s IP address if the PSU is currently logged in with the TPP.
x-fapi-interaction-idstring
An RFC4122 UID used as a correlation id.
Authorizationstringrequired
An Authorisation Token as per https://tools.ietf.org/html/rfc6750
x-customer-user-agentstring
Indicates the user-agent that the PSU is using.
Response
application/json; charset=utf-8
Response
application/json; charset=utf-8
Scheduled Payments Read
OBReadScheduledPayment2
* Additional properties are NOT allowed.
Dataobjectrequired
* Additional properties are NOT allowed.
Show Child Parameters
Linksobjectrequired
Links relevant to the payload
* Additional properties are NOT allowed.
Show Child Parameters
Metaobjectrequired
Meta Data relevant to the payload
* Additional properties are NOT allowed.
Show Child Parameters
curl --request GET \
--url https://https/mocking/api/v1/links/99d6f95a-22f3-4a33-85a1-256fa389e7d8/open-banking/v3.1/aisp/accounts//scheduled-payments \
--header 'Accept: application/json; charset=utf-8' \
--header 'Content-Type: application/json; charset=utf-8' application/json; charset=utf-8
{
"Data": {
"ScheduledPayment": [
{
"AccountId": "d9116bd5-b268-4319-9855-d25a3cafe119",
"CreditorAccount": {
"Identification": "09000000050005",
"Name": "Future Dated Payment",
"SchemeName": "SortCodeAccountNumber"
},
"InstructedAmount": {
"Amount": "0.94",
"Currency": "GBP"
},
"Reference": "Future Dated Payment",
"ScheduledPaymentDateTime": "2019-05-03T01:00:00Z",
"ScheduledPaymentId": "d3a02ab3-215a-4499-93fd-c140992066da",
"ScheduledType": "Execution"
},
{
"AccountId": "d9116bd5-b268-4319-9855-d25a3cafe119",
"CreditorAccount": {
"Identification": "09000000050005",
"Name": "Future Dated Payment",
"SchemeName": "SortCodeAccountNumber"
},
"InstructedAmount": {
"Amount": "0.94",
"Currency": "GBP"
},
"Reference": "Future Dated Payment",
"ScheduledPaymentDateTime": "2019-05-03T01:00:00Z",
"ScheduledPaymentId": "ad828d76-1c40-43a4-aef7-868a393d58b4",
"ScheduledType": "Execution"
},
{
"AccountId": "d9116bd5-b268-4319-9855-d25a3cafe119",
"CreditorAccount": {
"Identification": "09000000050005",
"Name": "Future Dated Payment",
"SchemeName": "SortCodeAccountNumber"
},
"InstructedAmount": {
"Amount": "0.94",
"Currency": "GBP"
},
"Reference": "Future Dated Payment",
"ScheduledPaymentDateTime": "2019-05-27T01:00:00Z",
"ScheduledPaymentId": "e060f539-6fa7-4fd5-9cdf-a0accf56f460",
"ScheduledType": "Execution"
},
{
"AccountId": "d9116bd5-b268-4319-9855-d25a3cafe119",
"CreditorAccount": {
"Identification": "09000000050005",
"Name": "Future Dated Payment",
"SchemeName": "SortCodeAccountNumber"
},
"InstructedAmount": {
"Amount": "0.94",
"Currency": "GBP"
},
"Reference": "Future Dated Payment",
"ScheduledPaymentDateTime": "2019-06-30T01:00:00Z",
"ScheduledPaymentId": "260d554c-f2b9-47dc-8a20-5f76beb61db8",
"ScheduledType": "Execution"
},
{
"AccountId": "d9116bd5-b268-4319-9855-d25a3cafe119",
"CreditorAccount": {
"Identification": "09000000050005",
"Name": "Future Dated Payment",
"SchemeName": "SortCodeAccountNumber"
},
"InstructedAmount": {
"Amount": "0.94",
"Currency": "GBP"
},
"Reference": "Future Dated Payment",
"ScheduledPaymentDateTime": "2019-06-30T01:00:00Z",
"ScheduledPaymentId": "7b784459-6e5f-4c0f-84a6-f746050efad6",
"ScheduledType": "Execution"
},
{
"AccountId": "d9116bd5-b268-4319-9855-d25a3cafe119",
"CreditorAccount": {
"Identification": "09000000050005",
"Name": "Future Dated Payment",
"SchemeName": "SortCodeAccountNumber"
},
"InstructedAmount": {
"Amount": "0.94",
"Currency": "GBP"
},
"Reference": "Future Dated Payment",
"ScheduledPaymentDateTime": "2019-07-06T01:00:00Z",
"ScheduledPaymentId": "ff1057dd-de28-4754-9d05-ef9b3ae18878",
"ScheduledType": "Execution"
},
{
"AccountId": "d9116bd5-b268-4319-9855-d25a3cafe119",
"CreditorAccount": {
"Identification": "09000000050005",
"Name": "Future Dated Payment",
"SchemeName": "SortCodeAccountNumber"
},
"InstructedAmount": {
"Amount": "0.94",
"Currency": "GBP"
},
"Reference": "Future Dated Payment",
"ScheduledPaymentDateTime": "2019-07-11T01:00:00Z",
"ScheduledPaymentId": "b25893e0-0108-4772-9b69-dd4b997a3337",
"ScheduledType": "Execution"
},
{
"AccountId": "d9116bd5-b268-4319-9855-d25a3cafe119",
"CreditorAccount": {
"Identification": "09000000050005",
"Name": "Future Dated Payment",
"SchemeName": "SortCodeAccountNumber"
},
"InstructedAmount": {
"Amount": "0.94",
"Currency": "GBP"
},
"Reference": "Future Dated Payment",
"ScheduledPaymentDateTime": "2019-07-11T01:00:00Z",
"ScheduledPaymentId": "6caa7a73-772b-444e-88ac-60a740d0112a",
"ScheduledType": "Execution"
},
{
"AccountId": "d9116bd5-b268-4319-9855-d25a3cafe119",
"CreditorAccount": {
"Identification": "09000000050005",
"Name": "Future Dated Payment",
"SchemeName": "SortCodeAccountNumber"
},
"InstructedAmount": {
"Amount": "0.94",
"Currency": "GBP"
},
"Reference": "Future Dated Payment",
"ScheduledPaymentDateTime": "2019-07-11T01:00:00Z",
"ScheduledPaymentId": "d5f12ca8-136f-42fe-8d61-958aeee37217",
"ScheduledType": "Execution"
},
{
"AccountId": "d9116bd5-b268-4319-9855-d25a3cafe119",
"CreditorAccount": {
"Identification": "09000000050005",
"Name": "Future Dated Payment",
"SchemeName": "SortCodeAccountNumber"
},
"InstructedAmount": {
"Amount": "0.94",
"Currency": "GBP"
},
"Reference": "Future Dated Payment",
"ScheduledPaymentDateTime": "2019-07-11T01:00:00Z",
"ScheduledPaymentId": "302dc36b-9bc1-4902-8a4f-ed0ad993f4c0",
"ScheduledType": "Execution"
}
]
},
"Links": {
"Self": "http://example.com/api/accounts/d9116bd5-b268-4319-9855-d25a3cafe119/scheduled-payments?pageId=1"
},
"Meta": {
"TotalPages": 1
}
}Get Standing Orders
get
https://https/mocking/api/v1/links/99d6f95a-22f3-4a33-85a1-256fa389e7d8/open-banking/v3.1/aisp/accounts/{AccountId}/standing-orders
Path Parameters
AccountIdstringrequired
AccountId
Headers
x-fapi-financial-idstringrequired
The unique id of the ASPSP to which the request is issued. The unique id will be issued by OB.
x-fapi-customer-last-logged-timestring
The time when the PSU last logged in with the TPP.
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below:
Sun, 10 Sep 2017 19:43:31 UTC
Match pattern:^(Mon|Tue|Wed|Thu|Fri|Sat|Sun), \d{2} (Jan|Feb|Mar|Apr|May|Jun|Jul|Aug|Sep|Oct|Nov|Dec) \d{4} \d{2}:\d{2}:\d{2} (GMT|UTC)$
x-fapi-customer-ip-addressstring
The PSU’s IP address if the PSU is currently logged in with the TPP.
x-fapi-interaction-idstring
An RFC4122 UID used as a correlation id.
Authorizationstringrequired
An Authorisation Token as per https://tools.ietf.org/html/rfc6750
x-customer-user-agentstring
Indicates the user-agent that the PSU is using.
Response
application/json; charset=utf-8
Response
application/json; charset=utf-8
Standing Orders Read
OBReadStandingOrder4
* Additional properties are NOT allowed.
Dataobjectrequired
* Additional properties are NOT allowed.
Show Child Parameters
Linksobjectrequired
Links relevant to the payload
* Additional properties are NOT allowed.
Show Child Parameters
Metaobjectrequired
Meta Data relevant to the payload
* Additional properties are NOT allowed.
Show Child Parameters
curl --request GET \
--url https://https/mocking/api/v1/links/99d6f95a-22f3-4a33-85a1-256fa389e7d8/open-banking/v3.1/aisp/accounts//standing-orders \
--header 'Accept: application/json; charset=utf-8' \
--header 'Content-Type: application/json; charset=utf-8' application/json; charset=utf-8
{
"Data": {
"StandingOrder": [
{
"AccountId": "d9116bd5-b268-4319-9855-d25a3cafe119",
"StandingOrderId": "a9df3a14-0174-e611-9153-18a9056583fa",
"Frequency": "EvryWorkgDay",
"Reference": "SO0004",
"NextPaymentDateTime": "2018-02-07T00:00:00Z",
"NextPaymentAmount": {
"Amount": "1500.00",
"Currency": "GBP"
},
"FinalPaymentDateTime": "1899-12-30T00:00:00Z",
"FinalPaymentAmount": {
"Amount": "1500.00",
"Currency": "GBP"
},
"StandingOrderStatusCode": "Active",
"CreditorAccount": {
"SchemeName": "SortCodeAccountNumber",
"Identification": "15990040040001",
"Name": "ADAM PAUL STEVENS"
}
},
{
"AccountId": "d9116bd5-b268-4319-9855-d25a3cafe119",
"StandingOrderId": "b9df3a14-0174-e611-9153-18a9051583fa",
"Frequency": "EvryWorkgDay",
"Reference": "SO0004",
"NextPaymentDateTime": "2018-02-07T00:00:00Z",
"NextPaymentAmount": {
"Amount": "200.00",
"Currency": "GBP"
},
"FinalPaymentDateTime": "1899-12-30T00:00:00Z",
"FinalPaymentAmount": {
"Amount": "200.00",
"Currency": "GBP"
},
"StandingOrderStatusCode": "Active",
"CreditorAccount": {
"SchemeName": "SortCodeAccountNumber",
"Identification": "15990040040001",
"Name": "ADAM PAUL STEVENS"
}
},
{
"AccountId": "d9116bd5-b268-4319-9855-d25a3cafe119",
"StandingOrderId": "d8df3a14-0174-e611-9153-18a9056583ca",
"Frequency": "EvryWorkgDay",
"Reference": "SO0002",
"NextPaymentDateTime": "2018-02-07T00:00:00Z",
"NextPaymentAmount": {
"Amount": "22.00",
"Currency": "GBP"
},
"FinalPaymentDateTime": "1899-12-30T00:00:00Z",
"FinalPaymentAmount": {
"Amount": "22.00",
"Currency": "GBP"
},
"StandingOrderStatusCode": "Active",
"CreditorAccount": {
"SchemeName": "SortCodeAccountNumber",
"Identification": "15990040040001",
"Name": "ADAM PAUL STEVENS"
}
},
{
"AccountId": "d9116bd5-b268-4319-9855-d25a3cafe119",
"StandingOrderId": "d7df3a14-0174-e611-9153-18a9056583da",
"Frequency": "EvryWorkgDay",
"Reference": "SO0001",
"NextPaymentDateTime": "2018-02-07T00:00:00Z",
"NextPaymentAmount": {
"Amount": "111.00",
"Currency": "GBP"
},
"FinalPaymentDateTime": "1899-12-30T00:00:00Z",
"FinalPaymentAmount": {
"Amount": "111.00",
"Currency": "GBP"
},
"StandingOrderStatusCode": "Active",
"CreditorAccount": {
"SchemeName": "SortCodeAccountNumber",
"Identification": "15990040040001",
"Name": "ADAM PAUL STEVENS"
}
},
{
"AccountId": "d9116bd5-b268-4319-9855-d25a3cafe119",
"StandingOrderId": "f3df3a14-0174-e611-9153-18a9056583fa",
"Frequency": "EvryWorkgDay",
"Reference": "SO0010",
"NextPaymentDateTime": "2018-02-07T00:00:00Z",
"NextPaymentAmount": {
"Amount": "11.00",
"Currency": "GBP"
},
"FinalPaymentDateTime": "1899-12-30T00:00:00Z",
"FinalPaymentAmount": {
"Amount": "11.00",
"Currency": "GBP"
},
"StandingOrderStatusCode": "Active",
"CreditorAccount": {
"SchemeName": "SortCodeAccountNumber",
"Identification": "15990040040001",
"Name": "ADAM PAUL STEVENS"
}
},
{
"AccountId": "d9116bd5-b268-4319-9855-d25a3cafe119",
"StandingOrderId": "e7df3a14-0174-e611-9153-18a9056583fa",
"Frequency": "EvryWorkgDay",
"Reference": "SO0002",
"NextPaymentDateTime": "2018-02-07T00:00:00Z",
"NextPaymentAmount": {
"Amount": "22.22",
"Currency": "GBP"
},
"FinalPaymentDateTime": "1899-12-30T00:00:00Z",
"FinalPaymentAmount": {
"Amount": "22.22",
"Currency": "GBP"
},
"StandingOrderStatusCode": "Active",
"CreditorAccount": {
"SchemeName": "SortCodeAccountNumber",
"Identification": "15990040040001",
"Name": "ADAM PAUL STEVENS"
}
},
{
"AccountId": "d9116bd5-b268-4319-9855-d25a3cafe119",
"StandingOrderId": "cedf3a14-0174-e611-9153-18a9056583fa",
"Frequency": "EvryWorkgDay",
"Reference": "SO0003",
"NextPaymentDateTime": "2018-02-07T00:00:00Z",
"NextPaymentAmount": {
"Amount": "133.00",
"Currency": "GBP"
},
"FinalPaymentDateTime": "1899-12-30T00:00:00Z",
"FinalPaymentAmount": {
"Amount": "133.00",
"Currency": "GBP"
},
"StandingOrderStatusCode": "Active",
"CreditorAccount": {
"SchemeName": "SortCodeAccountNumber",
"Identification": "15990040040001",
"Name": "ADAM PAUL STEVENS"
}
},
{
"AccountId": "d9116bd5-b268-4319-9855-d25a3cafe119",
"StandingOrderId": "cfdf3a14-0174-e611-9153-18a9056583fa",
"Frequency": "EvryWorkgDay",
"Reference": "SO0004",
"NextPaymentDateTime": "2018-02-07T00:00:00Z",
"NextPaymentAmount": {
"Amount": "134.00",
"Currency": "GBP"
},
"FinalPaymentDateTime": "1899-12-30T00:00:00Z",
"FinalPaymentAmount": {
"Amount": "134.00",
"Currency": "GBP"
},
"StandingOrderStatusCode": "Active",
"CreditorAccount": {
"SchemeName": "SortCodeAccountNumber",
"Identification": "15990040040001",
"Name": "ADAM PAUL STEVENS"
}
},
{
"AccountId": "d9116bd5-b268-4319-9855-d25a3cafe119",
"StandingOrderId": "cddf3a14-0174-e611-9153-18a9056583fa",
"Frequency": "EvryWorkgDay",
"Reference": "SO0002",
"NextPaymentDateTime": "2018-02-07T00:00:00Z",
"NextPaymentAmount": {
"Amount": "111.00",
"Currency": "GBP"
},
"FinalPaymentDateTime": "1899-12-30T00:00:00Z",
"FinalPaymentAmount": {
"Amount": "111.00",
"Currency": "GBP"
},
"StandingOrderStatusCode": "Active",
"CreditorAccount": {
"SchemeName": "SortCodeAccountNumber",
"Identification": "15990040040001",
"Name": "ADAM PAUL STEVENS"
}
},
{
"AccountId": "d9116bd5-b268-4319-9855-d25a3cafe119",
"StandingOrderId": "d0df3a14-0174-e611-9153-18a9056583fa",
"Frequency": "EvryWorkgDay",
"Reference": "SO0005",
"NextPaymentDateTime": "2018-02-07T00:00:00Z",
"NextPaymentAmount": {
"Amount": "122.00",
"Currency": "GBP"
},
"FinalPaymentDateTime": "1899-12-30T00:00:00Z",
"FinalPaymentAmount": {
"Amount": "122.00",
"Currency": "GBP"
},
"StandingOrderStatusCode": "Active",
"CreditorAccount": {
"SchemeName": "SortCodeAccountNumber",
"Identification": "15990040040001",
"Name": "ADAM PAUL STEVENS"
}
}
]
},
"Links": {
"Self": "http://example.com/api/accounts/d9116bd5-b268-4319-9855-d25a3cafe119/standing-orders?pageId=1"
},
"Meta": {
"TotalPages": 1
}
}Get Transactions
get
https://https/mocking/api/v1/links/99d6f95a-22f3-4a33-85a1-256fa389e7d8/open-banking/v3.1/aisp/accounts/{AccountId}/transactions
Query Parameters
fromBookingDateTimestring(date-time)
The UTC ISO 8601 Date Time to filter transactions FROM
NB Time component is optional - set to 00:00:00 for just Date.
If the Date Time contains a timezone, the ASPSP must ignore the timezone component.
toBookingDateTimestring(date-time)
The UTC ISO 8601 Date Time to filter transactions TO
NB Time component is optional - set to 00:00:00 for just Date.
If the Date Time contains a timezone, the ASPSP must ignore the timezone component.
Path Parameters
AccountIdstringrequired
AccountId
Headers
x-fapi-financial-idstringrequired
The unique id of the ASPSP to which the request is issued. The unique id will be issued by OB.
x-fapi-customer-last-logged-timestring
The time when the PSU last logged in with the TPP.
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below:
Sun, 10 Sep 2017 19:43:31 UTC
Match pattern:^(Mon|Tue|Wed|Thu|Fri|Sat|Sun), \d{2} (Jan|Feb|Mar|Apr|May|Jun|Jul|Aug|Sep|Oct|Nov|Dec) \d{4} \d{2}:\d{2}:\d{2} (GMT|UTC)$
x-fapi-customer-ip-addressstring
The PSU’s IP address if the PSU is currently logged in with the TPP.
x-fapi-interaction-idstring
An RFC4122 UID used as a correlation id.
Authorizationstringrequired
An Authorisation Token as per https://tools.ietf.org/html/rfc6750
x-customer-user-agentstring
Indicates the user-agent that the PSU is using.
Response
application/json; charset=utf-8
Response
application/json; charset=utf-8
Transactions Read
OBReadTransaction4
* Additional properties are NOT allowed.
Dataobjectrequired
* Additional properties are NOT allowed.
Show Child Parameters
Linksobjectrequired
Links relevant to the payload
* Additional properties are NOT allowed.
Show Child Parameters
Metaobjectrequired
Meta Data relevant to the payload
* Additional properties are NOT allowed.
Show Child Parameters
curl --request GET \
--url https://https/mocking/api/v1/links/99d6f95a-22f3-4a33-85a1-256fa389e7d8/open-banking/v3.1/aisp/accounts//transactions \
--header 'Accept: application/json; charset=utf-8' \
--header 'Content-Type: application/json; charset=utf-8' application/json; charset=utf-8
{
"Data": {
"Transaction": [
{
"AccountId": "18a4f094-8ca3-422d-aa7c-eb6efe850e4c",
"TransactionId": "748a5e30-0cd6-4a31-ac50-28b4216482eb",
"Amount": {
"Amount": "99.41",
"Currency": "GBP"
},
"CreditDebitIndicator": "Debit",
"BookingDateTime": "2015-12-12T00:00:00Z",
"ValueDateTime": "2015-12-12T00:00:00Z",
"ProprietaryBankTransactionCode": {
"Code": "Visa Card Item",
"Issuer": "C. Hoare & Co."
},
"CardInstrument": {
"CardSchemeName": "VISA",
"Identification": "453976XXXXXX1565",
"Name": "STEVE Smith - HSE A/C"
},
"Status": "Booked"
},
{
"AccountId": "18a4f094-8ca3-422d-aa7c-eb6efe850e4c",
"TransactionId": "920c829f-c543-4f07-9ef0-e9d065cf4762",
"Amount": {
"Amount": "345.41",
"Currency": "GBP"
},
"CreditDebitIndicator": "Debit",
"BookingDateTime": "2015-12-12T00:00:00Z",
"ValueDateTime": "2015-12-12T00:00:00Z",
"ProprietaryBankTransactionCode": {
"Code": "Visa Card Item",
"Issuer": "C. Hoare & Co."
},
"CardInstrument": {
"CardSchemeName": "VISA",
"Identification": "453976XXXXXX1565",
"Name": "STEVE Smith - HSE A/C"
},
"Status": "Booked"
},
{
"AccountId": "18a4f094-8ca3-422d-aa7c-eb6efe850e4c",
"TransactionId": "fef99bf7-b93d-4143-a358-07a1bc67c798",
"Amount": {
"Amount": "1000.41",
"Currency": "GBP"
},
"CreditDebitIndicator": "Debit",
"BookingDateTime": "2015-12-10T00:00:00Z",
"ValueDateTime": "2015-12-10T00:00:00Z",
"ProprietaryBankTransactionCode": {
"Code": "Visa Card Item",
"Issuer": "C. Hoare & Co."
},
"CardInstrument": {
"CardSchemeName": "VISA",
"Identification": "453976XXXXXX1565",
"Name": "STEVE Smith - HSE A/C"
},
"Status": "Booked"
},
{
"AccountId": "18a4f094-8ca3-422d-aa7c-eb6efe850e4c",
"TransactionId": "997d68ce-65e9-43c2-83b9-9e9a42fa52fb",
"Amount": {
"Amount": "100.41",
"Currency": "GBP"
},
"CreditDebitIndicator": "Debit",
"BookingDateTime": "2015-12-10T00:00:00Z",
"ValueDateTime": "2015-12-10T00:00:00Z",
"ProprietaryBankTransactionCode": {
"Code": "Visa Card Item",
"Issuer": "C. Hoare & Co."
},
"CardInstrument": {
"CardSchemeName": "VISA",
"Identification": "453976XXXXXX1565",
"Name": "STEVE Smith - HSE A/C"
},
"Status": "Booked"
}
]
},
"Links": {
"Self": "http://example.com/api/accounts/18a4f094-8ca3-422d-aa7c-eb6efe850e4c/transactions?pageId=1"
},
"Meta": {
"TotalPages": 1
}
}