Subscriptions Swagger Specification
Paths
/subscriptions
Create subscription
TPP client credential authorisation flow with the ASPSP
The unique id of the ASPSP to which the request is issued. The unique id will be issued by OB.
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
{
"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)$"
}
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.
cc309236
A successful response.
Bad Request
Unauthorized
Forbidden
Too Many Requests
Internal Server Error
/subscriptions/{subscription_id}
Get Subscription based on subscription id
TPP client credential authorisation flow with the ASPSP
The unique id of the ASPSP to which the request is issued. The unique id will be issued by OB.
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
{
"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)$"
}
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.
cc309236
A successful response.
Bad Request
Unauthorized
Forbidden
Too Many Requests
Internal Server Error
delete subscription
TPP client credential authorisation flow with the ASPSP
The unique id of the ASPSP to which the request is issued. The unique id will be issued by OB.
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
{
"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)$"
}
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.
cc309236
A successful response.
Bad Request
Unauthorized
Forbidden
Too Many Requests
Internal Server Error
update subscription
TPP client credential authorisation flow with the ASPSP
The unique id of the ASPSP to which the request is issued. The unique id will be issued by OB.
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
{
"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)$"
}
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.
cc309236
A successful response.
Bad Request
Unauthorized
Forbidden
Too Many Requests
Internal Server Error
Definitions
{
"type": "object",
"properties": {
"Data": {
"$ref": "#/definitions/subscriptionsData"
}
}
}
{
"type": "object",
"properties": {
"SubscriptionId": {
"type": "string"
},
"Status": {
"type": "string"
},
"CreationDateTime": {
"type": "string",
"format": "date-time"
},
"Permissions": {
"type": "array",
"items": {
"$ref": "#/definitions/subscriptionsPermissions"
}
},
"ExpirationDateTime": {
"type": "string",
"format": "date-time"
}
}
}
{
"type": "string",
"enum": [
"ACCESS_FINANCIAL_INFO",
"VERIFY_IDENTIFICATION",
"ACCESS_CUSTOMER_INFO",
"APPLY_FOR_LOAN",
"APPLY_FOR_PERSONAL_FUNERAL_INSURANCE"
]
}
{
"type": "object",
"properties": {
"Data": {
"$ref": "#/definitions/subscriptionsData"
}
}
}
{
"type": "object",
"properties": {
"Data": {
"$ref": "#/definitions/subscriptionsData"
}
}
}