Assets API provides consensual access to customer authorized products and transactions.
production
development
https://api.rapidlink.piraeusbank.gr/piraeusbank/production
Base Gateway API Endpoint
Paths
/
get /
Assets
Accounts
Get a list of customer accounts with their corresponding balances
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
Sandbox OAuth
Sandbox OAuth
(oauth2 accessCode)
Resource Owner Implicit Grant Type
Authorization URL
https://api.rapidlink.piraeusbank.gr/piraeusbank/production/v1.2/oauth/oauth2/authorize
Token URL
https://api.rapidlink.piraeusbank.gr/piraeusbank/production/v1.2/oauth/oauth2/token
Scopes
/sandboxapi
Access to all Assets resources
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
Accept
Optional in header
string
application/json
200
400
Bad Request
401
Unauthorized
404
Not Found
440
Login Time-out
501
Not Implemented
Example Request
Example Response
GET https://api.rapidlink.piraeusbank.gr/piraeusbank/production/v1.2/assets/accounts/
Try this operation
/{Iban}/info
get /{Iban}/info
Accounts
Assets
IBAN
Info
Get information about an account based on its IBAN
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
Sandbox OAuth
Sandbox OAuth
(oauth2 accessCode)
Resource Owner Implicit Grant Type
Authorization URL
https://api.rapidlink.piraeusbank.gr/piraeusbank/production/v1.2/oauth/oauth2/authorize
Token URL
https://api.rapidlink.piraeusbank.gr/piraeusbank/production/v1.2/oauth/oauth2/token
Scopes
/sandboxapi
Access to all Assets resources
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
Iban
Required in path
string
The IBAN of the account to get information about
Accept
Optional in header
string
application/json
400
Bad Request
401
Unauthorized
404
Not Found
412
Precondition Failed
440
Login Time-out
501
Not Implemented
Example Request
Example Response
GET https://api.rapidlink.piraeusbank.gr/piraeusbank/production/v1.2/assets/accounts/{Iban}/info
Try this operation
/{accountId}/details
get /{accountId}/details
Assets
Accounts
Details
Get details about a specific account based on its unique id
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
Sandbox OAuth
Sandbox OAuth
(oauth2 accessCode)
Resource Owner Implicit Grant Type
Authorization URL
https://api.rapidlink.piraeusbank.gr/piraeusbank/production/v1.2/oauth/oauth2/authorize
Token URL
https://api.rapidlink.piraeusbank.gr/piraeusbank/production/v1.2/oauth/oauth2/token
Scopes
/sandboxapi
Access to all Assets resources
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
accountId
Required in path
string
The unique id of the account for which details or transactions are retrieved
Accept
Optional in header
string
application/json
400
Bad Request
401
Unauthorized
404
Not Found
440
Login Time-out
501
Not Implemented
Example Request
Example Response
GET https://api.rapidlink.piraeusbank.gr/piraeusbank/production/v1.2/assets/accounts/{accountId}/details
Try this operation
/{accountId}/transactions/{input_filter}
get /{accountId}/transactions/{input_filter}
Get a list of transactions for a specific account based on its unique id
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
Sandbox OAuth
Sandbox OAuth
(oauth2 accessCode)
Resource Owner Implicit Grant Type
Authorization URL
https://api.rapidlink.piraeusbank.gr/piraeusbank/production/v1.2/oauth/oauth2/authorize
Token URL
https://api.rapidlink.piraeusbank.gr/piraeusbank/production/v1.2/oauth/oauth2/token
Scopes
/sandboxapi
Access to all Assets resources
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
accountId
Required in path
string
The unique id of the account for which details or transactions are retrieved
input_filter
Required in path
string
Should be JSON tringified with the format of Asset_Accounts_Transactions_Input
Accept
Optional in header
string
application/json
400
Bad Request
401
Unauthorized
404
Not Found
412
Precondition Failed
440
Login Time-out
501
Not Implemented
Example Request
Example Response
GET https://api.rapidlink.piraeusbank.gr/piraeusbank/production/v1.2/assets/accounts/{accountId}/transactions/{input_filter}
Try this operation
/transactions/{transactionReference}/{transactionCode}
get /transactions/{transactionReference}/{transactionCode}
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
Sandbox OAuth
Sandbox OAuth
(oauth2 accessCode)
Resource Owner Implicit Grant Type
Authorization URL
https://api.rapidlink.piraeusbank.gr/piraeusbank/production/v1.2/oauth/oauth2/authorize
Token URL
https://api.rapidlink.piraeusbank.gr/piraeusbank/production/v1.2/oauth/oauth2/token
Scopes
/sandboxapi
Access to all Assets resources
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
transactionReference
Required in path
string
Enter the value of the field TransactionReference as returned from the account transactions api
transactionCode
Required in path
string
Enter the value of the field TransactionCode as returned from the account transactions api
Accept
Optional in header
string
application/json
200
Example Request
Example Response
GET https://api.rapidlink.piraeusbank.gr/piraeusbank/production/v1.2/assets/accounts/transactions/{transactionReference}/{transactionCode}
Try this operation
Definitions
{
"type": "object",
"properties": {
"httpCode": {
"type": "string",
"description": ""
},
"httpMessage": {
"type": "string",
"description": ""
},
"errorCode": {
"type": "string",
"description": ""
},
"errorMessage": {
"type": "string",
"description": ""
}
},
"example": "{\n\t\"httpCode\": \"412\",\n\t\"httpMessage\": \"Precondition Failed\",\n\t\"errorCode\": \"API-987\",\n\t\"errorMessage\": \"sample error message\"\n}\n"
}
{
"type": "object",
"properties": {
"Accounts": {
"type": "array",
"items": {
"properties": {
"Type": {
"type": "string"
},
"TypeDescription": {
"type": "string"
},
"Number": {
"type": "string"
},
"Iban": {
"type": "string"
},
"Currency": {
"type": "string"
},
"Balance": {
"type": "number"
},
"AccountingBalance": {
"type": "number"
},
"OverdraftAmount": {
"type": "number"
},
"HolderName": {
"type": "string"
},
"ArrangementId": {
"type": "string"
},
"AccountId": {
"type": "string"
},
"Alias": {
"type": "string"
},
"CanDebit": {
"type": "boolean"
},
"CanViewStatement": {
"type": "boolean"
},
"Status": {
"type": "string"
}
},
"type": "object"
}
}
},
"example": "{\"Accounts\":[\n\t{\n\t\t\"Type\": \"IA\",\n\t\t\"TypeDescription\": \"ΤΑΜΙΕΥΤΗΡΙΟ -Κ-\",\n\t\t\"Number\": \"7022123123123\",\n\t\t\"Iban\": \"GR2801718220007022123123123\",\n\t\t\"Currency\": \"EUR\",\n\t\t\"Balance\": 13000983700.08,\n\t\t\"AccountingBalance\": 14996854573.28,\n\t\t\"OverdraftAmount\": 0,\n\t\t\"HolderName\": \"\",\n\t\t\"ArrangementId\": \"334083\",\n\t\t\"AccountId\": \"cwBsAHgAMABjAHoAMgByAMAioSa639FXqvNWTdbvtyo%3d\",\n\t\t\"Alias\": \"ΤΑΜΙΕΥΤΗΡΙΟ\",\n\t\t\"CanDebit\": true,\n\t\t\"CanViewStatement\": true,\n\t\t\"Status\": \"001\"\n\t}\n]}"
}
{
"type": "object",
"properties": {
"fromDate": {
"type": "string",
"description": "all records returned, will be newer than DateFrom. ISO formatted",
"example": "2017-07-01"
},
"toDate": {
"type": "string",
"description": "all records returned, will be older than DateTo. ISO formatted",
"example": "2017-09-31"
},
"fromRow": {
"type": "string",
"description": "all records returned, will have row number smaller that fromRow. it's used for pagignation",
"example": "12345"
},
"pageSize": {
"type": "number",
"description": "number of records per page to return",
"example": 10
},
"lastBalance": {
"type": "number",
"description": "all balances are calculated starting with lastBalance if it is supplied"
}
},
"example": "{\n \"fromDate\": \"2015-1-9\",\n \"toDate\": \"2015-4-9\",\n \"fromRow\": \"\",\n \"pageSize\": 20,\n \"lastBalance\": 0.0\n }",
"required": [
"fromDate",
"toDate"
]
}
{
"type": "object",
"properties": {
"AccountTransactions": {
"type": "array",
"items": {
"properties": {
"BranchCode": {
"type": "string"
},
"BranchName": {
"type": "string"
},
"TransactionReference": {
"type": "string"
},
"Comments": {
"type": "string"
},
"UniqueReference": {
"type": "string"
},
"TransactionId": {
"type": "string"
},
"TransactionCode": {
"type": "string"
},
"TransactionType": {
"type": "string"
},
"Description": {
"type": "string"
},
"PostDate": {
"type": "string"
},
"ValueDate": {
"type": "string"
},
"Amount": {
"type": "number"
},
"Currency": {
"type": "string"
},
"RunningBalance": {
"type": "number"
}
},
"type": "object"
}
},
"PagingInfo": {
"type": "object",
"properties": {
"RowIndex": {
"type": "number"
},
"MaxRows": {
"type": "number"
},
"CountRows": {
"type": "boolean"
},
"TotalRowsCount": {
"type": "number"
},
"NextPagePositioningKey": {
"type": "string"
}
}
}
},
"example": "{\n\t\"AccountTransactions\": [{\n\t\t\"BranchCode\": \"2824\",\n\t\t\"BranchName\": \"GROUP DIGIT. BANKING\",\n\t\t\"TransactionReference\": \"IB10307454902001\",\n\t\t\"Comments\": \"6108136561143\",\n\t\t\"UniqueReference\": \"11501092824IBITA10611\",\n\t\t\"TransactionId\": \"478593152\",\n\t\t\"TransactionCode\": \"013\",\n\t\t\"TransactionType\": \"D\",\n\t\t\"Description\": \"ΜΕΤΑΦΟΡΑ ΣΕ ΛΟΓΑΡΙΑΣΜΟ\",\n\t\t\"PostDate\": \"2015-01-09T00:00:00\",\n\t\t\"ValueDate\": \"2015-01-09T00:00:00\",\n\t\t\"Amount\": -3,\n\t\t\"Currency\": \"EUR\",\n\t\t\"RunningBalance\": 14996854573.28\n\t}],\n\t\"PagingInfo\": {\n\t\t\"RowIndex\": 0,\n\t\t\"MaxRows\": 100,\n\t\t\"CountRows\": false,\n\t\t\"TotalRowsCount\": 0,\n\t\t\"NextPagePositioningKey\": \"465855010\"\n\t}\n}"
}
{
"type": "object",
"properties": {
"AccountDetails": {
"type": "object",
"properties": {
"AssetNumberCleared": {
"type": "string"
},
"Iban": {
"type": "string"
},
"Currency": {
"type": "string"
},
"AccountTypeDescription": {
"type": "string"
},
"AccountingBalance": {
"type": "number"
},
"AccountingBalanceValidityDate": {
"type": "string"
},
"Balance": {
"type": "number"
},
"BalanceValidityDate": {
"type": "string"
},
"PledgedAmount": {
"type": "number"
},
"ValeurUnavailableBalance": {
"type": "number"
},
"OverdraftAmount": {
"type": "number"
},
"OverdraftEndDate": [],
"MonthlyDebitSum": {
"type": "number"
},
"MonthlyCreditSum": {
"type": "number"
},
"BranchName": {
"type": "string"
},
"Address": {
"type": "string"
},
"BranchCode": {
"type": "string"
},
"BranchAddress": [],
"AccountId": {
"type": "string"
},
"AssetAlias": {
"type": "string"
},
"CanDebit": {
"type": "boolean"
},
"CanViewStatement": {
"type": "boolean"
},
"Status": {
"type": "string"
},
"StartDate": {
"type": "string"
},
"EndDate": [],
"Characteristics": {
"type": "array",
"items": {
"properties": {
"Name": {
"type": "string"
},
"Value": {
"type": "string"
}
},
"type": "object"
}
},
"Beneficiaries": {
"type": "array",
"items": {
"properties": {
"Name": {
"type": "string"
},
"Address": [],
"Type": {
"type": "string"
}
},
"type": "object"
}
}
}
}
},
"example": "{\n\t\"AccountDetails\": {\n\t\t\"AssetNumberCleared\": \"7022123123123\",\n\t\t\"Iban\": \"GR2801718220007022123123123\",\n\t\t\"Currency\": \"EUR\",\n\t\t\"AccountTypeDescription\": \"ΤΑΜΙΕΥΤΗΡΙΟ -Κ-\",\n\t\t\"AccountingBalance\": 14996854559.36,\n\t\t\"AccountingBalanceValidityDate\": \"2017-03-16T00:00:00\",\n\t\t\"Balance\": 13000983690.76,\n\t\t\"BalanceValidityDate\": \"2017-03-16T00:00:00\",\n\t\t\"PledgedAmount\": 0.0,\n\t\t\"ValeurUnavailableBalance\": -1995870868.6,\n\t\t\"OverdraftAmount\": 0.0,\n\t\t\"OverdraftEndDate\": null,\n\t\t\"MonthlyDebitSum\": 0.0,\n\t\t\"MonthlyCreditSum\": 0.0,\n\t\t\"OverdraftAmount\": 0.0,\n\t\t\"BranchName\": \"ΚΑΤΑΣΤΗΜΑ ΠΕΡΙΣΤΕΡΙΟΥ\",\n\t\t\"Address\": \"--- HOLD MAIL ---,2960-TRANSACTIONAL BANKING SYSTE\",\n\t\t\"BranchCode\": \"2976\",\n\t\t\"BranchAddress\": null,\n\t\t\"AccountId\": \"cwBsAHgAMABjAHoAMgByAJwpSVvd%2bHu4eerBuGhcJmU%3d\",\n\t\t\"AssetAlias\": \"ΤΑΜΙΕΥΤΗΡΙΟ\",\n\t\t\"CanDebit\": false,\n\t\t\"CanViewStatement\": true,\n\t\t\"Status\": \"Ενεργό\",\n\t\t\"StartDate\": \"2000-04-27T00:00:00\",\n\t\t\"EndDate\": null,\n\t\t\"Characteristics\": [{\n\t\t\t\t\"Name\": \"Είδος\",\n\t\t\t\t\"Value\": \"ΔΙΑΖΕΥΚΤΙΚΟΣ\"\n\t\t\t}, {\n\t\t\t\t\"Name\": \"Ποσό Υπερανάληψης\",\n\t\t\t\t\"Value\": \"0,00 EUR\"\n\t\t\t}, {\n\t\t\t\t\"Name\": \"Λήξη Υπερανάληψης\",\n\t\t\t\t\"Value\": \"\"\n\t\t\t}\n\t\t],\n\t\t\"Beneficiaries\": [{\n\t\t\t\t\"Name\": \"ΓΕΩΡΓΙΟΥ,ΗΛΙΑΣ,ΑΘΑΝΑΣΙΟΥ,ΑΔ123145\",\n\t\t\t\t\"Address\": null,\n\t\t\t\t\"Type\": \"Κύριος Δικαιούχος\"\n\t\t\t}, {\n\t\t\t\t\"Name\": \"ΜΑΚΡΗ,ΣΤΕΛΛΑ,ΙΩΑΝΝΗ,Φ141677\",\n\t\t\t\t\"Address\": null,\n\t\t\t\t\"Type\": \"Συνδικαιούχος\"\n\t\t\t}\n\t\t]\n\t}\n}\n"
}
{
"type": "object",
"properties": {
"IsValid": {
"type": "boolean"
},
"Bank": {
"type": "object",
"properties": {
"Name": {
"type": "string"
},
"Bic": {
"type": "string"
},
"DomesticBankCode": {
"type": "string"
},
"Address": {
"type": "string"
},
"City": {
"type": "string"
},
"CountryIsoCode": {
"type": "string"
}
}
}
},
"example": "{\n \"IsValid\": true,\n \"Bank\": {\n \"Name\": \"sample string 1\",\n \"Bic\": \"sample string 2\",\n \"DomesticBankCode\": \"sample string 3\",\n \"Address\": \"sample string 4\",\n \"City\": \"sample string 5\",\n \"CountryIsoCode\": \"sample string 6\"\n }\n}"
}
{
"properties": {
"amount": {
"type": "number",
"description": "The amount of the transaction, as seen in Transactions List",
"format": "float",
"example": 11.5
},
"totalAmount": {
"type": "number",
"description": "A total amount for prepaid and WeBuy cards regarding their loading and unloading",
"format": "float",
"example": 13.5
},
"channel": {
"type": "string",
"description": "The channel that initiated the transaction",
"example": "Internet Banking"
},
"commission": {
"type": "number",
"description": "Transaction's commissions",
"format": "float",
"example": 1.5
},
"currency": {
"type": "string",
"description": "Currency of the transaction",
"example": "EUR"
},
"executionDate": {
"type": "string",
"description": "Execution date of the transaction",
"format": "date-time",
"example": "2023-12-31T00:00:00+03:00"
},
"expenses": {
"type": "number",
"description": "Expenses of the transaction",
"format": "float",
"example": 1.5
},
"fromAccount": {
"type": "string",
"description": "Account from which the transaction was made",
"example": "GR12 1234 1234 1234 1234 1234 123"
},
"toAccount": {
"type": "string",
"description": "Receiver of the transaction",
"example": "GR12 1234 1234 1234 1234 1234 123"
},
"mainBeneficiary": {
"type": "string",
"description": "Main beneficiary of the transaction",
"example": "John Doe"
},
"narrative": {
"type": "string",
"description": "user defilned comments",
"example": "my payment to John"
},
"originator": {
"type": "string",
"description": "Originator",
"example": "Kevin Doe"
},
"paymentType": {
"type": "string",
"description": "Payment type of the transaction"
},
"paymentTypeDescription": {
"type": "string",
"description": "Payment type description of the transaction",
"example": "Third Party Transfer"
},
"posted_date": {
"type": "string",
"description": "Date the transaction was posted",
"example": "31\/12\/2023"
},
"value_date": {
"type": "string",
"description": "Value_Date of the transaction",
"example": "31\/12\/2023 12:00:00 pm"
},
"sendingBank": {
"type": "string",
"description": "Originating bank of the transaction",
"example": "CITY BANK"
},
"status": {
"type": "integer",
"description": "Numeric code of transaction status",
"format": "int32",
"example": "4"
},
"statusDescription": {
"type": "string",
"description": "Description of the above numeric status",
"example": "Completed"
},
"transactionReference": {
"type": "string",
"description": "Transaction reference",
"example": "EB23292171322211"
},
"gbiReference": {
"type": "string",
"description": "GBI Reference"
},
"paymentOrderId": {
"type": "integer",
"description": "Payment Order Id",
"format": "int32",
"example": "8086806"
}
},
"additionalProperties": true
}