Paths
/v1/subscriptions
Create Subscription after user authentication
Global transaction Id
ID of the source system invoking
ID of the channel from which the invocation occurred
ID of the department from which the invocation occurred
User ID of the requester (as per LDAP)
Employee ID of the requester (as per employee HR record)
Terminal ID of the requester
The time stamp when the request was sent to system
Correlation ID passed by the requesting system
Third party Provide ( TPP ) ID
Third party Provide ( TPP ) Application Id
Encrypted access token
2-character iso code for preferred language. If empty the default will be English
Unique ID for TPP
The PSU's IP address if the PSU is currently logged in with the TPP
The PSU’s Session Identifier with the TPP
The PSU’s Web Browser Agent or Device Type (Whatever is available from Platform, OS Version, Model) if this is a Mobile App
The time of PSU’s last login with the TPP related to the Session Id provided above
Created
Accepted
Found
Bad Request
Unauthorized
Forbidden
API URL Not Found
Method not Found
Not Acceptable
Too many Requests
Internal Server Error
Service Unavailable
/v1/subscriptions/accounts/{accountId}
Retrieve subscriptions for customer account based on accountId in path parameter
AccountId of account
Global transaction Id
ID of the source system invoking
ID of the channel from which the invocation occurred
ID of the department from which the invocation occurred
User ID of the requester (as per LDAP)
Employee ID of the requester (as per employee HR record)
Terminal ID of the requester
The time stamp when the request was sent to system
Correlation ID passed by the requesting system
Third party Provide ( TPP ) ID
Third party Provide ( TPP ) Application Id
Encrypted access token
2-character iso code for preferred language. If empty the default will be English
Unique ID for TPP
The PSU's IP address if the PSU is currently logged in with the TPP
The PSU’s Session Identifier with the TPP
The PSU’s Web Browser Agent or Device Type (Whatever is available from Platform, OS Version, Model) if this is a Mobile App
The time of PSU’s last login with the TPP related to the Session Id provided above
Found
Bad Request
Unauthorized
Forbidden
API URL Not Found
Method not Found
Not Acceptable
Too many Requests
Internal Server Error
Service Unavailable
/v1/subscriptions/{subscriptionId}
Get subscription for TPP based on subscriptionId in header
Subscription ID of a subscriber
Global transaction Id
ID of the source system invoking
ID of the channel from which the invocation occurred
ID of the department from which the invocation occurred
User ID of the requester (as per LDAP)
Employee ID of the requester (as per employee HR record)
Terminal ID of the requester
The time stamp when the request was sent to system
Correlation ID passed by the requesting system
Third party Provide ( TPP ) ID
Third party Provide ( TPP ) Application Id
Encrypted access token
2-character iso code for preferred language. If empty the default will be English
Unique ID for TPP
The PSU's IP address if the PSU is currently logged in with the TPP
The PSU’s Session Identifier with the TPP
The PSU’s Web Browser Agent or Device Type (Whatever is available from Platform, OS Version, Model) if this is a Mobile App
The time of PSU’s last login with the TPP related to the Session Id provided above
Found
Bad Request
Unauthorized
Forbidden
API URL Not Found
Method not Found
Not Acceptable
Too many Requests
Internal Server Error
Service Unavailable
Revoke subscription based on subscriptionId
SubscriptionId for which subscription needs to be revoked
Global transaction Id
ID of the source system invoking
ID of the channel from which the invocation occurred
ID of the department from which the invocation occurred
User ID of the requester (as per LDAP)
Employee ID of the requester (as per employee HR record)
Terminal ID of the requester
The time stamp when the request was sent to system
Correlation ID passed by the requesting system
Third party Provide ( TPP ) ID
Third party Provide ( TPP ) Application Id
Encrypted access token
2-character iso code for preferred language. If empty the default will be English
Unique ID for TPP
The PSU's IP address if the PSU is currently logged in with the TPP
The PSU’s Session Identifier with the TPP
The PSU’s Web Browser Agent or Device Type (Whatever is available from Platform, OS Version, Model) if this is a Mobile App
The time of PSU’s last login with the TPP related to the Session Id provided above
OK
Accepted
Found
Bad Request
Unauthorized
Forbidden
API URL Not Found
Method not Found
Not Acceptable
Too many Requests
Internal Server Error
Service Unavailable
Update subscription details based on subscriptionId
SubscriptionId for which subscription needs to be updated
Global transaction Id
ID of the source system invoking
ID of the channel from which the invocation occurred
ID of the department from which the invocation occurred
User ID of the requester (as per LDAP)
Employee ID of the requester (as per employee HR record)
Terminal ID of the requester
The time stamp when the request was sent to system
Correlation ID passed by the requesting system
Third party Provide ( TPP ) ID
Third party Provide ( TPP ) Application Id
Encrypted access token
2-character iso code for preferred language. If empty the default will be English
Unique ID for TPP
The PSU's IP address if the PSU is currently logged in with the TPP
The PSU’s Session Identifier with the TPP
The PSU’s Web Browser Agent or Device Type (Whatever is available from Platform, OS Version, Model) if this is a Mobile App
The time of PSU’s last login with the TPP related to the Session Id provided above
Created
Accepted
Found
Bad Request
Unauthorized
Forbidden
API URL Not Found
Method not Found
Not Acceptable
Too many Requests
Internal Server Error
Service Unavailable
/v1/subscription/healthCheck
200 OK
Definitions
{
"type": "object",
"properties": {
"description": {
"type": "string"
},
"errorCode": {
"type": "string"
},
"severity": {
"type": "string"
},
"status": {
"type": "string"
}
}
}
{
"type": "object",
"required": [
"duration"
],
"properties": {
"accounts": {
"$ref": "#\/definitions\/AccountView"
},
"description": {
"type": "string"
},
"duration": {
"$ref": "#\/definitions\/Duration"
},
"payments": {
"$ref": "#\/definitions\/PaymentView"
},
"customerInformation": {
"$ref": "#\/definitions\/CustomerInformation"
},
"selectedAccounts": {
"type": "array",
"items": {
"$ref": "#\/definitions\/SelectedAccount"
}
},
"status": {
"type": "string"
},
"subscriptionId": {
"type": "string"
}
}
}
{
"type": "object",
"properties": {
"address": {
"type": "boolean"
},
"identification": {
"type": "boolean"
},
"pepinformation": {
"type": "boolean"
},
"personalInformation": {
"type": "boolean"
},
"telephone": {
"type": "boolean"
},
"reviewInformation": {
"type": "boolean"
}
}
}
{
"type": "object",
"properties": {
"accounts": {
"$ref": "#\/definitions\/AccountView"
},
"payments": {
"$ref": "#\/definitions\/PaymentView"
},
"customerInformation": {
"$ref": "#\/definitions\/CustomerInformation"
},
"selectedAccounts": {
"type": "array",
"items": {
"$ref": "#\/definitions\/SelectedAccount"
}
}
}
}
{
"type": "object",
"properties": {
"accounts": {
"$ref": "#\/definitions\/AccountView"
},
"description": {
"type": "string"
},
"payments": {
"$ref": "#\/definitions\/PaymentView"
},
"customerInformation": {
"$ref": "#\/definitions\/CustomerInformation"
},
"selectedAccounts": {
"type": "array",
"items": {
"$ref": "#\/definitions\/SelectedAccount"
}
},
"status": {
"type": "string"
},
"subscriptionId": {
"type": "string"
},
"expirationDate": {
"type": "string"
}
}
}
{
"type": "object",
"required": [
"accountId"
],
"properties": {
"accountId": {
"type": "string"
}
}
}
{
"type": "object",
"properties": {
"additionalDetails": {
"type": "array",
"items": {
"$ref": "#\/definitions\/AdditionalDetails"
}
},
"code": {
"type": "string"
},
"description": {
"type": "string"
},
"severity": {
"type": "string",
"enum": [
"error",
"warning",
"Info"
]
}
}
}
{
"type": "object",
"required": [
"endDate",
"startDate"
],
"properties": {
"endDate": {
"type": "string"
},
"startDate": {
"type": "string"
}
}
}
{
"type": "object",
"properties": {
"accounts": {
"$ref": "#\/definitions\/AccountView"
},
"customerInformation": {
"$ref": "#\/definitions\/CustomerInformation"
},
"payments": {
"$ref": "#\/definitions\/PaymentView"
},
"selectedAccounts": {
"type": "array",
"items": {
"$ref": "#\/definitions\/SelectedAccount"
}
}
}
}
{
"type": "object",
"properties": {
"error": {
"$ref": "#\/definitions\/Error"
},
"fatalError": {
"type": "boolean",
"example": false
}
}
}
{
"type": "object",
"required": [
"amount",
"currency",
"limit"
],
"properties": {
"amount": {
"type": "number"
},
"currency": {
"type": "string"
},
"limit": {
"type": "number"
}
}
}
{
"type": "object",
"required": [
"balance",
"checkFundsAvailability",
"details",
"transactionHistory"
],
"properties": {
"balance": {
"type": "boolean",
"example": false
},
"checkFundsAvailability": {
"type": "boolean",
"example": false
},
"details": {
"type": "boolean",
"example": false
},
"transactionHistory": {
"type": "boolean",
"example": false
}
}
}
{
"type": "object",
"required": [
"duration"
],
"properties": {
"accounts": {
"$ref": "#\/definitions\/AccountView"
},
"description": {
"type": "string"
},
"duration": {
"$ref": "#\/definitions\/Duration"
},
"payments": {
"$ref": "#\/definitions\/PaymentView"
},
"customerInformation": {
"$ref": "#\/definitions\/CustomerInformation"
},
"selectedAccounts": {
"type": "array",
"items": {
"$ref": "#\/definitions\/SelectedAccount"
}
},
"status": {
"type": "string"
},
"subscriptionId": {
"type": "string"
}
}
}