Loans API provides access to loans and financing and their corresponding transactions
production
development
https://api.rapidlink.piraeusbank.gr/piraeusbank/production
Base Gateway API Endpoint
Paths
/{loanId}/details
get /{loanId}/details
Assets
Loans
Details
Get details of a loan
Fetches the details of a loan based on the required LoanId.
To use this operation you must use one of the following sets of security requirements.
clientIdHeader
X-IBM-Client-Id
(apiKey located in header)
MSIS OAuth
MSIS OAuth
(oauth2 accessCode)
Authorization URL
https://openbank.piraeusbank.gr/identityserver/connect/authorize
Token URL
https://openbank.piraeusbank.gr/identityserver/connect/token
Scopes
winbankAccess winbankAccess.info winbankAccess.monetaryTransactions
Sandbox OAuth
Sandbox OAuth
(oauth2 accessCode)
Resource Owner Implicit Grant Type
Authorization URL
https://api.rapidlink.piraeusbank.gr/piraeusbank/production/v1.2.1/oauth/oauth2/authorize
Token URL
https://api.rapidlink.piraeusbank.gr/piraeusbank/production/v1.2.1/oauth/oauth2/token
Scopes
/sandboxapi
Access to all security resources in sandbox
clientIdHeader
X-IBM-Client-Id
(apiKey located in header)
Authorization
Required in header
string
This header should be in the form "Bearer Token", where Token is returned from the call to OAuth2
loanId
Required in path
string
Id of the loan
Accept
Optional in header
string
application/json
200
200 OK for Loans
400
Bad request
440
Session Expired
Example Request
Example Response
GET https://api.rapidlink.piraeusbank.gr/piraeusbank/production/v1.2/assets/loans/{loanId}/details
Try this operation
/
/{loanId}/transactions/{input_filter}
get /{loanId}/transactions/{input_filter}
Asset
Loans
Transactions
Get transactions of a specific loan
Fetches the transactions of a loan based on the required LoanId and optional Input Filter.
To use this operation you must use one of the following sets of security requirements.
clientIdHeader
X-IBM-Client-Id
(apiKey located in header)
MSIS OAuth
MSIS OAuth
(oauth2 accessCode)
Authorization URL
https://openbank.piraeusbank.gr/identityserver/connect/authorize
Token URL
https://openbank.piraeusbank.gr/identityserver/connect/token
Scopes
winbankAccess winbankAccess.info winbankAccess.monetaryTransactions
Sandbox OAuth
Sandbox OAuth
(oauth2 accessCode)
Resource Owner Implicit Grant Type
Authorization URL
https://api.rapidlink.piraeusbank.gr/piraeusbank/production/v1.2.1/oauth/oauth2/authorize
Token URL
https://api.rapidlink.piraeusbank.gr/piraeusbank/production/v1.2.1/oauth/oauth2/token
Scopes
/sandboxapi
Access to all security resources in sandbox
clientIdHeader
X-IBM-Client-Id
(apiKey located in header)
Authorization
Required in header
string
This header should be in the form "Bearer Token", where Token is returned from the call to OAuth2
loanId
Required in path
string
Id of the loan
input_filter
Required in path
string
Filter Loan Transactions. Json string in the format of Asset_Loans_Transactions_Input
Accept
Optional in header
string
application/json
200
400
Bad request
440
Session Expired
Example Request
Example Response
GET https://api.rapidlink.piraeusbank.gr/piraeusbank/production/v1.2/assets/loans/{loanId}/transactions/{input_filter}
Try this operation
Definitions
{
"type": "object",
"properties": {
"Loans": {
"$ref": "#\/definitions\/LoanList_Array"
}
}
}
{
"type": "object",
"properties": {
"Transactions": {
"items": {
"properties": {
"TransactionDate": {
"type": "string"
},
"TransactionCode": {
"type": "string"
},
"ValueDate": {
"type": "string"
},
"Description": {
"type": "string"
},
"Comments": {
"type": "string"
},
"UserReference": {
"type": "string"
},
"Amounts": {
"type": "object",
"properties": {
"Amount": {
"type": "string"
},
"Currency": {
"type": "string"
}
}
},
"CapitalAmount": {
"type": "object",
"properties": {
"Amount": {
"type": "string"
},
"Currency": {
"type": "string"
}
}
},
"InterestAmount": {
"type": "object",
"properties": {
"Amount": {
"type": "string"
},
"Currency": {
"type": "string"
}
}
},
"WithHoldInterestAmount": {
"type": "object",
"properties": {
"Amount": {
"type": "string"
},
"Currency": {
"type": "string"
}
}
},
"ProgressiveBalance": {
"type": "object",
"properties": {
"Amount": {
"type": "string"
},
"Currency": {
"type": "string"
}
}
},
"DeferredPaymentInterest": {
"type": "object",
"properties": {
"Amount": {
"type": "string"
},
"Currency": {
"type": "string"
}
}
},
"DealReference": {
"type": "string"
},
"Narratives": {
"type": "string"
},
"TaxType": {
"type": "string"
},
"LoanAmount": {
"type": "object",
"properties": {
"Amount": {
"type": "string"
},
"Currency": {
"type": "string"
}
}
},
"Rate": {
"type": "string"
},
"TotalInterest": {
"type": "object",
"properties": {
"Amount": {
"type": "string"
},
"Currency": {
"type": "string"
}
}
},
"TaxPaymentDate": {
"type": "string"
}
}
},
"$ref": "#\/definitions\/LoanTransactions_Array"
}
}
}
{
"properties": {
"fromDate": {
"type": "string",
"description": "Date From",
"example": "2020-12-30"
},
"toDate": {
"type": "string",
"description": "Date To",
"example": "2020-12-30"
},
"fromRow": {
"type": "string"
},
"pageSize": {
"type": "string"
}
},
"additionalProperties": false
}
{
"properties": {
"LoanId": {
"type": "string",
"description": "Unique id of the loan"
},
"AssetNumber": {
"type": "string",
"example": "5011099999999"
},
"ProductName": {
"type": "string",
"example": "DEMAND LOANS -R-"
},
"BlockActionDisabled": {
"type": "boolean"
},
"Amounts": {
"items": {
"properties": {
"Amount": {
"type": "string"
},
"Currency": {
"type": "string"
},
"AmountType": {
"type": "string"
}
}
},
"$ref": "#\/definitions\/Amount_Array"
},
"Characteristics": {
"items": {
"properties": {
"Name": {
"type": "string"
},
"Value": {
"type": "string"
}
}
},
"$ref": "#\/definitions\/Characteristics_Array"
},
"Beneficiaries": {
"items": {
"properties": {
"Name": {
"type": "string"
},
"Address": {
"type": "string"
},
"Type": {
"type": "string"
},
"DateTimeLastModified": {
"type": "string"
}
}
},
"$ref": "#\/definitions\/Beneficiaries_Array"
},
"BranchName": {
"type": "string",
"example": "STADIOU & AMERIKIS"
},
"Address": {
"type": "string"
},
"BranchCode": {
"type": "string",
"example": "2011"
},
"BranchAddress": {
"type": "string",
"example": "4, Stadiou st., 105 64 Athens Center Attiki"
},
"AssetAlias": {
"type": "string"
},
"Balance": {
"$ref": "#\/definitions\/Capital_Definition"
},
"CanDebit": {
"type": "boolean"
},
"CanViewStatement": {
"type": "boolean"
},
"Status": {
"type": "string",
"example": "Active"
},
"AssetProductTypeDescription": {
"type": "string",
"example": "DEMAND LOANS -R-"
},
"StartDate": {
"type": "string"
},
"EndDate": {
"type": "string"
},
"DateTimeLastModified": {
"type": "string"
},
"LinkedAccount": {
"type": "string"
},
"ArrangementRelation": {
"type": "string"
},
"RelationDescription": {
"type": "string"
}
},
"additionalProperties": false
}
{
"properties": {
"transactions": {
"$ref": "#\/definitions\/FinanceTransactions_Array"
},
"pagingInfo": {
"$ref": "#\/definitions\/PagingInfo_Definition"
}
}
}
{
"type": "object",
"properties": {
"loanId": {
"type": "string",
"description": "Unique id of the loan"
},
"iban": {
"type": "string",
"example": "GR4301720110005011099999999"
},
"statusDescription": {
"type": "string",
"example": "Ενεργό"
},
"productName": {
"type": "string",
"example": "Κεφάλαιο Κίνησης Τακτής Λήξης"
},
"startDate": {
"type": "string",
"format": "date-time"
},
"endDate": {
"type": "string",
"format": "date-time"
},
"capital": {
"properties": {
"amount": {
"type": "number"
}
},
"$ref": "#\/definitions\/Capital_Definition"
},
"productTypeDescription": {
"type": "string",
"example": "Κεφάλαιο Κίνησης Τακτής Λήξης"
},
"amounts": {
"$ref": "#\/definitions\/Amount_Array"
},
"isOpenLoan": {
"type": "boolean"
},
"loanType": {
"type": "integer",
"format": "int32",
"example": "1"
},
"loanRejection": {
"items": {
"type": "object"
},
"$ref": "#\/definitions\/LoanRejection_Array"
},
"relationDescription": {
"type": "string",
"example": "Debtor"
}
},
"example": "{\"loanId\":\"WkdWek5Xb3hZekIwY0cweFlYSjNkOXlDWWQ1U2IlMmI1RjR0VEVXVzdRbk93JTNkX2xvYW5fWkdWek5Xb3hZekIwY0cweFlYSjNkMDNZNyUyZlZtSHJMVlFvcE5ycHZrdHo0JTNk\",\"iban\":\"GR4301720110005011022626108\",\"statusDescription\":\"Ανενεργό\",\"productName\":\"Καθυστέρησης\/Εξυπηρέτησης Ομολογιακών Δανείων\",\"startDate\":\"2005-03-04 00:00:00.0\",\"endDate\":\"9999-12-31 00:00:00.0\",\"capital\":{\"amount\":0},\"productTypeDescription\":\"Καθυστέρησης\/Εξυπηρέτησης Ομολογιακών Δανείων\",\"amounts\":[{\"amount\":0,\"currency\":\"EUR\",\"amountType\":\"Διαθέσιμο\"},{\"amount\":0,\"currency\":\"EUR\",\"amountType\":\"Λογιστικό\"}],\"isOpenLoan\":true,\"loanType\":0,\"loanRejection\":[]}"
}
{
"type": "array",
"items": {
"$ref": "#\/definitions\/LoanList_Definition"
}
}
{
"properties": {
"amount": {
"type": "number",
"format": "double"
},
"currency": {
"type": "string"
},
"amountType": {
"type": "string"
}
},
"additionalProperties": false
}
{
"type": "array",
"items": {
"$ref": "#\/definitions\/Amount_Definition"
}
}
{
"properties": {
"message": {
"type": "string"
}
},
"additionalProperties": false
}
{
"properties": {
"errorCode": {
"type": "string",
"description": "",
"example": "API-006"
},
"errorICode": {
"type": "string",
"example": "SESSION_EXPIRED"
},
"errorMessage": {
"type": "string",
"example": "SessionExpired"
}
},
"additionalProperties": false
}
{
"properties": {
"Amount": {
"type": "number",
"format": "double"
}
},
"additionalProperties": false
}
{
"type": "array",
"items": {
"$ref": "#\/definitions\/LoanRejection_Definition"
}
}
{
"properties": {
"Code": {
"type": "string"
},
"Description": {
"type": "string"
}
},
"additionalProperties": false
}
{
"type": "array",
"items": {
"$ref": "#\/definitions\/Characteristics_Definition"
}
}
{
"properties": {
"Name": {
"type": "string",
"example": "Rate"
},
"Value": {
"type": "string",
"example": "4.13%"
}
},
"additionalProperties": false
}
{
"properties": {
"LoanId": {
"type": "string",
"description": "Unique id of the loan"
},
"AssetNumber": {
"type": "string",
"example": "5011099999999"
},
"IBAN": {
"type": "string",
"example": "GR4301720110005011099999999"
},
"StatusDescription": {
"type": "string",
"example": "Ανενεργό"
},
"LinkedAccount": {
"type": "string"
},
"ProductName": {
"type": "string",
"example": "Καθυστέρησης\/Εξυπηρέτησης Ομολογιακών Δανείων"
},
"ArrangementRelation": {
"type": "string",
"example": "D01"
},
"RelationDescription": {
"type": "string",
"example": "Beneficiary"
},
"StartDate": {
"type": "string",
"format": "date-time",
"example": "2005-03-04 00:00:00.0"
},
"EndDate": {
"type": "string",
"format": "date-time",
"example": "2015-03-04 00:00:00.0"
},
"Capital": {
"$ref": "#\/definitions\/Capital_Definition"
},
"ProductTypeDescription": {
"type": "string",
"example": "Καθυστέρησης\/Εξυπηρέτησης Ομολογιακών Δανείων"
},
"Address": {
"type": "string",
"example": "ΒΑΣΙΛΙΣΣΗΣ ΑΜΑΛΙΑΣ ΛΕΩΦ. 26Α,10557,ΑΘΗΝΑ"
},
"BranchName": {
"type": "string",
"example": "STADIOU & AMERIKIS"
},
"Beneficiaries": {
"$ref": "#\/definitions\/Beneficiaries_Array"
},
"Guarantors": {
"$ref": "#\/definitions\/Guarantors_Array"
},
"Characteristics": {
"$ref": "#\/definitions\/Characteristics_Array"
},
"Amounts": {
"$ref": "#\/definitions\/Amount_Array"
},
"IsOpenLoan": {
"type": "boolean"
},
"LoanType": {
"type": "integer",
"format": "int32",
"example": "0"
},
"LoanRejection": {
"$ref": "#\/definitions\/LoanRejection_Array"
},
"ConnectedAccount": {
"type": "string"
},
"Disclaimers": {
"type": "string"
}
},
"additionalProperties": false
}
{
"type": "array",
"items": {
"$ref": "#\/definitions\/Beneficiaries_Definition"
}
}
{
"properties": {
"Name": {
"type": "string",
"example": "ATHANASIOS ATHANASIOU"
},
"Address": {
"type": "string"
},
"Type": {
"type": "string",
"example": "Beneficiary"
},
"DateTimeLastModified": {
"type": "string",
"format": "date-time",
"example": "2017-10-19 17:17:17.0"
}
},
"additionalProperties": false
}
{
"type": "array",
"items": {
"$ref": "#\/definitions\/Guarantors_Definition"
}
}
{
"properties": {
"Name": {
"type": "string"
},
"Address": {
"type": "string"
},
"Type": {
"type": "string"
},
"DateTimeLastModified": {
"type": "string",
"format": "date-time"
}
},
"additionalProperties": false
}
{
"type": "array",
"items": {
"$ref": "#\/definitions\/LoanTransactions_Definition"
}
}
{
"properties": {
"transactionDate": {
"type": "string",
"description": "Date of transaction",
"example": "2009-10-29 00:00:00.0",
"format": "date-time"
},
"valueDate": {
"type": "string",
"format": "date-time",
"example": "2009-10-29 00:00:00.0"
},
"description": {
"type": "string",
"example": "Ολική Αποπληρωμή"
},
"amount": {
"$ref": "#\/definitions\/Amount_Definition"
},
"capitalAmount": {
"$ref": "#\/definitions\/Amount_Definition"
},
"interestAmount": {
"$ref": "#\/definitions\/Amount_Definition"
},
"withHoldInterestAmount": {
"$ref": "#\/definitions\/Amount_Definition"
},
"progressiveBalance": {
"$ref": "#\/definitions\/Amount_Definition"
},
"deferredPaymentInterest": {
"$ref": "#\/definitions\/Amount_Definition"
},
"narratives": {
"type": "string"
},
"transactionCode": {
"type": "string",
"example": "970"
},
"taxType": {
"type": "integer",
"format": "int32",
"example": "0"
},
"loanAmount": {
"$ref": "#\/definitions\/Amount_Definition"
},
"rate": {
"type": "number",
"format": "double"
},
"totalInterest": {
"$ref": "#\/definitions\/Amount_Definition"
},
"taxPaymentDate": {
"type": "string",
"format": "date-time"
}
},
"additionalProperties": false
}
{
"type": "array",
"items": {
"$ref": "#\/definitions\/FinanceTransactions_Definition"
}
}
{
"properties": {
"uniqueReference": {
"type": "string",
"example": "103"
},
"transactionId": {
"type": "string",
"example": "103"
},
"transactionCode": {
"type": "string",
"example": "ΣΥΓ101"
},
"transactionType": {
"type": "string"
},
"postDate": {
"type": "string",
"format": "date-time"
},
"valueDate": {
"type": "string",
"format": "date-time"
},
"description": {
"type": "string",
"example": "ΤΟΚOI"
},
"amount": {
"$ref": "#\/definitions\/Amount_Definition"
},
"runningBalance": {
"$ref": "#\/definitions\/Amount_Definition"
}
},
"additionalProperties": false
}
{
"properties": {
"pageSize": {
"type": "integer",
"format": "int32",
"example": "5"
},
"rowIndex": {
"type": "string",
"example": "0"
}
},
"additionalProperties": false
}