Get Scheduled Payments
Changed onEnables an AISP to retrieve Scheduled Payment information for account(s) that the PSU has consented to.
Request
- Base URL/open-banking/v4.0/aisp (relative, and the document was published on a file host, not at the API’s origin)
- AuthOAuth 2Authorization codehttps://authserver.example/authorizationToken URLhttps://authserver.example/tokenScopesaccounts
Headers
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
The PSU's IP address if the PSU is currently logged in with the TPP.
An RFC4122 UID used as a correlation id.
An Authorisation Token as per https://tools.ietf.org/html/rfc6750
Indicates the user-agent that the PSU is using.
Only used if an ASPSP requires the client ID in order to return rate limit headers.
TPPs must refer to ASPSP developer portals for further information on any rate limit policies, if the headers are supported and any additional requirements.
This header must not be used for client authentication
Response
Scheduled Payments Read
Example response
{
"Data": {
"ScheduledPayment": [
{
"AccountId": "22289",
"ScheduledPaymentId": "SP03",
"ScheduledPaymentDateTime": "2017-07-12T00:00:00+00:00",
"ScheduledType": "Arrival",
"Reference": "Towbar Club",
"DebtorReference": "REF51561806",
"InstructedAmount": {
"Amount": "1209.06",
"Currency": "GBP"
},
"CreditorAgent": {
"SchemeName": "UK.OBIE.BICFI",
"Identification": "80200112344562",
"Name": "Agent Name",
"PostalAddress": {
"AddressType": "BIZZ",
"Department": "Finance",
"SubDepartment": "Payroll",
"StreetName": "Bank Street",
"BuildingNumber": "11",
"Floor": "11",
"UnitNumber": "A88",
"Room": "Basement 03",
"PostBox": "PO Box 123456",
"TownLocationName": "London",
"DistrictName": "Greater London",
"CareOf": "Jane Smith",
"PostCode": "EC2N 4AG",
"TownName": "London"
},
"LEI": "IZ9Q00LZEVUKWCQY6X15"
},
"CreditorAccount": {
"Name": "Jane Smith",
"SecondaryIdentification": "87562298675897",
"Proxy": {
"Identification": "2360549017905188",
"Code": "TELE"
}
}
}
]
}
}Changes
- info
added the new optional
headerrequest parameterx-client-id
- info
- info
the
////response's property pattern was changed from^[0-9]{4}[0]{2}[A-Z0-9]{12}[0-9]{2}to^[A-Z0-9]{18,18}[0-9]{2,2}$for the status (media type: application/json; charset=utf-8) - info
the
////response's property pattern was changed from^[0-9]{4}[0]{2}[A-Z0-9]{12}[0-9]{2}to^[A-Z0-9]{18,18}[0-9]{2,2}$for the status (media type: application/json) - info
the
////response's property pattern was changed from^[0-9]{4}[0]{2}[A-Z0-9]{12}[0-9]{2}to^[A-Z0-9]{18,18}[0-9]{2,2}$for the status (media type: application/jose+jwe)
- info