Paths
/v1/accounts
Retrieve all accounts for a subscription. Subscription id is in the header
Encrypted access token
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
Global transaction Id.
The time stamp when the request was sent to system
Correlation ID passed by the requesting system
Subscription ID of a subscription for which all accounts need to be retrieved
2-character iso code for preferred language. If empty the default will be English
True / False
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
Found
Bad Request
Unauthorized
Forbidden
API URL Not Found
Method not Found
Not Acceptable
Too many Requests
Internal Server Error
Service Unavailable
/v1/accounts/{accountId}
Retrieve account details
account id of the user.
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
Subscription ID of a subscriber
Encrypted access token
True / False
2-character iso code for preferred language. If empty the default will be English
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
Found
Bad Request
Unauthorized
Forbidden
API URL Not Found
Method not Found
Not Acceptable
Too many Requests
Internal Server Error
Service Unavailable
/v1/accounts/{accountId}/balance
Retrieve available balance for an account
account id of the user.
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
Subscription ID of a subscriber
Encrypted access token
2-character iso code for preferred language. If empty the default will be English
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
Found
Bad Request
Unauthorized
Forbidden
API URL Not Found
Method not Found
Not Acceptable
Too many Requests
Internal Server Error
Service Unavailable
/v1/accounts/{accountId}/statement
Retrieve statement of transaction for an account
account id of the user.
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
Subscription ID of a subscriber
Encrypted access token
2-character iso code for preferred language. If empty the default will be English
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
Found
Bad Request
Unauthorized
Forbidden
API URL Not Found
Method not Found
Not Acceptable
Too many Requests
Internal Server Error
Service Unavailable
/v1/accnts/healthCheck
200 OK
Definitions
{
"type": "object",
"properties": {
"errorCode": {
"type": "string"
},
"severity": {
"type": "string"
},
"status": {
"type": "string"
},
"description": {
"type": "string"
}
}
}
{
"type": "object",
"properties": {
"line1": {
"type": "string"
},
"line2": {
"type": "string"
},
"line3": {
"type": "string"
},
"line4": {
"type": "string"
},
"city": {
"type": "string"
},
"postalcode": {
"type": "string"
},
"state": {
"type": "string"
},
"country": {
"type": "string"
}
}
}
{
"type": "object",
"properties": {
"bankId": {
"type": "string"
},
"accountId": {
"type": "string"
},
"accountAlias": {
"type": "string"
},
"accountType": {
"type": "string"
},
"accountName": {
"type": "string"
},
"IBAN": {
"type": "string"
},
"currency": {
"type": "string"
},
"infoTimeStamp": {
"type": "string"
},
"interestRate": {
"type": "number"
},
"maturityDate": {
"type": "string"
},
"lastPaymentDate": {
"type": "string"
},
"nextPaymentDate": {
"type": "string"
},
"remainingInstallments": {
"type": "number"
},
"balances": {
"type": "array",
"items": {
"$ref": "#\/definitions\/Balance"
}
}
}
}
{
"type": "object",
"properties": {
"name": {
"type": "string"
},
"address": {
"$ref": "#\/definitions\/PostalAddress"
}
}
}
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"dcInd": {
"type": "string"
},
"transactionAmount": {
"$ref": "#\/definitions\/Amount"
},
"description": {
"type": "string"
},
"postingDate": {
"type": "string"
},
"valueDate": {
"type": "string"
},
"transactionType": {
"type": "string"
},
"merchant": {
"$ref": "#\/definitions\/Merchant"
},
"terminalId": {
"type": "string"
},
"runningBalance": {
"type": "number"
},
"fromToOtherAmount": {
"type": "number"
}
}
}
{
"type": "object",
"properties": {
"account": {
"$ref": "#\/definitions\/Account"
},
"transaction": {
"type": "array",
"items": {
"$ref": "#\/definitions\/Transaction"
}
}
}
}
{
"type": "object",
"properties": {
"amount": {
"type": "number"
},
"currency": {
"type": "string"
}
}
}
{
"type": "object",
"properties": {
"code": {
"type": "string"
},
"severity": {
"type": "string",
"enum": [
"error",
"warning",
"Info"
]
},
"description": {
"type": "string"
},
"additionalDetails": {
"type": "array",
"items": {
"$ref": "#\/definitions\/AdditionalDetails"
}
}
}
}
{
"type": "object",
"properties": {
"amount": {
"type": "number"
},
"balanceType": {
"type": "string"
}
}
}
{
"type": "object",
"properties": {
"fatalError": {
"type": "boolean"
},
"error": {
"$ref": "#\/definitions\/Error"
}
}
}